--> --> --> -->

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

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

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

Чтоб вызвать метод api/subscribers/create, отправьте POST-запрос на URL-адрес https://app.edna.ru/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.ru/api/subscribers/create' \
--header 'Content-Type: application/json' \
--header 'x-api-key: your_secret_key' \
--data-raw '{
    "your",
    "pretty",
    "json"
}'

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

ПараметрТип данныхОписание
blacklistedbooleanОпределяет, будет ли получатель исключен из рассылок.

Возможные значения:
true — получатель находится в черном списке и не может принимать рассылки;
false — получатель может принимать рассылки.
addressesarray of stringsМассив адресов или идентификаторов получателя.
addresses.addressstringУникальный идентификатор получателя. Например, укажите номер телефона получателя, внутренний идентификатор, UUID.

Идентификатор необходим для редактирования и удаления получателей. Подробнее в статьях:
Обновление данных получателя.
Удаление получателя.

Сохраните указанный идентификатор, так как без него редактирование и удаление получателя невозможно.
addresses.typestringТип идентификатора получателя. Значения указываются в верхнем регистре.

Для использования метода 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
parameterValuesarray of stringsМассив параметров.
parameterValues.namestringНазвание параметра получателя.
parameterValues.valueTypestringТип параметра получателя.

Возможные значения:
STRING
ENUM
DATE
parameterValues.valuestringЗначение параметра получателя.
tagValuesarray of stringsМассив тегов получателя.
tagValues.namestringНазвание предварительно созданного тега получателя.
* Деятельность компании Meta запрещена на территории Российской Федерации.