Описание
Массовое добавление или обновление профилей клиента.
Если передать параметры объекта subscriptions status и priority со значением 0, то значение учитывается.
Чтобы не изменять и не обновлять значения этих параметров – не передавайте их, либо установите значения в -1.
В одном запросе не рекомендуется:
- передавать более 10 000 профилей;
- передавать более 10 Мб данных. Можно передавать больший объем в несколько потоков.
URL-адрес
Метод: POST
https://example.com/api/v1.1/profiles/import_batch
Параметры запроса
- При использовании JSON в теле запроса используйте заголовок Content-Type: application/json.
- При использовании XML в теле запроса используйте заголовок Content-Type: application/xml.
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| data | JSON array | [
{
"_fname": "John",
"_lname": "Doe",
"subscriptions": [
{
"channel": "email",
"email_data": {
"email": "john@example.com"
},
"resource_id": 1
}
]
}
]
| Да | Данные о профилях |
| db_id | int | 1 | Да | Идентификатор базы данных |
| skip_invalid_subscriptions | bool | true | Нет | Пропустить невалидные подписки по умолчанию – false |
| skip_triggers | bool | true | Нет | Пропустить запуск триггеров по умолчанию – false |
| detect_geo | bool | true | Нет | Заполняет геоданные по IP |
| Поиск профиля подписчика для обновления | ||||
| matching | string | "email" | Нет, если поиск по email из профиля или подписок | Режим поиска подписчика. |
| string | "john@example.com" | "matching":"email" - по профилю и подпискам "matching":"email_profile" - только по профилю | Email-адрес. Email должен присутствовать в элементе массива data. | |
| phone | string | "+79000000000" | "matching":"phone" | Номер телефона. Телефон должен присутствовать в элементе массива data. |
| field_name | string | "CRM_ID" | "matching":"custom" | Название кастомного поля профиля для поиска. Данное поле должно присутствовать в элементе массива data. |
| resource_id | int | 24 | Нет | Идентификатор ресурса для |
Пример запроса JSON
{
"data": [
{
"_fname": "John",
"_lname": "Doe",
"custom_id": "abcdefghijklmnqrstuvwxyz",
"email": "jane@example.com",
"subscriptions": [
{
"channel": "email",
"email_data": {
"email": "john@example.com"
},
"resource_id": 1
}
]
}
],
"db_id": 1,
"matching": "custom",
"field_name": "custom_id",
"skip_triggers": true,
"detect_geo": true,
"token": "abcdefghijklmnqrstuvwxyz"
}
Пример ответа JSON
{
"error": 0,
"error_text": "Successful operation",
"result": [
{
"error": 0,
"error_text": "Successful operation",
"profile_id": "abcdefghijklmnqrstuvwxyz"
}
]
}
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки, для всего запроса |
| error_text | string | Текст ошибки, для всего запроса |
| result | array of object | Результаты обновления по профилям Порядок объектов в возвращаемом массиве |
| result.error | int | Код ошибки, для профиля |
| result.error_text | string | Текст ошибки, для профиля |
| result.profile_id | string | Идентификатор профиля |