Adding tags to a single entity

This method allows updating tags of a single entity. An object should be passed.

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

  • embedded[tags]

array|null

Added tags data. 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

    {
        "_embedded": {
            "tags": [
                {
                    "id": 263807
                }
            ]
        }
    }

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 updated entity object.

Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here!