Создать рассылку

POST /campaigns

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

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

Authorization: Bearer YOUR_API_KEY

Тело запроса

application/json

Данные рассылки

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

Название рассылки

Пример: Black Friday Campaign

Ответ

application/json

Рассылка успешно создана

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

ID рассылки

Пример: 8f3c2c91-4f8d-4e65-8c9f-4e9b12345678

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

Индекс

Пример: 1

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

Название рассылки

Пример: Black Friday Campaign

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

Приоритет отправки

Пример: sequence_emails

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

ID пользователя, которому принадлежит рассылка

Пример: 42

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

Количество писем с ответами

Пример: 3

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

Количество открытых писем

Пример: 15

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

ID предыдущего лида

Пример: 1001

wait_schedule boolean обязательное

Активен ли график ожидания

Пример: false

is_message_plain_text boolean обязательное

Используйте обычные текстовые сообщения

Пример: false

is_open_tracking_disabled boolean обязательное

Открытое отслеживание отключено

Пример: false

is_stop_sending_on_reply boolean обязательное

Прекратить отправку ответа

Пример: true

is_stop_sending_on_company_reply boolean обязательное

Прекратить отправку ответа компании

Пример: false

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

Статус рассылки

Пример: Draft

Запрос

curl --request POST \
  --url https://developer.coldy.ai/api/v1/campaigns \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Black Friday Campaign"
}'

{
  "id": "8f3c2c91-4f8d-4e65-8c9f-4e9b12345678",
  "index": 1,
  "name": "Black Friday Campaign",
  "sending_priority": "sequence_emails",
  "user_id": 42,
  "replies_emails": 3,
  "opened_emails": 15,
  "id_previous_getting_lead": 1001,
  "wait_schedule": false,
  "is_message_plain_text": false,
  "is_open_tracking_disabled": false,
  "is_stop_sending_on_reply": true,
  "is_stop_sending_on_company_reply": false,
  "status": "Draft"
}

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