Деактивировать рассылку

Описание

Деактивировать рассылку.

Также можно прервать отправку сообщений работающей рассылки.

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	Да	Идентификатор рассылки

Пример запроса

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "id": "78",
    "abort_if_running": "true"
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <id>78</id>
    <abort_if_running>true</abort_if_running>
</xml>

Пример ответа

JSON

{
    "data": null,
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data/>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки