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

Описание

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

Также используется для того, чтобы мгновенно отправить броадкаст или регулярную рассылку. Для этой отправки можно указать другой источник подписчиков.

Если поле 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

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

JSON

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "id": 82,
  "override_source_id": 1,
  "override_source_type": "list",
  "run_now": true
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <id>82</id>
    <override_source_id>1</override_source_id>
    <override_source_type>list</override_source_type>
    <run_now>true</run_now>
</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	Текст ошибки