Массово создать лидов

POST /leads/bulk

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

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

Authorization: Bearer YOUR_API_KEY

Тело запроса

application/json

Массовые данные о потенциальных клиентах

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

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

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

items object[] обязательное

Элементы данных о потенциальных клиентах

Показать вложенные поля Скрыть вложенные поля

items.email string обязательное

Адрес email лида

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

items.first_name string

Имя ведущего

Пример: John

items.last_name string

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

Пример: Doe

items.company string

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

Пример: Coldy

items.website string

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

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

items.personalization string

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

Пример: Hi John, I saw you work at Coldy.ai and thought this might be useful...

items.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

Результат массового создания лидов

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

Количество созданных лидов

Пример: 2

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

Количество пропущенных лидов

Пример: 1

leads object[] обязательное

Созданные лиды

Показать вложенные поля Скрыть вложенные поля

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

ID лида

Пример: 1

leads.email string обязательное

Адрес email лида

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

leads.first_name string обязательное

Имя ведущего

Пример: John

leads.last_name string обязательное

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

Пример: Doe

leads.company string обязательное

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

Пример: OpenAI

leads.website string обязательное

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

Пример: https://openai.com

leads.personalization string обязательное

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

Пример: Hi John, I saw you work at OpenAI…

leads.sender string обязательное

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

Пример: outbound@coldy.ai

leads.verification_status string обязательное

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

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

Пример: valid

leads.status string обязательное

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

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

Пример: Not contacted

leads.campaign_id string обязательное

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

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

leads.id_previous_sending_sequence number обязательное

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

Пример: 0

leads.amount_sequences_sent number обязательное

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

Пример: 2

leads.date_last_sequence_send string обязательное

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

Пример: 2025-10-01T12:34:56.000Z

leads.reply_text string обязательное

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

Пример: Sure, let’s talk next week.

leads.reply_status string обязательное

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

Пример: positive

leads.reply_status_tag_id number обязательное

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

Пример: 12

leads.stop_sending boolean обязательное

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

Пример: false

leads.stop_sending_type string обязательное

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

Пример: manual

leads.chosen_sender number обязательное

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

Пример: 101

leads.provider string обязательное

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

Пример: gmail

skipped_items object[] обязательное

Пропущенные лиды и причины

Показать вложенные поля Скрыть вложенные поля

skipped_items.index number обязательное

Отсчитываемый от нуля индекс пропущенного элемента в элементах запроса

Пример: 1

skipped_items.email string обязательное

Адрес email пропущенного лида

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

skipped_items.reason string обязательное

Причина, по которой лид был пропущен

Допустимые значения: blacklist, workspace_duplicate, campaign_duplicate

Пример: campaign_duplicate

Запрос

curl --request POST \
  --url https://developer.coldy.ai/api/v1/leads/bulk \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "campaign": "550e8400-e29b-41d4-a716-446655440000",
  "items": [
    {
      "email": "john.doe@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "company": "OpenAI",
      "custom_variables": {
        "position": "CTO"
      }
    },
    {
      "email": "jane.smith@example.com",
      "first_name": "Jane",
      "personalization": "Hi Jane..."
    }
  ],
  "skip_if_in_campaign": true,
  "skip_if_in_workspace": true,
  "skip_if_in_blacklist": true
}'

{
  "created": 1,
  "skipped": 1,
  "leads": [
    {
      "id": 1,
      "email": "john.doe@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "company": "OpenAI",
      "website": "",
      "personalization": "",
      "sender": null,
      "verification_status": "not_verified",
      "status": "Not contacted",
      "campaign_id": "550e8400-e29b-41d4-a716-446655440000",
      "id_previous_sending_sequence": 0,
      "amount_sequences_sent": 0,
      "date_last_sequence_send": "2026-05-23T00:00:00.000Z",
      "reply_text": null,
      "reply_status": null,
      "stop_sending": false,
      "stop_sending_type": null,
      "chosen_sender": 101,
      "provider": "none"
    }
  ],
  "skipped_items": [
    {
      "index": 1,
      "email": "jane.smith@example.com",
      "reason": "campaign_duplicate"
    }
  ]
}

{
  "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"
}