Создание клиента

Используйте метод create, чтобы создать клиента с внешним идентификатором EXT_USER_ID для дальнейшего использования в рассылках. В случае успешного выполнения запроса вернётся ответ от сервера с кодом 200.

URL-адрес подключения

Для использования метода отправьте POST-запрос на https://app.edna.ru/api/subscribers/create.

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

ПараметрТип Описание
blacklistedbooleanОпределяет, будет ли клиент исключён из рассылок. true — клиент в «чёрном списке» и не получает рассылки, false — клиент получает рассылки
addressesarrayМассив адресов/идентификаторов клиента
addressstringНомер телефона клиента
typestringТип идентификатора клиента (PHONE/EDNA_ID)
parameterValuesarrayМассив параметров
namestringНазвание параметра
valueTypestringТип параметра (STRING/ENUM/DATE)
valuestringЗначение параметра
tagValuesarrayМассив тегов
namestringИмя тега (тег должен быть предварительно создан)

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

{
    "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": "новый_тег"
        }
    ]
}
Обратите внимание на этот блок:

{
"address": "any_string",
"type": "EXT_USER_ID"
}


В этом блоке указывается идентификатор, по которому вы сможете обращаться к контакту клиента для его изменения или удаления. В переменной address можно указать любую строку: номер телефона, внутренний идентификатор, UUID и так далее. Важно, чтобы этот идентификатор хранился у вас, иначе изменение или удаление записи будет невозможно.

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

curl --location --request POST 'http: //jsonapi.facade.edna.dte/api/subscribers/create' \
--header 'Content-Type: application/json' \
--header 'x-api-key: your_secret_key' \
--data-raw '{
    "your",
    "pretty",
    "json"
}'
Cледующая статья Обновление данных клиента