Updating tags

Limitations
The method is available in correspondence to the user rights.

Request parameters

It is important to note that all entity tags should be passed. If already attached tags are not passed, they will be detached from the entity.

Parameter	Data type	Description
id	int	Entity ID
_embedded[tags]	array\|null	Added tags data. Pass 'null' to detach tags from an entity.
_embedded[tags][0]	object	Tag model. Either “id” or “name” parameter is required
_embedded[tags][0][id]	int	Tag ID
_embedded[tags][0][name]	string	Tag name

An example of the request
In the following example we’ll update tags of 2 leads using the /api/v4/leads method.

[
    {
        "id": 167353,
        "_embedded": {
            "tags": [
                {
                    "id": 263807
                }
            ]
        }
    },
    {
        "id": 167355,
        "_embedded": {
            "tags": null
        }
    }
]

Data type header when the request is successful
Content-Type: application/hal+json

Data type header in case of an error
Content-Type: application/problem+json

Response parameters
The method returns an array of updated entities.