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

Описание

Данный запрос дает возможность импортировать/обновить профиль и сразу отправить его в сценарий (цепочку).

URL-адрес

Метод: POST

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

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	string	"json"	Нет	Формат возвращаемых данных (по умолчанию - "json")
workflow_id	Int	1	Да	Идентификатор цепочки
matching	string	"email"	Да	Тип матчинга
profile_id	string	"5f19953a03e4227216278ba4"	*	Импорт: Поля матчига
email	string	"importStart9219@example.com"	*	Импорт: Поля матчига
phone	string	"+79001234567"	*	Импорт: Поля матчига
field_name	string	"CRM_ID"	*	Импорт: Поля матчига
field_value	any	"12345"	*	Импорт: Поля матчига
data	object	{    "_fname": "John",    "_lname": "Doe" }	Нет	Импорт: Обьект с полями профиля, в том числе подписки
skip_triggers	bool	true	Нет	Опции импорта: пропускать остальные триггеры и цепочки, настроенные на действие импорта и изменения в полях и подписках.
skip_invalid_subscriptions	bool	true	Нет	Опции импорта: пропускать невалидные подписки
detect_geo	bool	true	Нет	Опции импорта: определение геолокации по IP
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", }	Нет	Пользовательские параметры, возвращаются в хуках (Захват событий).
attach	array of {name, flie_key, data, mimetype}		Нет	Опции триггера: прикрепить файлы к письму

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

Импортировать один профиль и отправить его в сценарий.

{
  "token": "abcdefghkijlmnopqrstuv0123456789",
  "data": {
    "subscriptions": [
      {
        "email": "example001@example.com",
        "resource_id": 1
      }
    ]
  },
  "matching": "email",
  "email": "example001@example.com",
  "content": {
    "one": "My email = example001@example.com",
    "two": "Timestamp: 1595512477",
    "three": "Three"
  },
  "workflow_id": 1
}

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

{
  "error": 0,
  "error_text": "Successful operation",
  "profile_id": "5eeb54a2ce9448518e85fdad"
}

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

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
profile_id	string	ID профиля

Ответы сервиса

Код	Описание
0	Операция выполнена успешно
400,450	Некорректный запрос
401	Требуется API токен
402	Достигнуто ограничение тарифа
403	Нет прав на действие
404	Обьект не найден в зоне видимости токена
409	Существует другая запись с такими же признаками уникальности
413	База данных недоступна в выбранном ресурсе
415	Запрашиваемый Content-Type не поддерживается
435	Неоднозначный поиск, есть несколько обьектов с заданными характеристиками
441	Обьект принадлежит другой группе
500	Внутренняя ошибка сервиса
501	Такой метод отсуствует