Skip to end of metadata
Go to start of metadata

Описание

Упрощенный импорт профиля имеет линейную структуру, и предназначен для простейших интеграций. 

Для получения доступа к большему функционалу воспользуйтесь методом /api/v1.1/profiles/import.

Импортирует или обновляет профиль, добавляет подписки, если передать номер ресурса и есть контактные данные.


URL-адрес

Метод: POST. Данные могут быть переданы как в параметрах URL, так и теле запроса, если это POST.

https://example.com/api/integrations/any/profile_import


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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
db_idint1ДаИдентификатор базы данных
matchingstring"email"Нет

Способ поиска профиля для обновления:

  • email - поиск по email из профиля или подписок
  • email_profile - поиск по email из профиля
  • phone - поиск по телефону из профиля или подписок
  • custom - свое поле, указанное в field_name

В это поле также можно передать имя поля для поиска (field_name вместо custom)

по умолчанию – email

resource_idint1НетСформировать подписку на указанный ресурс, на базе импортируемых данных
emailstring"example@example.com"НетАдрес email подписки. Также требуется при поиске по email
phonestring"+75551111444"НетНомер телефона. Также требуется при поиске по телефону
_regipstring"172.16.0.1"НетIPv4 или IPv6 адрес регистрации. В случае передачи IPv4 адреса будет произведена попытка геолокации
_regurlstring"https://example.com/?"НетЕсли не передан - будет установлен из HTTP заголовка Referer
*


Можно передавать любые поля имеющиеся в бд, хотя бы одно поле требуется для успешного импорта.

Для получения информации о полях базы данных, используйте /api/v1.1/databases/fields_get

trigger_idint13Нет

Идентификатор триггерной кампании для запуска. Если trigger_id задан, то произойдет одновременный импорт профиля и отправка триггера, если нет - обычный импорт профиля

workflow_idint1НетИдентификатор цепочки. Если workflow_id задан, то произойдет одновременный импорт профиля и запуск профиля в сценарий, если нет - обычный импорт профиля

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

Упрощенный импорт отвечает HTTP кодом и текстом ошибки в теле сообщения.

HTTP КодПояснение
200Успешный импорт
400

Ошибки в формировании запроса, проверьте правильность передаваемых полей

402Достигнуты ограничения аккаунта по тарифу
403API ключ не передан или не правильный, у него нет прав на запись в базы данных
404Не найдена база данных для импорта или ресурс для подписки
409Для заданного поиска найдена более чем один профиль, это значит что поиск недостаточно точен
435Невозможно соблюсти уникальность поля при сохранении данных, обычно это поле email, когда поиск осуществляется не по email, а например по кастомному полю
500Внутренняя ошибка сервиса


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

curl "https://example.com/api/integrations/any/profile_import" \
    -d token="abcdefghijklmnqrstuvwxyz" \
    -d db_id=1 \
    -d resource_id=1 \
    -d email="john.doe@example.com" \
    -d _fname="John" \
    -d _lname="Doe"

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

Successfully added 5beeea0ad861602a078a6f34
  • No labels