Создание получателей

Обновлено: 30 сентября 2024

Для запроса на создание получателя рассылок используется метод api/subscribers/create.

Вызов метода api/subscribers/create

Чтобы вызвать метод api/subscribers/create, отправьте POST-запрос на URL-адрес https://app.edna.by/api/subscribers/create.

Если запрос выполнен успешно, метод возвращает ответ с кодом 200 и создается получатель рассылок с внешним идентификатором EXT_USER_ID. Если запрос выполнен неуспешно, метод возвращает код ошибки.

Формат тела запроса

{
    "blacklisted": false,
    "addresses": [
        {
            "address": "79991234567",
            "type": "PHONE"
        },
        {
            "address": "any_string",
            "type": "EXT_USER_ID"
        }
    ],
    "parameterValues": [
        {
            "name": "Имя",
            "valueType": "STRING",
            "value": "Иван"
        },
        {
            "name": "Фамилия",
            "valueType": "STRING",
            "value": "Иванов"
        },
        {
            "name": "Отчество",
            "valueType": "STRING",
            "value": "Иванович"
        },
        {
            "name": "Пол",
            "valueType": "ENUM",
            "value": "MALE"
        },
        {
            "name": "Город",
            "valueType": "STRING",
            "value": "Москва"
        },
        {
            "name": "День рождения",
            "valueType": "DATE",
            "value": "1999-12-29"
        }
    ],
    "tagValues": [
        {
            "name": "новый_тег"
        }
    ]
}

Пример отправки запроса через curl

curl --location --request POST 'https://app.edna.by/api/subscribers/create' \
--header 'Content-Type: application/json' \
--header 'x-api-key: your_secret_key' \
--data-raw '{
    "your",
    "pretty",
    "json"
}'

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

Параметр	Тип данных	Описание
blacklisted	boolean	Определяет, будет ли получатель исключен из рассылок. Возможные значения: - true — получатель находится в черном списке и не может принимать рассылки; - false — получатель может принимать рассылки.
addresses	array of strings	Массив адресов или идентификаторов получателя.
addresses.address	string	Уникальный идентификатор получателя. Например, укажите номер телефона получателя, внутренний идентификатор, UUID. Идентификатор необходим для редактирования и удаления получателей.
addresses.type	string	Тип идентификатора получателя. Значения указываются в верхнем регистре. Для использования метода api/subscribers/create укажите идентификатор типа EXT_USER_ID. Возможные значения: - INSTAGRAM_ID - FACEBOOK_ID - DEVICE_APP_ID - PHONE - EMAIL - UTM - COOKIE_ID - TELEGRAM_ID - GOOGLE_ID - APPLE_ID - YANDEX_ID - EXT_USER_ID
parameterValues	array of strings	Массив параметров.
parameterValues.name	string	Название параметра получателя.
parameterValues.valueType	string	Тип параметра получателя: STRING, ENUM, DATE
parameterValues.value	string	Значение параметра получателя.
tagValues	array of strings	Массив тегов получателя.
tagValues.name	string	Название предварительно созданного тега получателя.