Skip to main content
PATCH
/
v1
/
tags
/
{id}
PATCH /v1/tags/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Tags

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
tag = Tags.retrieve("68ec158c-5f5e-4277-8a19-5e9e0cd5294f")
tag.description = "Updated: Bronze level certification for data assets"
tag.style = {"color": "#D4A017"}
updated = Tags.update(tag)

print(f"Updated to version {updated.version}")

{
  "id": "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
  "name": "Bronze",
  "fullyQualifiedName": "Certification.Bronze",
  "description": "Updated: Bronze level certification for data assets",
  "style": {
    "color": "#D4A017"
  },
  "version": 0.2,
  "updatedAt": 1769982619666,
  "updatedBy": "admin",
  "classification": {
    "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
    "type": "classification",
    "name": "Certification",
    "fullyQualifiedName": "Certification",
    "deleted": false
  },
  "deleted": false,
  "owners": [],
  "provider": "system",
  "mutuallyExclusive": false
}

​
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}
from metadata.sdk import configure
from metadata.sdk.entities import Tags

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
tag = Tags.retrieve("68ec158c-5f5e-4277-8a19-5e9e0cd5294f")
tag.description = "Updated: Bronze level certification for data assets"
tag.style = {"color": "#D4A017"}
updated = Tags.update(tag)

print(f"Updated to version {updated.version}")

{
  "id": "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
  "name": "Bronze",
  "fullyQualifiedName": "Certification.Bronze",
  "description": "Updated: Bronze level certification for data assets",
  "style": {
    "color": "#D4A017"
  },
  "version": 0.2,
  "updatedAt": 1769982619666,
  "updatedBy": "admin",
  "classification": {
    "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
    "type": "classification",
    "name": "Certification",
    "fullyQualifiedName": "Certification",
    "deleted": false
  },
  "deleted": false,
  "owners": [],
  "provider": "system",
  "mutuallyExclusive": false
}

​
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

CodeError TypeDescription
400BAD_REQUESTInvalid JSON patch or malformed request
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to update this tag
404NOT_FOUNDTag with given ID or FQN does not exist
409CONFLICTConcurrent modification detected