Skip to main content
POST
Add target

Authorizations

Admin cookie authentication (configurable in config.json)

Body

application/json
address
string
required

Target email address

campaign
string
required

Campaign to add target to

first_name
string

First name

last_name
string

Last name

position
string

Job title

custom
string

Custom field (phone, etc.)

Response

Target created successfully

target_id
string

Unique target identifier

address
string

Target email address

campaign
string

Associated campaign name

first_name
string

Target first name

last_name
string

Target last name

position
string

Target job title/position

custom
string

Custom field (phone number, etc.)

phished
integer

Email sent status (0 = not sent, 1 = sent)