Массовое добавление профилей в базу данных
Описание
Массовое добавление новых профилей в базу данных.
Список профилей необходимо передать в параметр "data"
. Ответ сервера будет содержать параметр "result"
с результатом добавления, ошибками и идентификаторами добавленных профилей.
предупреждение
В одном запросе не рекомендуется:
- передавать более 10 000 профилей;
- передавать более 10 Мб данных. Можно передавать больший объем в несколько потоков.
URL-адрес
Метод: POST
https://example.com/api/v1.1/profiles/add_batch/
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
data | JSON object | [ | Да | Данные о профилях |
db_id | int | 1 | Да | Идентификатор базы данных |
skip_triggers | bool | true | Нет | Пропустить запуск триггеров (по умолчанию – false) |
skip_invalid_subscriptions | bool | true | Нет | Пропустить невалидные подписки (по умолчанию – false) |
Пример запроса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"db_id": 1,
"skip_triggers": true,
"data": [
{
"_fname": "John",
"_lname": "Doe",
"subscriptions": [
{
"channel": "email",
"email_data": {
"email": "example@example.com"
},
"resource_id": 27
}
]
}
]
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<db_id>1</db_id>
<skip_triggers>true</skip_triggers>
<data array='true'>
<_fname>Fillipp</_fname>
<_lname>Doe</_lname>
<subscriptions array='true'>
<channel>email</channel>
<email_data>
<email>example@example.com</email>
</email_data>
<resource_id>1</resource_id>
</subscriptions>
</data>
</xml>
Пример ответа
- JSON
- XML
{
"error": 0,
"error_text": "Successful operation",
"result": [
{
"error": 0,
"error_text": "Successful operation",
"profile_id": "663a138cee44bb50a67115cd"
}
]
}
<xml>
<error>0</error>
<error_text>Successful operation</error_text>
<xml>
<error>0</error>
<error_text>Successful operation</error_text>
<profile_id>663a138cee44bb50a67115cd</profile_id>
</xml>
</xml>
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
profile_id | string | Идентификатор профиля |