Skip to main content
POST
cURL

Authorizations

x-phishy-api-key
string
header
required

Body

application/json

Target to add

first_name
string
required

First name of the user

last_name
string
required

Last name of the user

email
string<email>
required

Email address of the user

position
string
required

Position or role of the user within the organization

age
integer<int32>

Age of the user

gender
enum<string>

Gender of the user

Available options:
Male,
Female,
Other
phone_number
string

Phone number of the user

groups
string[]

List of group IDs the user belongs to

Response

Target created successfully

name
string
required

First name of the target

surname
string
required

Surname of the target

email
string<email>
required

Email address of the target

position
string
required

Position or role of the target within the organization

phone
string
required

Phone number of the target

group
string | null

Group the target belongs to

gender
enum<string> | null

Gender of the target

Available options:
male,
female,
other
age
integer<int32> | null

Age of the target