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

Импортировать профиль

Описание​

Запрос добавляет профиль клиента в базу. Также при помощи этого запроса можно обновить профиль, который уже есть в базе.

подсказка

Чтобы одновременно с импортом отправлять триггерную кампанию, используйте этот запрос.

URL-адрес​

Метод: POST

https://example.com/api/v1.1/profiles/import

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

предупреждение
  • При использовании JSON в теле запроса используйте заголовок Content-Type: application/json.
  • При использовании XML в теле запроса используйте заголовок Content-Type: application/xml.
ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
db_idint1ДаИдентификатор базы данных
matchingstring

"email" – поиск по email из профиля или подписок

"email_profile" – по email из профиля

"email_sub" – по email из подписок

"phone" – по телефону из профиля или подписок

"phone_sub" – по телефону из подписок

"profile_id" – по идентификатору профиля (только при обновлении!)

"push_sub" – по пуш подписке

"custom" – по кастомному полю

"custom_sub" – по подписке на кастомный канал

"email_phone" – по email или телефону из профиля

"email_phone_sub" – по email или телефону из подписок

Нет, если поиск по email из профиля или подписок

Режим поиска подписчика. По умолчанию – email

Для каждого типа матчинга в теле запроса необходимо передавать определенные поля. Подробнее об этих полях можно узнать здесь.

Обратите внимание, что при режиме "email" или "phone" поиск происходит одновременно в контактных данных и в подписках.

skip_triggersbooltrueНетПропустить запуск триггеров
(по умолчанию – false)
skip_invalid_subscriptionsbooltrueНетПропустить невалидные подписки
(по умолчанию – false)
detect_geobooltrueНетВключает автоопределение geo-данных по полю _regip или _ip в data
add_to_segmentsJSON список[1,2]НетДобавление профиля в сегмент
remove_from_segmentsJSON список[1,2]НетУдаление профиля из сегмента
dataJSON object
{
    "_fname": "John",
    "_lname": "Doe"
}
Да

Данные о профиле, в т. ч. данные о подписках на ресурсы (subscriptions)

Массив subscriptions​

Массив subscriptions хранит данные о подписках профиля на ресурсы. Один объект — одна подписка.

ПараметрыТипПримерОписание
resource_idint1Идентификатор ресурса
statusstring"subscribed"Статус подписки (опциональное поле).

Рекомендуется передавать только в тех случаях, когда необходимо обновить статус подписки.
priorityint1Приоритет подписки (опциональное поле).

В случае если приоритет подписки передается в запросе, опция "Повышать приоритет для новых подписок" в ресурсе не работает.
custom_fieldsobject
{
   "_browser_name": "Chrome",
   "_device_type": "web"
}

Стандартные и дополнительные поля подписки (опциональное поле).

Получить информацию о доступных полях подписки в ресурсе можно с помощью метода /v1.1/resources/fields_get

catsarray
[
   "category_1",
   "category_2"
]
Категории ресурса, на которые подписать профиль (опциональное поле).
Email-канал
channelstring"email"Тип канала
emailstring"john@example.com"Email-адрес
SMS-канал
channelstring"sms"Тип канала
phonestring"+79000000000"Номер телефона
Push-канал
channelstring"push"Тип канала
providerstring"Firefox"Тип провайдера
subscription_idstring"abcdefghijklmnqrstuvwxyz"Идентификатор подписки
Telegram Bot канал
channelstring"telegram_bot"Тип канала
cc_dataobject
{
   "id": 1
}
ID чата в Telegram-бот
WhatsApp*-канал
channelstring"whatsapp"Тип канала
cc_dataobject
{
   "phone": "+79000000000"
}
Телефон профиля в WhatsApp*
Viber-канал
channelstring"viber"Тип канала
cc_dataobject
{
   "phone": "+79000000000"
}
Телефон профиля в Viber
Notify-канал
channelstring"notify"Тип канала
cc_dataobject
{
   "phone": "+79000000000"
}
Телефон профиля в VK/OK/SMS

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

Импорт профиля c добавлением подписки на email-канал​

{
     "token": "abcdefghijklmnqrstuvwxyz",
     "db_id": 1,
     "matching": "email",
     "email": "example@example.com",
     "detect_geo": true,
     "data": {
        "_fname": "Olly",
        "_lname": "Lambert",
        "email": "example@example.com",
        "phones": ["+79000000000"],
        "subscriptions": [
            {
                "resource_id": 1,
                "channel": "email",
                "email": "example@example.com"
            }
        ]
    }
}

Импорт профиля с передачей его дополнительных данных​

{
     "token": "abcdefghijklmnqrstuvwxyz",
     "db_id": 1,
     "matching": "email",
     "email": "example@example.com",
     "detect_geo": true,
     "data": {
        "_fname": "Olly",
        "_lname": "Lambert",

        "email": "example@example.com",
        "phones": ["+79000000000"],

        "_bdate": "1990-02-22T21:00:00Z",
        "_sex": 0,

        "_regdate": "2019-03-14T22:00:00Z",
        "_regip": "94.231.119.122",
        "_ip": "94.231.119.122",

        "_tz": "Europe/Moscow",
        "_postal_code": "390000",

        "_os": "Windows 10",
        "_browser": "Firefox",

        "_vendor": "form_#31",

        "custom_field": "custom_value",

        "subscriptions": [
            {
                "resource_id": 1,
                "channel": "email",
                "email": "example@example.com"
            }
        ]
    }
}

Импорт профиля с добавлением подписок на различные каналы​

{
     "token": "abcdefghijklmnqrstuvwxyz",
     "db_id": 1,
     "matching": "email",
     "email": "example@example.com",
     "detect_geo": true,
     "data": {
        "_fname": "Olly",
        "_lname": "Lambert",
        "email": "example@example.com",
        "subscriptions": [
            {
                "resource_id": 1,
                "channel": "email",
                "email": "example@example.com"
            },
            {
                "resource_id": 2,
                "channel": "sms",
                "phone": "+79000000000"
            },
            {
                "resource_id": 1,
                "channel": "push",
                "subscription_id": "a81c264a938b475",
                "provider": "android-firebase",
                "custom_fields": {
                    "_browser_name": "Firefox",
                    "_device_type": "web",
                    "custom_field_1": "test value"
                },
                "cats": [
                    "category_1",
                    "category_2"
                ]
            },
            {
                "resource_id": 1,
                "channel": "whatsapp",
                "cc_data": {
                    "phone": "+79000000000"
                }
            },
            {
                "resource_id": 1,
                "channel": "viber",
                "cc_data": {
                    "phone": "+79000000000"
                }
            },
            {
                "resource_id": 1,
                "channel": "telegram_bot",
                "cc_data": {
                    "id": 12345
                }
            },
            {
                "resource_id": 1,
                "channel": "notify",
                "cc_data": {
                    "phone": "+79000000000"
                }
            }
        ]
    }
}

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

{
  "error": 0,
  "error_text": "Successful operation",
  "profile_id": "54759eb3c090d83494e2d804"
}

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

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

*Организация Meta, которой принадлежат продукты Instagram, Facebook и WhatsApp, признана экстремистской и запрещена на территории РФ.

Последнее обновление