Skip to main content
POST
Call Now

Authorizations

X-API-KEY
string
header
required

Your API key for authentication.

x-org-id
string
header
required

Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.

Body

application/json
phone_number
string<phone>
required

Phone number in E.164 format

Example:

"+123456xxxx"

first_name
string
required

First name of the lead

Example:

"John"

last_name
string
required

Last name of the lead

Example:

"Doe"

lead_list_id
string
required

ID of the lead list to which this lead belongs

Example:

"60c72b2f9b1e8d001c8e115b"

email
string | null

Email address of the lead

conversation_medium
enum<string> | null
Available options:
web_voice,
telephony,
sms,
email,
chatbot,
api_text,
chat_app,
softphone
extra_data
Extra Data · object | null

Custom fields for the lead, can be used to store additional information

Example:
recall_threshold_in_seconds
integer | null
timezone
string | null
default:US/Mountain

Lead's timezone, must be a valid IANA time zone identifier.

Example:

"US/Mountain"

Response

Successful Response

phone
string
required
_id
string | null
account_id
string | null
first_name
string | null
last_name
string | null
email
string | null
phone_extension
string | null
call_now
boolean | null
list_ids
string[] | null
timezone
string | null
default:US/Mountain
extracted_data
Extracted Data · object | null
custom_fields
Custom Fields · object | null
preferred_agent_id
string | null
enabled
boolean | null
default:true
created_at
string<date-time> | null
created_by
string | null
campaign_info
CampaignInfo · object[] | null
conversation_seeder_override
Message · object[] | null