Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Current »

Описание

Массовое добавление новых профилей в базу данных.

Список профилей необходимо передать в параметр "data". Ответ сервера будет содержать параметр "result" с результатом добавления, ошибками и идентификаторами добавленных профилей.

URL-адрес

Метод: POST

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

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
dataJSON object
[
    {
        "_fname": "John",
        "_lname": "Doe",
        "subscriptions": [
            {
                "channel": "email",
                "email_data": {
                    "email": "john@example.com"
                },
                "resource_id": 1
            }
        ]
    }
]
ДаДанные о профилях
db_idint1ДаИдентификатор базы данных
skip_triggersbooltrueНетПропустить запуск триггеров
по умолчанию – false
skip_invalid_subscriptionsbooltrueНетПропустить невалидные подписки
по умолчанию – false

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

{
    "data": [
        {
            "_fname": "John",
            "_lname": "Doe",
            "subscriptions": [
                {
                    "channel": "email",
                    "email_data": {
                        "email": "john@example.com"
                    },
                    "resource_id": 1
                }
            ]
        }
    ],
    "db_id": 1,
    "skip_triggers": true,
    "token": "abcdefghijklmnqrstuvwxyz"
}

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

{
    "error": 0,
    "error_text": "Successful operation",
    "result": [
        {
            "error": 0,
            "error_text": "Successful operation",
            "profile_id": "abcdefghijklmnqrstuvwxyz"
        }
    ]
}

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

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