PATCH /hub/v1/nestedtags/{tagId}

Updates an existing tag. Provide only the tag fields to be changed.

URL Parameters

NameTypeDescription
tagIdnumberRequiredID of the tag to patch.

JSON Parameters

NameTypeDescription
idnumberRequiredTagId of the tag to update.
namestringName of the tag, up to 120 characters. The only special characters allowed are period (.) and apostrophe (').
descriptionstringDescription of the tag, up to 256 characters. The only special characters allowed are period (.), apostrophe ('), comma (,), and forward slash (/). If you don’t provide a description, the existing description is not changed.
parentIdnumberTagId that you want to be the parent of this tag. If you don’t provide a parentId, the parentId is not changed.
tagsobjectA list of tags to create as nested tags. If you don’t provide a list of tags, the existing nested tags are not changed.

Responses

StatusNameTypeDescription
200  Response includes the updated tag and all of its properties, including nested tags at the level specified by the depth parameter.
 idintegerTagId of the tag.
 namestringName of the tag.
 descriptionstringDescription of the tag.
 parentIdstringTagId of the parent tag. This field is null or zero if no parent tag exists.
 tagsobjectA list of the tag’s nested tags.

Example Request

This example patches a nested tag to update its description field.

Example Response

Example Request

This example changes a nested tag into a root tag with no parent.

Example Response