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

Valid email address. Surrounding whitespace is removed and letter casing is preserved.

phone_number
string | null

Valid international or national phone number. National values use the company's configured country and are stored in E.164 format.

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

The Rejected form's built-in reason. Shown to the partner in the portal and the rejection email when the lead is rejected, unless the company hides it. Cleared when the lead leaves Rejected.

accepted_reason
string | null
required

The Accepted form's built-in reason. Shown to the partner in the portal and the Lead accepted notification when the lead is accepted (status converted), unless the company hides it. Cleared when the lead leaves Accepted.

direction
string | null
required
partner
object | null
required
created_by
object | null
required
tags
object[]
required
assigned_users
object[]
required
custom_fields
object[]
required

Values of the lead's custom fields (category lead).

status_form_fields
object[]
required

Answers to the form of the lead's current status: lead_acceptance fields while it is converted (Accepted), lead_rejection fields while it is rejected, empty otherwise. Includes internal (non-shared) fields. Write them with custom_fields on the lead update or the lead custom-field endpoints.

created_at
string
required
updated_at
string
required