Skip to end of metadata
Go to start of metadata

Описание

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

URL-адрес

Метод: POST

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

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
formatstring"json"НетФормат возвращаемых данных (по умолчанию - "json")
workflow_idInt1ДаИдентификатор цепочки
matchingString"email"ДаТип матчинга
profile_idString
"5f19953a03e4227216278ba4"
*Импорт: Поля матчига
emailString
"importStart9219@example.com"
*Импорт: Поля матчига
phoneString"+79001234567"*Импорт: Поля матчига
field_nameString"CRM_ID"*Импорт: Поля матчига
field_valueAny"12345"*Импорт: Поля матчига
dataObject
{
	"_fname": "John", 
	"_lname": "Doe" 
}
НетИмпорт: Обьект с полями профиля, в том числе подписки
skip_triggersBooltrueНетОпции импорта: пропускать остальные триггеры и цепочки настроенные на действие импорта и изменения в полях и подписках.
skip_invalid_subscriptionsBooltrueНетОпции импорта: пропускать невалидные подписки 
detect_geoBooltrueНетОпции импорта: определение геолокации по IP
contentObject
"content": {
	"one": "My email = importStart9219@example.com",
	"two": "Timestamp: 1595512477",
	"three": "Three"
},
НетДополнительные данные для подстановки в шаблон сообщения переменной {apicontent.fieldname}. Так же {apicontent}  можно использовать в узлах "API вызов" и "Контент фильтр"
attacharray of {name, flie_key, data, mimetype}
НетОпции триггера: прикрепить файлы к письму

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

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

{
	"token": "abcdefghkijlmnopqrstuv0123456789",
	"data": {
		"subscriptions": [{
			"email": "example001@example.com",
			"resource_id": 1
		}]
	},
	"db_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"
}

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

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
profile_idstringID профиля

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

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