Ознакомьтесь с API, который позволит вам импортировать несколько профилей и сразу отправлять их в сценарий автоматизации. Читайте статью. |
Данный запрос позволяет импортировать несколько профилей и сразу отправить их в сценарий, он является batch-версией запроса Одновременный импорт и запуск профиля в сценарий.
Тело запроса ограничено по умолчанию до 10мб, исключение: файлы - 100мб |
Метод: POST
https://example.com/api/v1.1/workflows/import_and_start_batch
Параметр | Тип | Пример | Обязательный | Описание | |||
---|---|---|---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен | |||
format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию - "json") | |||
workflow_id | Int | 1 | Да | Идентификатор цепочки | |||
matching | String | "email" | Да | Режим поиска подписчика. По умолчанию - email. | |||
profile_id | String | "5f19953a03e4227216278ba4" | "matching":"profile_id" | Идентификатор профиля | |||
String | "importStart9219@example.com" | "matching":"email" - по профилю и подпискам "matching":"email_profile" - только по профилю | Email-адрес | ||||
phone | String | "+79001234567" | "matching":"phone" | Номер телефона | |||
field_name | String | "CRM_ID" | "matching":"custom" | Название кастомного поля профиля для поиска. | |||
field_value | Any | "12345" | "matching":"custom" | Значение кастомного поля для поиска. Доступен поиск по сочетанию значений поля с типом "тэги". Тэги передаются в строке черз запятую: "тэг_1, тэг_2". | |||
data | Object |
| Нет | Данные о профиле, в том числе подписки | |||
skip_triggers | Bool | true | Нет | Пропустить запуск триггеров по умолчанию – false | |||
skip_invalid_subscriptions | Bool | true | Нет | Пропустить невалидные подписки по умолчанию – false | |||
detect_geo | Bool | true | Нет | Включает автоопределение geo данных по полю _regip или _ip в data | |||
content | Object |
| Нет | Дополнительные данные для подстановки в шаблон сообщения переменной {apicontent.fieldname} | |||
attach | array of {name, flie_key, data, mimetype} | Нет | Файл для прикрепления к Email сообщению (только для Email триггеров) | ||||
custom_request | JSON object | Если нет свойства "matching" | MongoDB запрос по полям профиля | ||||
subscription | JSON object |
| Подписки профиля. |
Параметр | Тип | Описание |
---|---|---|
error_text | string | Текст ошибки |
error | int | Код ошибки |
task_id | string | Идентификатор задачи |
{ "token": "abcdefghijklmnqrstuvwxyz", "workflow_id": 2, "matching": "email", "data": [ { "data": { "_fname": "Herbert", "_lname": "Lambert", "email": "profile5@example.com", "phones": "+790000000000" } }, { "data": { "_fname": "Bert", "_lname": "Lambert", "email": "profile8@example.com", "phones": "+790000000000" } } ] } |
{ "token": "abcdefghijklmnqrstuvwxyz", "workflow_id": 233, "matching": "custom", "field_name": "New_field_1", "data": [ { "data": { "_fname": "NUMBER15", "_lname": "Lambert", "email": "profile015@example.com", "phones": "+790000000015", "New_field_1": "00015" } }, { "data": { "_fname": "NUMBER16", "_lname": "Lambert", "email": "profile016@example.com", "phones": "+790000000016", "New_field_1": "00016" } } ] } |
{ "error": 0, "error_text": "Successful operation", "task_id": "30421978-7f6d-4f39-913f-fb6cad8e2477" } |
{ "error":400, "error_debug":"http: request body too large", "error_text":"Invalid request" } |