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

Описание

Добавление или обновление нескольких профилей с последующей отправкой их в сценарий. Возвращает ответ с id таска, не дожидаясь выполнения.

примечание

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

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

URL-адрес

Метод: POST

https://example.com/api/v1.1/workflows/import_and_start_batch_task

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
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 триггеров)

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

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

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

JSON

{
  "workflow_id": 12,
  "matching": "email",
  "data": [
    {
      "data": {
        "_fname": "Herbert",
        "_lname": "Lambert",
        "email": "example@example.com",
        "phones": "+79862014852"
      }
    },
    {
      "data": {
        "_fname": "Bert",
        "_lname": "Lambert",
        "email": "example@example.com",
        "phones": "+79862014853"
      }
    }
  ]
}

XML

<xml>
  <workflow_id>12</workflow_id>
  <matching>email</matching>
  <data>
      <_fname>Herb</_fname>
      <_lname>Limbert</_lname>
      <email>example@example.com</email>
      <phones>+79847076617</phones>
  </data>
  <data>
      <_fname>Bert</_fname>
      <_lname>Limbert</_lname>
      <email>example@example.com</email>
      <phones>+79817076617</phones>
  </data>
</xml>   

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

JSON

{
    "workflow_id": 12,
    "matching": "custom",
    "field_name": "New_field_7",
    "data": [
        {
            "data": {
                "_fname": "Kristina",
                "_lname": "Lambert",
                "email": "example@example.com",
                "phones": "+79568150395",
                "New_field_7": "00015"
            }
        },
        {
            "data": {
                "_fname": "Christopher",
                "_lname": "Lambert",
                "email": "example@example.com",
                "phones": "+79568150396",
                "New_field_7": "00016"
            }
        }
    ]
}

XML

<xml>
    <workflow_id>12</workflow_id>
    <matching>custom</matching>
    <field_name>CRM_ID</field_name>
    <data>
        <_fname>Naomy</_fname>
        <_lname>Depp</_lname>
        <email>example@example.com</email>
        <phones>+798144890880</phones>
        <CRM_ID>7830</CRM_ID>
    </data>
    <data>
        <_fname>Nataly</_fname>
        <_lname>Depp</_lname>
        <email>example@example.com</email>
        <phones>+73755334351</phones>
        <CRM_ID>0934</CRM_ID>
    </data>
</xml>

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

JSON

{
  "error": 0,
  "error_text": "Successful operation",
  "task_id": "30421978-7f6d-4f39-913f-fb6cad8e2477"
}

XML

<xml>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <task_id>675231ce-63b4-4bca-a153-10d87b938d26</task_id>
</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>

Проверка статуса задания

URL-адрес

Метод: POST

https://example.com/api/v1.1/tasks/status

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

Параметр	Тип	Пример	Обязательный	Описание
task_id	string	"task_b2f9fk6a-2479-4a63-b592-f15d4e3b69c5"	Да	Идентификатор задания

Пример запроса

JSON

{
  "task_id": "task_b2f9fk6a-2479-4a63-b592-f15d4e3b69c5"        
}

XML

<xml>
  <task_id>task_b2f9fk6a-2479-4a63-b592-f15d4e3b69c5</task_id>
</xml>

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

JSON

{
    "data": {
        "status": "completed",
        "progress": 100,
        "result": {
            "error": 0,
            "error_text": "",
            "result": [
                {
                    "profile_id": "61e947333f62fc26d384452c"
                },
                {
                    "profile_id": "61e947333f62fc26d384452e"
                }
            ]
        }
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data>
        <status>completed</status>
        <progress>100</progress>
        <result>
            <error>0</error>
            <error_text></error_text>
            <result>
                <profile_id>61e947333f62fc26d384452c</profile_id>
            </result>
            <result>
                <profile_id>61e947333f62fc26d384452e</profile_id>
            </result>
        </result>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>