Обновить регулярную кампанию
Описание
Обновить регулярную кампанию.
URL-адрес
Метод: POST
https://example.com/api/v1.1/campaigns/regulars/update
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
id | int | 1 | Да | Идентификатор кампании |
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 | Да | Контент, присоединенный к кампании | |
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-аккаунтов |
примечание
Изменять канал в уже сохраненной кампании нельзя. При передаче соответствующих параметров — send_channel
,content_type
, send_email_content
, send_sms_content
, send_push_content
— запрос не вернет ошибку, но и не обновит канал отправки.
Пример запроса
{
"content": [
{
"from_email": "broadcast@altcraft.com",
"from_name": "",
"message_id": 2549,
"replyto_email": "broadcast@altcraft.com",
"replyto_name": "",
"subject": "Hi!"
}
],
"custom_tracking_domains": [
"trk.example.com",
"trk.example.org"
],
"data_id": 2690,
"data_type": "segment",
"id": 4800,
"is_active": true,
"limit": 10,
"name": "Regular campaign name",
"resource_id": 200,
"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": "d58ee9e0af6747bd8ad7d4d9fa98acb6",
"virtual_sender_id": 8
}
Пример ответа
{
"data": {
"saved_id": 4800
},
"error": 0,
"error_text": "Successful operation"
}
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
saved_id | int | Идентификатор кампании |