Skip to Content
MosaicMosaicDocs
Tool Reference

DeleteTag

Permanently delete a tag from the user's personal set or their team's shared set.

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

DeleteTag

Permanently delete a tag from the user's personal set or their team's shared set. This removes the tag from every item it is currently applied to, so it is destructive and cannot be undone — confirm with the user first. Both ids come from a ListTags result: id is the tag's option id, and property_definition_id is the propertyDefinitionId of the set that contains it. To simply remove a tag from a single item without deleting the tag itself, use SetEntityProperty with remove_option_ids 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).

On this page