Removing Tags

Last updated: 1 October 2024

The api/subscribers/tags/remove method is used to request the tag to be removed from an existing recipient.

info

To remove a tag from the recipient, its unique identifier is required, specified in the EXT_USER_ID parameter at creation.

Creating Clients

Calling the api/subscribers/tags/remove method

To call the api/subscribers/tags/remove method, send a POST request to the URL https://app.edna.io/api/subscribers/tags/remove

If the request is successful, the method returns a response with the 200 code.

Request Body Format

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

Request Parameters

Parameter	Data type	Description
tag	object	The tag object.
tag.name	string	The name of the recipient's tag.
subscribers	array of strings	An array of recipient IDs.
subscribers.address	string	The unique identifier of the recipient specified as the value of the EXT_USER_ID parameter when creating the recipient.
subscribers.type	string	The ID type. The value is EXT_USER_ID.

Response Example

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