POST /hub/v1/nestedtags
Creates a tag that can be associated with any object that accepts tagging. The tag must contain a unique name. The tag can contain a description and a list of one or more nested tags.
Name | Type | Description |
---|---|---|
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 (/). |
parentId | string | TagId that you want to be the parent of this tag. If you don’t provide a parentId, or if you specify zero as the parentId, the tag is created as a root tag with no parent. |
tags | string | A list of tags to create as nested tags. To include no nested tags, omit this field. You can add and modify nested tags using the Update Nested Tags or Patch Nested Tags requests. |
Status | Name | Type | Description |
---|---|---|---|
201 | Response includes the newly created 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. Add and modify nested tags using the Update Nested Tags or Patch Nested Tags requests. |
This example creates a tag using only a name.
The response includes information about the tag.
This example creates a parent tag with nested tags.
The response includes information about the primary tag and the nested tags.
This example adds a new nested tag under an existing tag.
The response includes information about the nested tag.