Skip to main content
POST
/
campaigns
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "name": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.phishy.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Details of the new campaign to be created

​
name
string

Name of the campaign

​
description
string

Description of the campaign

Response

Campaign created successfully

​
id
string
required

Unique identifier for the campaign

​
name
string
required

Name of the campaign

​
status
enum<string>
required

Current status of the campaign

Available options:
scheduled,
launched,
paused,
completed