Обновление данных получателя

19 августа 2022

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

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

В данном методе допустимо использовать POST и PATCH запросы /api/subscribers/update.

Для перезаписывания всех данных клиента на значения, переданные в запросе, используйте POST-запрос.

Для частичного обновления данных отправьте PATCH-запрос – будут обновлены только те параметры, которые переданы в запросе.

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

ПараметрТип Описание
blacklistedbooleanОпределяет, будет ли получатель исключён из рассылок. true — клиент в «чёрном списке» и не получает рассылки, false — клиент получает рассылки
addressesarrayМассив адресов/идентификаторов получателя

Внимание! При использовании запроса POST в этом массиве необходимо передавать полный массив адресов/идентификаторов получателя, так как POST не добавляет, а полностью перезаписывает весь массив.
addressstringЗначение идентификатора получателя
typestringТип идентификатора получателя:

Возможные значения (необходимо указывать в верхнем регистре):

• 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.
parameterValuesarrayМассив переменных

Внимание! При использовании запроса POST в этом массиве необходимо передавать полный массив переменных получателя, так как POST не добавляет, а полностью перезаписывает весь массив.
namestringНазвание переменной
valueTypestringТип переменной (STRING/ENUM/DATE/NUMBER/BOOLEAN)
valuestringЗначение параметра
tagValuesarrayМассив тегов

Внимание! При использовании запроса POST в этом массиве необходимо передавать полный массив тегов получателя, так как POST не добавляет, а полностью перезаписывает весь массив.
namestringИмя тега

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

{
    "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": "старый_тег"
        }
    ]
}

* Деятельность сети запрещена на территории РФ

In this article
Разделы статьи