Массовый импорт и запуск профилей в сценарий

Описание

Данный запрос позволяет импортировать или обновить несколько профилей и сразу отправить их в сценарий, он является batch-версией запроса Одновременный импорт и запуск профиля в сценарий.

примечание

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

В одном запросе не рекомендуется передавать более 10 000 профилей.

URL-адрес

Метод: 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"	Идентификатор профиля
email	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	{    "_fname": "John",    "_lname": "Doe" }	Нет	Данные о профиле, в том числе подписки
skip_triggers	bool	true	Нет	Пропустить запуск триггеров по умолчанию – false
skip_invalid_subscriptions	bool	true	Нет	Пропустить невалидные подписки по умолчанию – false
detect_geo	bool	true	Нет	Включает автоопределение geo данных по полю _regip или _ip в data
content	object	"content": {    "one": "My email = importStart9219@example.com",    "two": "Timestamp: 1595512477",    "three": "Three" }	Нет	Дополнительные данные для подстановки в шаблон сообщения переменной {apicontent.fieldname}. Также {apicontent} можно использовать в узлах "API вызов" и "Контент фильтр"
custom_data	JSON object	"custom_data": {    "field": "value", }	Нет	Пользовательские параметры, возвращаются в хуках (Захват событий). Можно передавать в корне запроса или отдельно в каждом объекте data.
attach	array of {name, flie_key, data, mimetype}		Нет	Файл для прикрепления к Email сообщению (только для Email триггеров)
custom_request	JSON object		Если нет свойства "matching"	MongoDB запрос по полям профиля

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

Параметр	Тип	Описание
error_text	string	Текст ошибки
error	int	Код ошибки
result	array	Идентификаторы (profile_id) успешно импортированных профилей

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

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "workflow_id": 2,
  "matching": "email",
  "data": [
    {
      "data": {
        "_fname": "Herbert",
        "_lname": "Lambert",
        "email": "profile5@example.com",
        "phones": "+79000000000"
      }
    },
    {
      "data": {
        "_fname": "Bert",
        "_lname": "Lambert",
        "email": "profile8@example.com",
        "phones": "+79000000000"
      }
    }
  ]
}

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

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "workflow_id": 233,
  "matching": "custom",
  "field_name": "New_field_1",
  "data": [
    {
      "data": {
        "_fname": "NUMBER15",
        "_lname": "Lambert",
        "email": "profile015@example.com",
        "phones": "+79000000015",
        "New_field_1": "00015"
      }
    },
    {
      "data": {
        "_fname": "NUMBER16",
        "_lname": "Lambert",
        "email": "profile016@example.com",
        "phones": "+79000000016",
        "New_field_1": "00016"
      }
    }
  ]
}

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

{
    "error": 0,
    "error_text": "Successful operation",
    "result": [
        {
            "profile_id": "65c4fcaf2847a60f44c98e0e"
        },
        {
            "profile_id": "65c4fcb02847a60f44c98e12"
        }
    ]
}

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

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