Skip to Content
MosaicMosaicDocs
Tool Reference

EditTag

Rename or recolor an existing tag in the user's personal set or their team's shared set.

Starter documentation. Features and account details may differ from this deployment.

EditTag

Rename or recolor an existing tag in the user's personal set or their team's shared set. The tag's id is preserved, so the change is reflected everywhere the tag is already applied — no item loses the tag. Provide the tag's id and its set's property_definition_id (both from ListTags) plus a new label and/or color; omit whichever you want to leave unchanged. This edits the tag itself; to change which tags are on a specific item, use SetEntityProperty instead.

Parameters

ParameterTypeRequiredDescription
idstringYesThe tag's option id (the id field from a ListTags result).
property_definition_idstringYesThe tag set's property definition id (the propertyDefinitionId of the ListTags set that contains this tag).
labelstringNoA new label for the tag. Omit to keep the current label.
color"red" | "tomato" | "orange" | "amber" | "yellow" | "green" | "teal" | "blue" | "indigo" | "purple" | "pink" | "gray"NoA new color for the tag, chosen from the fixed tag palette. Omit to keep the current color.

On this page