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

Описание

Данный запрос позволяет импортировать или обновить несколько профилей и сразу отправить их в сценарий, он является 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, email_profile, phone, profile_id, custom
profile_id	string	"5f19953a03e4227216278ba4"	Только при matching = "profile_id"	Идентификатор профиля
email	string	"123@example.com"	Только при matching = "email" или "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	{"one": "My email value", "two": "Timestamp: 1595512477"}	Нет	Дополнительные данные для подстановки в шаблон через {apicontent.fieldname}
attach	array	[{"name": "file.txt", "file_key": "key123"}]	Нет	Файлы для прикрепления к Email сообщению (только для Email триггеров)

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

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

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

JSON

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "workflow_id": 12,
  "matching": "email",
  "data": [
    {
      "data": {
        "_fname": "Alisa",
        "_lname": "Lambert",
        "email": "example@example.com",
        "phones": "+79000000000"
      }
    },
    {
      "data": {
        "_fname": "Alex",
        "_lname": "Lambert",
        "email": "example@example.com",
        "phones": "+79000000000"
      }
    }
  ]
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <workflow_id>10</workflow_id>
  <matching>email</matching>
  <data>
    <_fname>John</_fname>
    <_lname>Lambert</_lname>
    <email>example@example.com</email>
  </data>
  <data>
    <_fname>Bert</_fname>
    <_lname>Lambert</_lname>
    <email>example@example.com</email>
  </data>
</xml>

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

JSON

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "workflow_id": 12,
  "matching": "custom",
  "field_name": "CRM_ID",
  "data": [
    {
      "data": {
        "_fname": "Alina",
        "_lname": "Lambert",
        "email": "example@example.com",
        "phones": "+79006574081",
        "CRM_ID": "00066"
      }
    },
    {
      "data": {
        "_fname": "Victor",
        "_lname": "Lambert",
        "email": "example@example.com",
        "phones": "+79000005422",
        "CRM_ID": "00076"
      }
    }
  ]
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <workflow_id>12</workflow_id>
    <matching>custom</matching>
    <field_name>New_field_7</field_name>
    <data>
        <_fname>Polina</_fname>
        <_lname>Lambert</_lname>
        <email>example@example.com</email>
        <phones>+79006574082</phones>
        <New_field_7 string = "true" >00067</New_field_7>
    </data>
    <data>
        <_fname>Dariya</_fname>
        <_lname>Lambert</_lname>
        <email>example@example.com</email>
        <phones>+79000005423</phones>
        <New_field_7 string = "true">00077</New_field_7>
    </data>
</xml>

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

JSON

{
    "error": 0,
    "error_text": "Successful operation",
    "result": [
        {
            "profile_id": "6613c4754a5d12bd6cc0915f"
        },
        {
            "profile_id": "6613c4754a5d12bd6cc09163"
        }
    ]
}

XML

<xml>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <result>
        <profile_id>6613c4bf4a5d12bd6cc09167</profile_id>
    </result>
    <result>
        <profile_id>6613c4bf4a5d12bd6cc0916b</profile_id>
    </result>
</xml>

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

JSON

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

XML

<xml>
   <error>400</error>
   <error_debug>http: request body too large</error_debug>
   <error_text>Invalid request</error_text>
</xml>