Перейти к основному содержимому
Документация для версии v72

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

Описание​

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

URL-адрес​

Метод: POST

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

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
formatstring"csv"НетФормат возвращаемых данных
по умолчанию – "json"
namestring"New Awesome Campaign"ДаНазвание кампании
is_activebooltrueНетСтатус кампании
contentJSON array
[
{
"from_email": "",
"from_name": "",
"message_id": 12,
"replyto_email": "",
"replyto_name": "",
"subject": "Weather alert"
}
]
ДаКонтент, присоединенный к кампании
subidstring"Adv_1"НетSubid кампании
trigger_typestring"api_call"ДаТип триггера
send_channelstring"email"
"sms"
"push"		ДаКанал отправки.
Если в запросе также передаются другие параметры, связанные с каналом (content_type, send_email_content, send_sms_content, send_push_content), кампания будет использовать канал, указанный в параметре send_channel.
content_typestring"email"НетПараметр устарел. При его передаче кампания будет использовать email-канал для отправки.
send_email_contentboolfalseНетПараметр устарел. При его передаче кампания будет использовать email-канал для отправки.
send_sms_contentboolfalseНетПараметр устарел. При его передаче кампания будет использовать email-канал для отправки.
send_push_contentbooltrueНетПараметр устарел. При его передаче кампания будет использовать email-канал для отправки.
skip_minutesint0НетПодождать Х минут перед активацией кампании
resource_idint24ДаИдентификатор ресурса
policy_idint1НетИдентификатор политики отправки
push_sending_modestring"fanout" (по умолчанию)
"last"		НетРежим отправки push-сообщений (только для push-каналов)
attributesobject"season":"2024_summer"НетАтрибуты, назначенные кампании, и их значения
Smart настройки
virtual_sender_idint12НетИдентификатор виртуального сендера
Только для smart-аккаунтов
is_random_trk_prefixboolfalseНетСлучайный префикс трекинг-домена
Только для smart-аккаунтов
custom_trk_domainJSON array["trk.example.com", "trk2.example.com"]НетСписок произвольных трекинг-доменов
Только для smart-аккаунтов
blind_carbon_copyJSON array["john@example.com", "george@example.com"]НетАдреса для скрытой копии
Только для smart-аккаунтов
unconditional_sendingbooltrueНетОтправка вне зависимости от статуса подписки
Только для smart-аккаунтов

* Опция доступна только при использовании Altcraft MP по лицензии (On-Premise). Для активации этой возможности в файл конфигурации main.json в свойство EXTRAS нужно добавить значение "unc_campaign".

Параметры, связанные с типом триггера​

ПолеТипОписаниеapi_callapi_importactionupdatepixelsubscribe
actionstringТип запуска, основанный на действииНетНетДаНетНетНет
update_queryJSON arrayОбновление полей профиля:
{ 
 "fieldname": "custom_ID",
 "fieldtype": "int",
 "operator": "equal",
 "value": "2000" 
 }
НетНетНетДаНетНет
link_namestringИмя ссылки в сообщенииНетНетДаНетНетНет
message_idintИдентификатор шаблона сообщения для событий захватаНетНетДаНетНетНет
list_idintИдентификатор базы данныхДаДаНетДаНетНет
subscribe_resource_idintИдентификатор ресурса подписки, на которую реагирует триггерНетНетНетНетНетДа
channelstringКанал на который реагироватьНетНетНетНетНетДа
is_new_subboolРеагировать на новый ресурсНетНетНетНетНетДа
is_new_chboolРеагировать на новый канал в ресурсНетНетНетНетНетДа
is_new_contactboolРеагировать на новый контакт в каналеНетНетНетНетНетДа
is_status_changedboolРеагировать на смену статуса на перечисленные в trigger_statusesНетНетНетНетНетДа
trigger_statusesarray(int)Статусы новых/измененных подписок, на которые реагирует триггерНетНетНетНетНетДа
pixel_idintИдентификатор пикселя для захвата событийНетНетНетНетДаНет

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

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "name": "New trigger campaign №1",
  "content": [
    {
      "subject": "Maybe very important message",
      "from_email": "",
      "from_name": "James",
      "replyto_email": "",
      "replyto_name": "",
      "message_id": 14
    }
  ],
  "trigger_type": "api_call",
  "send_channel": "email",
  "list_id": 1
}

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

{
    "data": {
        "saved_id": 95,
        "trigger_link": "http://trk.test.test.altcraft.com:8095/trg/65512f8ec196edd6ac71fa5d068d355f65512f8ec196edd62f3de6b87e2969e3/<email|md5|xxh>"
    },
    "error": 0,
    "error_text": "Successful operation"
}

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

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
saved_idintИдентификатор новой кампании
trigger_linkstringТолько если trigger_type = "api_call"
Последнее обновление