Описание

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

Данный запрос является batch-версией запроса Импорт профиля + Отправка триггера.

Тело запроса ограничено по умолчанию до 10мб, исключение: файлы - 100мб


URL-адрес

Метод: POST

http://example.com/api/v1.1/campaigns/triggers/import_and_start_batch

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

ПараметрТипПримерОбязательныйОписание

Импорт профиля клиента

tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
dataarray
[
	{ 
		"data":	{ 
			"_fname": "John", 
			"_lname": "Lambert", 
			"email": "profile4@example.com", 
			"phones": "+790000000000" 
		} 
	}, 
	{ 
		"data" : { 
			"_fname": "Tom", 
			"_lname": "Hard", 
			"email": "profile3@example.com", 
			"phones": "+790000000001" 
		} 
	}
]
Нет

Данные об импортируемых профилях.

Каждый профиль - это отдельный JSON-объект "data".

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_idint8Да

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

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 триггеров)

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

ПараметрТипОписание
error_textstringТекст ошибки
errorintКод ошибки
resultarrayИдентификаторы (profile_id) успешно импортированных профилей

Пример запроса с матчингом по email

{
	"token": "abcdefghijklmnqrstuvwxyz",
	"trigger_id": 8,
	"format": "json",
	"skip_triggers": false,
	"detect_geo": true,
	"matching": "email",
	"data": [
		{
			"data": {
				"_fname": "John",
				"_lname": "Lambert",
				"email": "profile4@example.com",
				"phones": "+790000000000"
				}
		},
		{
			"data" : {
				"_fname": "Tom",
				"_lname": "Hard",
				"email": "profile3@example.com",
				"phones": "+790000000001"
			}
		}
	]
}

Пример запроса с матчингом по custom-полю

{
	"token": "abcdefghijklmnqrstuvwxyz",
	"trigger_id": 455,
	"format": "json",
	"skip_triggers": false,
	"detect_geo": true,
	"matching": "custom",
	"field_name": "New_field_1",
	"data": [
		{
			"data": {
				"_fname": "NUMBER1",
				"_lname": "Lambert",
				"email": "profile01@example.com",
				"phones": "+790000000000",
				"New_field_1" : "0002"
			}
		},
		{
			"data" : {
				"_fname": "NUMBER2",
				"_lname": "Hard",
				"email": "profile02@example.com",
				"phones": "+790000000001",
				"New_field_1" : "0001"
			}
		}
	]
}

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

{
	"error": 0,
	"error_text": "Successful operation",
	"result": [
		{
			"profile_id": "602103d65ae47a3bc65d5d83"
		},
		{
			"profile_id": "601ec71c5ae47a15d1c9b472"
		}
	]
}

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

{
	"error":400,
	"error_debug":"http: request body too large",
	"error_text":"Invalid request"
}
  • No labels