The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

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.

NameTypeDescription
namestringRequired. Name 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 (/).
parentIdstringTagId 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.
tagsstringA 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.
StatusNameTypeDescription
201  Response includes the newly created 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. 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.