Skip to main content
PUT
Update Lead

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.

Path Parameters

lead_id
string
required
Required string length: 24

Body

application/json

A set of optional updates to be made.

first_name
string | null

Used for conversation personalization.

Example:

"Jane"

last_name
string | null

Used for conversation personalization.

Example:

"Smith"

email
string | null

Used for communication with lead

phone
string<phone> | null

Used for communication with lead

Example:

"+18015551831"

phone_extension
string | null
timezone
string | null
list_ids
string[] | null
extracted_data
Extracted Data · object | null
custom_fields
Custom Fields · object | null
preferred_agent_id
string | null

Agent id preferred for this lead. Selected over the campaign's distribution strategy when the agent is in the campaign's pool. Send null to clear.

conversation_seeder_override
Message · object[] | null

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