Skip to main content
POST
Create a lead

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json
first_name
string | null
required
source
string
default:api
required
partnership_uuid
string
required
last_name
string | null
email
string | null
phone_number
string | null
company_name
string | null
direction
enum<string> | null
Available options:
received,
sent
tag_uuids
string[]
assigned_user_uuids
string[]
custom_fields
object[]

Response

201 - application/json

Default Response

uuid
string
required
first_name
string | null
required
last_name
string | null
required
email
string | null
required
phone_number
string | null
required
company_name
string | null
required
source
string
required
status
enum<string>
required
Available options:
new,
converted,
rejected
rejected_reason
string | null
required
direction
string | null
required
partner
object | null
required
created_by
object | null
required
tags
object[]
required
assigned_users
object[]
required
custom_fields
object[]
required
created_at
string
required
updated_at
string
required