PATCH /leads/{id}

Аутентификация

Передавайте API-ключ организации как Bearer-токен.

Authorization: Bearer YOUR_API_KEY

Параметры пути

id number обязательное

ID лида, которого нужно обновить

Пример: 123

Тело запроса

application/json

Поля для обновления в лиде

email string

Адрес email лида

Пример: john.doe@example.com
first_name string

Имя ведущего

Пример: John
last_name string

Фамилия ведущего

Пример: Doe
company string

Название компании ведущего

Пример: Coldy
website string

Сайт ведущего

Пример: https://coldy.ai
personalization string

Текст персонализации для лида

Пример: Hi John, I saw you work at Coldy.ai…
custom_fields object

Пользовательские переменные: ключ — это имя переменной в нижнем регистре, значение — это ее значение.

Пример: {"position":"CTO","linkedin":"https://linkedin.com/in/john"}
stop_sending boolean

Если это правда, прекратите отправку этому лиду (stop_sending_type установлен на "manual"). Если значение ложно, возобновите отправку (stop_sending_type имеет значение null).

Пример: false

Ответ

application/json

Лид успешно обновлён

id number обязательное

ID лида

Пример: 1
email string обязательное

Адрес email лида

Пример: john.doe@example.com
first_name string обязательное

Имя ведущего

Пример: John
last_name string обязательное

Фамилия ведущего

Пример: Doe
company string обязательное

Компания ведущего

Пример: OpenAI
website string обязательное

Сайт ведущего

Пример: https://openai.com
personalization string обязательное

Текст персонализации

Пример: Hi John, I saw you work at OpenAI…
sender string обязательное

Учетная запись email, с которой было отправлено письмо

Пример: outbound@coldy.ai
verification_status string обязательное

Статус проверки email

Допустимые значения: valid, unknown, accept_all, invalid, disposable, not_verified

Пример: valid
status string обязательное

Текущий статус лида

Допустимые значения: Not contacted, Sent, Bounce, Replied, Opened

Пример: Not contacted
campaign_id string обязательное

ID связанной рассылки

Пример: 550e8400-e29b-41d4-a716-446655440000
id_previous_sending_sequence number обязательное

ID предыдущей цепочки писем отправки

Пример: 0
amount_sequences_sent number обязательное

Количество уже отправленных цепочек писем

Пример: 2
date_last_sequence_send string обязательное

Дата последней отправленной цепочки писем

Пример: 2025-10-01T12:34:56.000Z
reply_text string обязательное

Текст ответа, если лид ответил

Пример: Sure, let’s talk next week.
reply_status string обязательное

Статус ответа

Пример: positive
reply_status_tag_id number обязательное

ID прикрепленного тега ответа

Пример: 12
stop_sending boolean обязательное

Остановлена ли отправка для этого лида

Пример: false
stop_sending_type string обязательное

Тип примененного правила остановки отправки

Пример: manual
chosen_sender number обязательное

Выбранный аккаунт отправителя ID

Пример: 101
provider string обязательное

Поставщик, используемый для отправки

Пример: gmail