Добавить регулярную кампанию

Описание

Добавить регулярную кампанию.

URL-адрес

Метод: POST

https://example.com/api/v1.1/campaigns/regulars/add/

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных по умолчанию – "json"
name	string	"Broadcast campaign name"	Да	Название кампании
is_active	bool	true	Нет	Статус кампании
data_type	string	"list"	Да	Тип источника подписчиков
data_id	int	12	Да	Идентификатор базы данных или сегмента
resource_id	int	24	Нет	Идентификатор ресурса
content	JSON array		Да	Контент, присоединенный к кампании
send_channel	string	"email" "sms" "push"	Да	Канал отправки
content_type	string	"email"	Нет	Устаревший параметр. При его передаче кампания будет использовать email-канал для отправки. Рекомендуется использовать send_channel.
send_email_content	bool	true	Нет	Устаревший параметр. При его передаче кампания будет использовать email-канал для отправки. Рекомендуется использовать send_channel.
send_push_content	bool	true	Нет	Устаревший параметр. При его передаче кампания будет использовать email-канал для отправки. Рекомендуется использовать send_channel.
send_sms_content	bool	true	Нет	Устаревший параметр. При его передаче кампания будет использовать email-канал для отправки. Рекомендуется использовать send_channel.
subid	string	"Adv_1"	Нет	subid кампании
start_schedule	JSON object		Нет	Start schedule object
limit	int	0	Нет	Лимит на каждый запуск
aglimit_count	int	0	Нет	Приращивать лимит по количеству
aglimit_percent	float	99.0	Нет	Приращивать лимит по проценту
policy_id	int	1	Нет	Идентификатор политики отправки
push_sending_mode	string	"fanout" (по умолчанию) "last"	Нет	Режим отправки push-сообщений (только для push-каналов)
Smart настройки
virtual_sender_id	int	12	Нет	Идентификатор виртуального сендера Только для smart-аккаунтов
is_random_tracking_prefix	bool	false	Нет	Случайный префикс трекинг-домена Только для smart-аккаунтов
custom_tracking_domains	JSON array	["trk.example.com", "trk2.example.com"]	Нет	Список произвольных трекинг-доменов Только для smart-аккаунтов
blind_carbon_copy	JSON array	["john@example.com", "george@example.com"]	Нет	Адреса для скрытой копии Только для smart-аккаунтов
unconditional_sending	bool	true	Нет	Отправка вне зависимости от статуса подписки Только для smart-аккаунтов
watcher_list_id	int	12	Нет	Идентификатор базы наблюдателей Только для smart-аккаунтов
watcher_limit	int	100	Нет	Лимит наблюдателей Только для smart-аккаунтов

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

{
    "content": [
        {
            "from_email": "broadcast@altcraft.com",
            "from_name": "",
            "message_id": 2549,
            "replyto_email": "broadcast@altcraft.com",
            "replyto_name": "",
            "subject": "Hello"
        }
    ],
    "custom_tracking_domains": [
        "trk.example.com",
        "trk.example.org"
    ],
    "data_id": 2690,
    "data_type": "segment",
    "is_active": true,
    "limit": 1,
    "name": "Regular campaign name",
    "resource_id": 400,
    "send_channel": "email",
    "start_schedule": {
         "start_hours": [
            1,
            2,
            3,
            4
        ],
        "start_mdays": [
            1
        ],
        "start_mins": [
            1,
            2,
            3,
            4
        ],
        "start_months": [
            12
        ],
        "start_wdays": [],
        "start_years": [
            2020
        ]
    },
    "token": "abcdefghijklmnqrstuvwxyz",
    "virtual_sender_id": 7
}

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

{
    "data": {
        "saved_id": 4800
    },
    "error": 0,
    "error_text": "Successful operation"
}

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

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