Update a lead - ColdSend API

curl --request PUT \ --url https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id}/leads/{lead_id} \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --data ' { "first_name": "<string>", "last_name": "<string>", "company": "<string>", "custom_fields": {} } '

{ "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "email": "<string>", "first_name": "<string>", "last_name": "<string>", "company": "<string>", "status": "<string>", "last_contacted_at": "2023-11-07T05:31:56Z", "opened_at": "2023-11-07T05:31:56Z", "replied_at": "2023-11-07T05:31:56Z", "created_at": "2023-11-07T05:31:56Z", "custom_fields": {}, "sequence_step": 0, "email_opened": false, "email_replied": false, "unsubscribed": false, "delivery_status": "<string>", "current_intent_tag": { "tag_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "tag_name": "<string>", "tag_color": "<string>", "is_ai_applied": true, "confidence": 123 } }

Example

import requests campaign_id = "550e8400-e29b-41d4-a716-446655440000" lead_id = "650e8400-e29b-41d4-a716-446655440000" response = requests.put( f"https://api.coldsend.io/api/public/v1/campaigns/{campaign_id}/leads/{lead_id}", headers={"X-API-Key": "your-api-key"}, json={ "first_name": "Jane", "custom_fields": {"industry": "SaaS", "old_field": None} # removes old_field } ) print(response.json())

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

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

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

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

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

Show child attributes