Перейти к основному содержимому

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

Описание​

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

примечание

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

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

URL-адрес​

Метод: POST

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

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
formatstring"json"НетФормат возвращаемых данных (по умолчанию - "json")
workflow_idint1ДаИдентификатор цепочки
matchingstring"email"ДаРежим поиска подписчика.
По умолчанию - email.
profile_idstring"5f19953a03e4227216278ba4""matching":"profile_id"Идентификатор профиля
emailstring"importStart9219@example.com""matching":"email" - по профилю и подпискам

"matching":"email_profile" - только по профилю		Email-адрес
phonestring"+79001234567""matching":"phone"Номер телефона
field_namestring"CRM_ID""matching":"custom"Название кастомного поля профиля для поиска.
field_valueany"12345""matching":"custom"Значение кастомного поля для поиска. Доступен поиск по сочетанию значений поля с типом "теги". Теги передаются в строке черз запятую: "тег_1, тег_2".
dataobject
{
   "_fname": "John", 
   "_lname": "Doe" 
}
НетДанные о профиле, в том числе подписки
skip_triggersbooltrueНетПропустить запуск триггеров
по умолчанию – false
skip_invalid_subscriptionsbooltrueНетПропустить невалидные подписки
по умолчанию – false
detect_geobooltrueНетВключает автоопределение geo данных по полю _regip или _ip в data
contentobject
"content": {
   "one": "My email = importStart9219@example.com",
   "two": "Timestamp: 1595512477",
   "three": "Three"
}
НетДополнительные данные для подстановки в шаблон сообщения переменной {apicontent.fieldname}. Также {apicontent} можно использовать в узлах "API вызов" и "Контент фильтр"
custom_dataJSON object
"custom_data": {
   "field": "value",
}
НетПользовательские параметры, возвращаются в хуках (Захват событий). Можно передавать в корне запроса или отдельно в каждом объекте data.
attacharray of {name, flie_key, data, mimetype}
НетФайл для прикрепления к Email сообщению (только для Email триггеров)
custom_requestJSON object
{
    "email": {
        "$in": [
            "asd@dsfsd.com",
            "zxcv@sdfsd.com"
        ]
    }
}
Если нет свойства "matching"MongoDB-запрос по полям профиля

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

ПараметрТипОписание
error_textstringТекст ошибки
errorintКод ошибки
task_idstringИдентификатор задачи

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

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "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"
      }
    }
  ]
}

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

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "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"
            }
        }
    ]
}

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

{
  "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"
}

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

URL-адрес​

Метод: POST

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

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

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

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

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

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

{
    "data": {
        "status": "completed",
        "progress": 100,
        "result": {
            "error": 0,
            "error_text": "",
            "result": [
                {
                    "profile_id": "61e947333f62fc26d384452c"
                },
                {
                    "profile_id": "61e947333f62fc26d384452e"
                }
            ]
        }
    },
    "error": 0,
    "error_text": "Successful operation"
}
Последнее обновление