PATCH /leads/{id}

Authentication

Send your organization API key as a Bearer credential.

Authorization: Bearer YOUR_API_KEY

Path parameters

id number required

ID of the lead to update

Example: 123

Body

application/json

Fields to update on the lead

email string

Email address of the lead

Example: john.doe@example.com
first_name string

First name of the lead

Example: John
last_name string

Last name of the lead

Example: Doe
company string

Company name of the lead

Example: Coldy
website string

Website of the lead

Example: https://coldy.ai
personalization string

Personalization text for the lead

Example: Hi John, I saw you work at Coldy.ai…
custom_fields object

Custom variables: key is variable name in lower case, value is its value

Example: {"position":"CTO","linkedin":"https://linkedin.com/in/john"}
stop_sending boolean

If true, stop sending to this lead (stop_sending_type set to "manual"). If false, resume sending (stop_sending_type set to null).

Example: false

Response

application/json

Lead updated successfully

id number required

ID of the lead

Example: 1
email string required

Email address of the lead

Example: john.doe@example.com
first_name string required

First name of the lead

Example: John
last_name string required

Last name of the lead

Example: Doe
company string required

Company of the lead

Example: OpenAI
website string required

Website of the lead

Example: https://openai.com
personalization string required

Personalization text

Example: Hi John, I saw you work at OpenAI…
sender string required

The email account from which the email was sent

Example: outbound@coldy.ai
verification_status string required

Verification status of the email

Allowed values: valid, unknown, accept_all, invalid, disposable, not_verified

Example: valid
status string required

Current status of the lead

Allowed values: Not contacted, Sent, Bounce, Replied, Opened

Example: Not contacted
campaign_id string required

ID of the associated campaign

Example: 550e8400-e29b-41d4-a716-446655440000
id_previous_sending_sequence number required

ID of previous sending sequence

Example: 0
amount_sequences_sent number required

Number of sequences already sent

Example: 2
date_last_sequence_send string required

Date of the last sequence sent

Example: 2025-10-01T12:34:56.000Z
reply_text string required

Reply text if lead responded

Example: Sure, let’s talk next week.
reply_status string required

Reply status

Example: positive
reply_status_tag_id number required

ID of the attached reply tag

Example: 12
stop_sending boolean required

Whether sending is stopped for this lead

Example: false
stop_sending_type string required

Type of stop sending rule applied

Example: manual
chosen_sender number required

Chosen sender account ID

Example: 101
provider string required

Provider used for sending

Example: gmail