Создать лида

POST /leads

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

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

Authorization: Bearer YOUR_API_KEY

Тело запроса

application/json

Данные лида

campaign string обязательное

UUID рассылки, к которой будет привязан лид

Пример: 550e8400-e29b-41d4-a716-446655440000

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 and thought this might be useful...

custom_variables object

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

Пример: {"position":"CTO","linkedin":"https://linkedin.com/in/coldy.ai"}

skip_if_in_campaign object

Пропускать ли лида, если он уже присутствует в рассылке (по умолчанию: true)

Пример: true

skip_if_in_workspace object

Пропускать ли лид, если лид уже находится в рабочей области (по умолчанию: true)

Пример: true

skip_if_in_blacklist object

Пропускать ли запрос, если лид находится в черном списке (по умолчанию: true)

Пример: true

Ответ

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

Запрос

curl --request POST \
  --url https://developer.coldy.ai/api/v1/leads \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "campaign": "550e8400-e29b-41d4-a716-446655440000",
  "email": "john.doe@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "company": "OpenAI",
  "website": "https://openai.com",
  "personalization": "Hi John, I saw you work at OpenAI…",
  "custom_variables": {
    "position": "CTO"
  },
  "skip_if_in_campaign": true,
  "skip_if_in_workspace": true,
  "skip_if_in_blacklist": true
}'

{
  "id": 1,
  "email": "john.doe@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "company": "Coldy",
  "website": "https://coldy.ai",
  "personalization": "Hi John, I saw you work at Coldy.ai",
  "sender": "outbound@coldy.ai",
  "verification_status": "valid",
  "status": "Not contacted",
  "campaign_id": "550e8400-e29b-41d4-a716-446655440000",
  "id_previous_sending_sequence": 0,
  "amount_sequences_sent": 2,
  "date_last_sequence_send": "2025-10-01T12:34:56.000Z",
  "reply_text": null,
  "reply_status": null,
  "stop_sending": false,
  "stop_sending_type": null,
  "chosen_sender": 101,
  "provider": "gmail"
}

{
  "message": [
    "You put invalid API key. Verify your key with the key from your account in Coldy. Check documenation for info"
  ],
  "statusCode": 400,
  "error": "Invalid API key"
}