Tags

View as Markdown

Tags

Tags are Workspace-level labels that let you classify a profile across multiple dimensions. A profile can have up to 20 tags, while each tag can be assigned to multiple profiles.

Use the Tags endpoints to list, create, update, or delete tags. Use the Profile Tag assignment endpoints to add or remove one existing tag without replacing the profile’s other assignments.

Tag fields

FieldDescription
tag_uuidStable Tag UUID used by Tag and Profile endpoints.
nameWorkspace-unique name. Leading and trailing whitespace is removed; maximum 100 characters.
color_typeInteger color identifier from 1 through 6.

Color types

color_typeColor
1Purple
2Green
3Blue
4Orange
5Red
6Grey

Assign tags while writing a profile

Create profile and Update profile accept an optional tag_uuids array:

  • On create, omit tag_uuids to create the profile without tags.
  • On update, omit it to preserve the profile’s current assignments.
  • On update, send an empty array to remove all current assignments.
  • Tag UUID order is preserved.

Quick update profile does not accept tag_uuids. Use Update profile or the single-assignment endpoints instead.

Profile list items and profile details return tags as an array of { tag_uuid, name, color_type } objects in server order. Profiles without tags return an empty array.