Для запроса на обновление данных существующего получателя используется метод api/subscribers/update
.
Чтобы обновить данные получателя, требуется его уникальный идентификатор, указанный в параметре
EXT_USER_ID
при создании. Подробнее в статье. Вызов метода api/subscribers/update
Данные получателя можно обновить полностью или частично:
- Чтобы вызвать метод
api/subscribers/update
для полного обновления данных получателя, отправьте POST-запрос на URL-адресhttps://app.edna.ru/api/subscribers/update
. Будут обновлены все параметры, передаваемые в запросе. - Чтобы вызвать метод
api/subscribers/update
для частичного обновления данных получателя, отправьте PATCH-запрос на URL-адресhttps://app.edna.ru/api/subscribers/update
. Будут обновлены только некоторые параметры, передаваемые в запросе.
Если запрос выполнен успешно, метод возвращает ответ с кодом 200
.
Формат тела запроса
{ "blacklisted": true, "addresses": [ { "address": "79997654321", "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": "FEMALE" }, { "name": "Город", "valueType": "STRING", "value": "Омск" }, { "name": "День рождения", "valueType": "DATE", "value": "1999-12-28" } ], "tagValues": [ { "name": "старый_тег" } ] }
Параметры запроса
Параметр | Тип данных | Описание |
blacklisted | boolean | Определяет, будет ли получатель исключен из рассылок. Возможные значения: • true — получатель находится в черном списке и не может принимать рассылки;• false — получатель может принимать рассылки. |
addresses | array of strings | Массив адресов или идентификаторов получателя. При отправке POST-запроса передавайте полный массив адресов или идентификаторов получателя, так как POST полностью перезаписывает массив. |
addresses.address | string | Уникальный идентификатор получателя. Например, номер телефона или учетная запись. |
addresses.type | string | Тип идентификатора получателя. Значения указываются в верхнем регистре. Для использования метода api/subscribers/update укажите идентификатор типа 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 | Массив параметров получателя. При отправке POST-запроса передавайте полный массив параметров получателя, так как POST полностью перезаписывает массив. |
parameterValues.name | string | Название параметра получателя. |
parameterValues.valueType | string | Тип параметра получателя. Возможные значения: • STRING • ENUM • DATE • NUMBER • BOOLEAN |
parameterValues.value | string | Значение параметра получателя. |
tagValues | array of strings | Массив тегов получателя. При отправке POST-запроса передавайте полный массив тегов получателя, так как POST полностью перезаписывает массив. |
tagValues.name | string | Название предварительно созданного тега получателя. |
* Деятельность компании Meta запрещена на территории Российской Федерации.