Описание

Добавление или обновление профиля с последующей отправкой триггерной кампании.

URL-адрес

Метод: POST

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

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

ПараметрТипПримерОбязательныйОписание
Импорт профиля клиента
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
dataJSON object
{
    "_fname": "John",
    "_lname": "Doe"
}
НетДанные о профиле, в том числе подписки
skip_triggersbooltrueНетПропустить запуск триггеров
по умолчанию – false
skip_invalid_subscriptionsbooltrueНетПропустить невалидные подписки
по умолчанию – false
detect_geobooltrueНет

Включает автоопределение geo данных по полю _regip  или _ip в data

Поиск профиля подписчика для обновления
matchingstring

"email"
"email_profile"
"phone"
"profile_id"
"custom"

Нет, если поиск

по email из профиля или подписок

Режим поиска подписчика.
По умолчанию - email. 

emailstring"john@example.com""matching":"email" - по профилю и подпискам
"matching":"email_profile" - только по профилю
Email-адрес
phonestring"+79000000000""matching":"phone"Номер телефона
profile_idstring
"abcdefghijklmnqrstuvwxyz"
"matching":"profile_id"Идентификатор профиля
field_namestring

"CRM_ID"

"matching":"custom"Название кастомного поля профиля для поиска. 
field_valueint/string"12345""matching":"custom"

Значение кастомного поля для поиска.

Доступен поиск по сочетанию значений поля с типом "тэги". Тэги передаются в строке черз запятую: "тэг_1, тэг_2".
resource_idint24Нет

Идентификатор ресурса для
поиска по email и phone

Запуск триггера
trigger_idint13Да

Идентификатор триггерной кампании для запуска

custom_dataJSON object{"sending_time": "12:31:12"}НетДанные для Захвата событий (Action hooks)
contentJSON object{"page": "registration_form"}НетДополнительные данные для подстановки в шаблон сообщения переменной {apicontent.fieldname}
attachJSON objects array{
"data": "data:text/csv;base64,SEVMTE8K",
"name": "Attach.txt"
}
НетФайл для прикрепления к Email сообщению (только для Email триггеров)

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

{
   "token": "care13fulwi3thttha2taxe43euge2ne",
   "matching": "email",
   "email": "example@example.com",
   "detect_geo": true,
   "data": {
      "_fname": "Olly",
      "_lname": "Lambert",
      "email": "example@example.com",
      "phones": [
         "+790000000000"
      ],
      "_bdate": "1990-02-22T21:00:00Z",
      "custom_field": "custom_value",
      "subscriptions": [
         {
            "channel": "email",
            "email": "example@example.com",
            "resource_id": 1,
         },
         {
            "channel": "phone",
            "phone": "+790000000000",
            "resource_id": 1,
         }
      ]
   },
   "trigger_id": 13,
   "custom_data": {
      "sending_time": "12:31:12"
   },
   "content": {
      "page": "registration_form"
   },
   "attach": [
      {
         "data": "data:text/csv;base64,5LuK5pel44GvCg==",
         "name": "Attach.txt"
      }
   ]
}

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

{
    "error": 0,
    "error_text": "",
    "profile_id": "54759eb3c090d83494e2d804"
}

Подписка на ресурс по которой будет производиться отправка триггера должна быть передана в объекте data.
Если нужной подписки не окажется среди переданных, API ответит следующей ошибкой:

{
    "error": 400,
    "error_text": "No active subscriptions passed for trigger resource"
}

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

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
profile_idstringИдентификатор профиля
  • No labels