Tag PUT Resources


Update a tag

PUT /tags/:id

Updates can be done partially. The response will be the full and updated resource.

Only users with the contentadmin_ role are allowed to update tags.

Parameter Type Description
tag string Renames the tag, e.g. to correct spelling. The tag must not already exist under a different id (comparison is case insensitive). Max. 255 characters.
excluded_from_suggestions boolean If true, this tag is explicitly excluded from being returned by the /search/tags/suggestions endpoint.

Payload

{
    "tag": "Sherlock",
    "excluded_from_suggestions": true
}

Response

{
    "tag": "Sherlock",
    "id": 27,
    "encounter": 736,
    "image": "https://cdn.example.com/avatar/default/2d/1b84215e2f035a22f6fec213d3b1d9.jpg",
    "excluded_from_suggestions": true,
    "created": "2011-12-12T15:35:25.000Z"
}