Деактивировать кампанию
Описание
Деактивировать кампанию.
Также можно прервать отправку сообщений работающей кампании.
abort_if_running = true
прерывает отправку сообщений, если кампания работает. Значение false
только деактивирует, позволяя дослать последние оставшиеся сообщения.
URL-адрес
Метод: POST
https://example.com/api/v1.1/campaigns/deactivate
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
abort_if_running | bool | true | Нет | Прервать, если кампания запущена. По умолчанию – false. |
id | int | 12 | Да | Идентификатор кампании |
Пример запроса
{
"abort_if_running": true,
"id": 4758,
"token": "abcdefghijklmnqrstuvwxyz"
}
Пример ответа
{
"data": null,
"error": 0,
"error_text": "Successful operation"
}
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |