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

Описание

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

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-каналов)
attributes	object	"season":"2024_summer"	Нет	attributes
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-аккаунтов

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

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "virtual_sender_id": 5,
    "content": [
        {
            "from_email": "regular@altcraft.com",
            "from_name": "Paul",
            "message_id": 15,
            "replyto_email": "regular@altcraft.com",
            "replyto_name": "Roman",
            "subject": "Hello"
        }
    ],
    "custom_tracking_domains": [
        "trk.example.com",
        "trk.example.org"
    ],
    "data_id": 1,
    "data_type": "list",
    "is_active": true,
    "limit": 1,
    "name": "Regular campaign #1",
    "resource_id": 20,
    "send_channel": "email",
    "start_schedule": {
         "start_hours": [
            1,
            2,
            3,
            4
        ],
        "start_mins": [
            1,
            2,
            3,
            4
        ],
        "start_mdays": [
            1
        ],
        "start_months": [
            12
        ],
        "start_wdays": [],
        "start_years": [
            2024
        ]
    }
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <virtual_sender_id>5</virtual_sender_id>
    <content array='true'>
        <from_email>example@example.com</from_email>
        <from_name>Paul</from_name>
        <message_id>15</message_id>
        <replyto_email>example@example.com</replyto_email>
        <replyto_name>Roman</replyto_name>
        <subject>Hello</subject>
    </content>
    <custom_tracking_domains>trk.example.com</custom_tracking_domains>
    <custom_tracking_domains>trk.example.org</custom_tracking_domains>
    <data_id>1</data_id>
    <data_type>list</data_type>
    <is_active>true</is_active>
    <limit>1</limit>
    <name>Regular campaign #2</name>
    <resource_id>20</resource_id>
    <send_channel>email</send_channel>
    <start_schedule>
        <start_hours>1</start_hours>
        <start_hours>2</start_hours>
        <start_hours>3</start_hours>
        <start_hours>4</start_hours>
        <start_mins>1</start_mins>
        <start_mins>2</start_mins>
        <start_mins>3</start_mins>
        <start_mins>4</start_mins>
        <start_mdays array='true'>1</start_mdays>
        <start_months array='true'>12</start_months>
        <start_wdays array='true'></start_wdays>
        <start_years array='true'>2024</start_years>
    </start_schedule>
</xml>

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

JSON

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

XML

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

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

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