Skip to main content
PATCH
PATCH /v1/tags/{id}

Update a Tag

Update a tag’s properties using JSON Merge Patch. You can update by ID or by fully qualified name.

Update by ID

id
string
required
UUID of the tag to update.

Update by Name

Use PATCH /v1/tags/name/{fqn} to update by fully qualified name.
fqn
string
required
Fully qualified name of the tag (e.g., Certification.Bronze).

Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.
description
string
Updated description in Markdown format.
displayName
string
Updated display name.
style
object
Updated visual styling.
owners
array
Updated list of owner references.
PATCH /v1/tags/{id}

Returns

Returns the updated tag object with the new version number.

Response

id
string
Unique identifier for the tag (UUID format).
name
string
Tag name.
fullyQualifiedName
string
Fully qualified name of the tag.
description
string
Updated description.
version
number
Incremented version number.

Error Handling