Обновить рассылку

PATCH /campaigns/{id}

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

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

Authorization: Bearer YOUR_API_KEY

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

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

UUID рассылки, которую вы хотите обновить.

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

Тело запроса

application/json

name string

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

Пример: Warmup January Campaign

prioritize_new_leads boolean

Если включено — система в первую очередь отдает приоритет отправке новым лидам.

Пример: true

open_tracking boolean

Включите или отключите отслеживание открытия email.

Пример: true

stop_on_reply boolean

Если true — рассылка автоматически останавливается, когда кто-либо из лидов отвечает.

Пример: false

schedule any

Встроенный объект обновления расписания.

account_ids number[]

Массив идентификаторов учетных записей (отправителей email), которые должна использовать рассылка.

Пример: [10, 14, 22]

Ответ

application/json

Рассылка успешно обновлена

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

Статус действия

Пример: success

Запрос

curl --request PATCH \
  --url https://developer.coldy.ai/api/v1/campaigns/{id} \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Warmup January Campaign",
  "prioritize_new_leads": true,
  "open_tracking": true,
  "stop_on_reply": false,
  "schedule": "string",
  "account_ids": [
    10,
    14,
    22
  ]
}'

{
  "result": "success"
}

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