Используйте метод create
, чтобы создать получателя с внешним идентификатором EXT_USER_ID
для дальнейшего использования в рассылках. В случае успешного выполнения запроса вернётся ответ от сервера с кодом 200
.
URL-адрес подключения
Для использования метода отправьте POST-запрос на https://app.edna.ru/api/subscribers/create.
Параметры запроса
Параметр | Тип | Описание |
blacklisted | boolean | Определяет, будет ли получатель исключён из рассылок. true — клиент в «чёрном списке» и не получает рассылки, false — клиент получает рассылки. |
addresses | array | Массив адресов/идентификаторов получателя |
address | string | Значение идентификатора получателя |
type | string | Тип идентификатора получателя: Возможные значения (необходимо указывать в верхнем регистре): • INSTAGRAM_ID *• FACEBOOK_ID* • DEVICE_APP_ID • PHONE • EMAIL • UTM • COOKIE_ID • TELEGRAM_ID • GOOGLE_ID • APPLE_ID • YANDEX_ID • EXT_USER_ID Для использования метода необходимо заполнить идентификатор типа EXT_USER_ID. |
parameterValues | array | Массив параметров |
name | string | Название параметра |
valueType | string | Тип параметра (STRING /ENUM /DATE ) |
value | string | Значение параметра |
tagValues | array | Массив тегов |
name | string | Имя тега (тег должен быть предварительно создан) |
Пример запроса
{ "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 'https://app.edna.ru/api/subscribers/create' \ --header 'Content-Type: application/json' \ --header 'x-api-key: your_secret_key' \ --data-raw '{ "your", "pretty", "json" }'
* Деятельность сети запрещена на территории РФ