Skip to main content
PUT
Update a lead

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Path Parameters

campaign_id
string<uuid>
required
lead_id
string<uuid>
required

Body

application/json

Request body for updating a lead's mutable fields.

first_name
string | null

First name

last_name
string | null

Last name

company
string | null

Company name

custom_fields
Custom Fields · object | null

Custom field updates. Keys set to null are removed; other keys are merged.

Response

Lead updated successfully

Response schema for individual lead.

lead_id
string<uuid>
required

Lead ID

batch_id
string<uuid> | null
required

Batch ID this lead belongs to

email
string
required

Lead email address

first_name
string | null
required

First name

last_name
string | null
required

Last name

company
string | null
required

Company name

status
string
required

Lead status

last_contacted_at
string<date-time> | null
required

Last contact timestamp

opened_at
string<date-time> | null
required

Email opened timestamp

replied_at
string<date-time> | null
required

Reply timestamp

created_at
string<date-time>
required

Lead creation timestamp

custom_fields
Custom Fields · object

Custom lead fields

sequence_step
integer
default:0

Current sequence step

next_followup_scheduled_for
string<date-time> | null

When the next pending follow-up is scheduled

email_opened
boolean
default:false

Whether email was opened

email_replied
boolean
default:false

Whether lead replied

unsubscribed
boolean
default:false

Whether lead unsubscribed

delivery_status
string | null

Delivery status from Azure (latest email)

current_intent_tag
LeadIntentTagInfo · object | null

Latest INTENT-group thread tag across the lead's threads (rollup)