Skip to main content
POST
Create Person

Authorizations

Authorization
string
header
required

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

Headers

X-API-Key
string | null

Body

application/json
workspace_id
string<uuid>
required
name
string | null
Maximum string length: 255
email
string | null
phone
string | null
Maximum string length: 50
job_title
string | null
Maximum string length: 255
department
string | null
Maximum string length: 255
seniority_label
string | null
Maximum string length: 255
seniority_level
integer | null
Required range: 1 <= x <= 6
person_type
enum<string> | null
Available options:
internal,
external
group_ids
string<uuid>[]

Response

Successful Response

id
string<uuid>
required
workspace_id
string<uuid>
required
name
string
required
person_type
string
required
source
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
user_id
string | null
source_connection_id
string<uuid> | null
external_id
string | null
email
string | null
phone
string | null
job_title
string | null
department
string | null
seniority_level
integer | null
seniority_label
string | null
source_attributes_json
Source Attributes Json · object | null
image_url
string | null
group_ids
string<uuid>[]
group_names
string[]
campaign_count
integer
default:0
completed_count
integer
default:0
last_participated_at
string<date-time> | null
channels
string[]
teams_display_identifier
string | null