Завершение кампании
Описание
Завершить кампанию прямо сейчас. Завершение прерывает отправку сообщений работающих рассылок и переводит все вложенные рассылки и сценарии в статус "неактивна".
Права доступа
Для использования этого метода API-токен должен иметь права:
- Кампании - Запуск
- Доступ к группам, в которых находятся кампании
Настройте права в разделе Настройки → Токены.
URL-адрес
Метод: POST
https://example.com/api/v1.1/scampaigns/completed
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API-токен |
| id | int | 18 | Да | Идентификатор кампании |
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"id": 18
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<id>18</id>
</xml>
Пример ответа
- JSON
- XML
{
"data": null,
"error": 0,
"error_text": "Successful operation"
}
<xml>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |
| data | null | Данные не возвращаются |
warning
Завершение кампании - необратимая операция. После завершения возобновить кампанию невозможно, только создать новую.