Активировать кампанию
Описание
Активировать кампанию.
Также используется для того, чтобы мгновенно отправить броадкаст или регулярную кампанию. Для этой отправки можно указать другой источник подписчиков.
Если поле run_now = true, то кампания должна запускаться немедленно.
Поля override_source_type и override_source_id используются, только когда run_now = true.
Если переданы параметры override_source_type и override_source_id, то кампания выполняются по переданному источнику подписчиков.
Если их нет, то кампания выполняется по своему источнику.
URL-адрес
Метод: POST
https://example.com/api/v1.1/campaigns/activate/
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| id | int | 12 | Да | Идентификатор кампании |
| run_now | bool | true | Нет | Запустить кампанию |
| override_source_type | enum | "list" или "segment" | Нет | Перезаписать источник данных |
| override_source_id | int | 5 | Нет | Перезаписать идентификатор данных |
| override_limit | int | 56 | Нет | Перезаписать лимит на старт кампании |
| content | JSON object | { "field": "value" } | Нет | Контент для переменных apicontent в сообщениях. |
| attach | JSON array | [] | Нет | File object |
Пример запроса
{
"id": 4727,
"override_source_id": 2550,
"override_source_type": "segment",
"run_now": true,
"token": "abcdefghijklmnqrstuvwxyz"
}
Пример ответа
{
"data": null,
"error": 0,
"error_text": "Successful operation"
}
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |