Импорт профиля + Отправка триггера

Описание

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

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
Импорт профиля клиента
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
data	JSON object	{ "_fname": "John", "_lname": "Doe" }	Нет	Данные о профиле, в том числе подписки
skip_triggers	bool	true	Нет	Пропустить запуск триггеров по умолчанию – false
skip_invalid_subscriptions	bool	true	Нет	Пропустить невалидные подписки по умолчанию – false
detect_geo	bool	true	Нет	Включает автоопределение geo данных по полю `_regip` или `_ip` в `data`
Поиск профиля подписчика для обновления
matching	string	"email" "email_profile" "phone" "profile_id" "custom"	Нет, если поиск по email из профиля или подписок	Режим поиска подписчика. По умолчанию - email.
email	string	"john@example.com"	"matching":"email" - по профилю и подпискам "matching":"email_profile" - только по профилю	Email-адрес
phone	string	"+79000000000"	"matching":"phone"	Номер телефона
profile_id	string	"abcdefghijklmnqrstuvwxyz"	"matching":"profile_id"	Идентификатор профиля
field_name	string	"CRM_ID"	"matching":"custom"	Название кастомного поля профиля для поиска.
field_value	int/string	"12345"	"matching":"custom"	Значение кастомного поля для поиска. Доступен поиск по сочетанию значений поля с типом "теги". Теги передаются в строке черз запятую: "тег_1, тег_2".
resource_id	int	24	Нет	Идентификатор ресурса для поиска по email и phone
Запуск триггера
trigger_id	int	13	Да	Идентификатор триггерной кампании для запуска
timeout	JSON object	{ "days": 0, "hours": 0, "minutes": 5 }	Нет	Задержка перед запуском триггера. Указываются дни, часы и минуты.
custom_data	JSON object	{"sending_time": "12:31:12"}	Нет	Данные для Захвата событий (Action hooks)
content	JSON object	{"page": "registration_form"}	Нет	Дополнительные данные для подстановки в шаблон сообщения переменной {apicontent.fieldname}
attach	JSON 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,
   "timeout": {
         "days": 0,
         "hours": 0,
         "minutes": 5
   },    
   "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"
}

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

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

Space shortcuts

Page tree