Skip to main content
PATCH
Update Tag

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Path Parameters

tagId
string<uuid>
required

Tag ID

Body

application/json
name
string

Tag name

Required string length: 1 - 100
description
string | null

Tag description (set to null to clear)

Maximum string length: 500
parent_id
string<uuid> | null

Parent tag ID (set to null to convert to root tag)

color
string | null

Hex color code (e.g., #FF5733)

Pattern: ^#[0-9A-Fa-f]{6}$
asset_types
string[] | null

Asset type names this tag is constrained to (null to clear constraints)

Response

Default Response

id
string<uuid>
required

Tag unique identifier

name
string
required

Tag name

is_system
boolean
required

Whether this is a system-managed tag

created_at
string<date-time>
required

Creation timestamp

updated_at
string<date-time>
required

Last update timestamp

created_by
string<uuid>
required

User ID who created the tag

updated_by
string<uuid>
required

User ID who last updated the tag

description
string | null

Optional description for the tag

parent_id
string<uuid> | null

Parent tag ID (null for root tags)

color
string | null

Hex color code (e.g., #FF5733)

Pattern: ^#[0-9A-Fa-f]{6}$
restricted
boolean

When true, only users/groups in the tag access grants can see assets carrying this tag

asset_types
string[]

Asset type names this tag is constrained to (empty = applies to all)

deleted_at
string<date-time> | null

Deletion timestamp (soft delete)