Skip to content
Arsen API Documentation

Create campaign

POST
/v1/campaigns

Create a new phishing campaign.

Request Body required

object
name
required
string
jitTraining

Compromised employees will be redirected to a learning page.

boolean
default: true
compromisedOn
required
  • credentials: employees are compromised when they submit their credentials in a phishing form.
  • click: employees are compromised when they click the phishing link.
string
Allowed values: credentials click
employeeIds
required

The employees who will be targeted by the phishing emails. Employees must be active.

Array<string>
scenarioIds
required

The scenarios employees will encounter during the phishing campaign.

Array<string>
runAt
required

The scheduled start date and time of the campaign. Must be in the future.

string format: date-time

Responses

200

object
status
required
string
Allowed values: success
data
required
object
campaign
required
object
id
required
string

400

Bad request

object
error
string
statusCode
required
number

401

Unauthorized

object
message
required
string
statusCode
required
number

404

Not found

object
message
required
string
statusCode
required
number

408

Request timeout

object
message
required
string
statusCode
required
number

429

Too many requests

object
message
required
string
statusCode
required
number

500

Internal server error

object
message
required
string
statusCode
required
number