Updates an existing tag. You must provide the entire tag payload because this request modifies the entire tag. To provide only the fields to modify, use the Patch Nested Tags request instead.
| Name | Type | | Description |
|---|
| tagId | number | Required | ID of the tag to update. |
| Name | Type | | Description |
|---|
| id | number | Required | TagId of the tag to update. |
| name | string | Required | Name of the tag, up to 120 characters. The only special characters allowed are period (.) and apostrophe ('). |
| description | string | | Description 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, any existing description is erased. |
| parentId | number | | TagId that you want to be the parent of this tag. If you don’t provide a parentId, the parentId (if non-zero) is replaced by zero, meaning no parent tag. |
| tags | object | | A list of tags to create as nested tags. If you don’t provide a list of tags, any existing tags are removed. |
| Status | Name | Type | Description |
|---|
| 200 | | | Response includes the updated tag and all of its properties, including nested tags at the level specified by the depth parameter. |
| | id | integer | TagId of the tag. |
| | name | string | Name of the tag. |
| | description | string | Description of the tag. |
| | parentId | string | TagId of the parent tag. This field is null or zero if no parent tag exists. |
| | tags | object | A list of the tag’s nested tags. |
This example renames descriptions of all tags nested under a parent tag ID.