Присвоение тегов

Обновлено: 20 января 2025

Для запроса на присвоение тега существующему получателю используется метод api/subscribers/tags/set.

к сведению

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

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

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

Чтобы вызвать метод api/subscribers/tags/set, отправьте POST-запрос на URL-адрес https://app.edna.by/api/subscribers/tags/set.

Если запрос выполнен успешно, метод возвращает ответ с кодом 200.

Формат тела запроса

{
    "tag": {
        "name": "best_user"
    },
    "subscribers": [
        {
            "address": "test12345",
            "type": "EXT_USER_ID"
        }
    ]
}

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

Параметр	Тип	Описание
tag	object	Объект тега.
tag.name	string	Название тега получателя.
subscribers	array of strings	Массив идентификаторов получателя.
subscribers.address	string	Уникальный идентификатор получателя, указанный в качестве значения параметра EXT_USER_ID при создании получателя.
subscribers.type	string	Тип идентификатора. Значение — EXT_USER_ID.

Пример ответа

[
    {
        "id": 66402870,
        "blacklisted": false,
        "addresses": [
            {
                "id": "09c2dc23-715e-4cde-8034-8ddfac6d91b5",
                "address": "test12345"
            }
        ],
        "parameterValues": [],
        "tagValues": [
            {
                "name": "best_user"
            }
        ]
    }
]

Ошибки

400 (Constraint Violation) — ошибка валидации. Возможные комментарии:

• address cannot be null or blank — Уникальный идентификатор получателя не должен быть пустым.
• must not be blank — Параметр не должен быть пустым.
• size must be between 1 and 64 — Количество символов в названии тега превышает значение 64.