PUT /v1/tags

curl -X PUT "{base_url}/api/v1/tags" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Bronze",
    "classification": "Certification",
    "description": "Bronze certified Data Asset.",
    "style": {"color": "#C08320"},
    "owners": []
  }'

from metadata.sdk import configure
from metadata.sdk.entities import Tags

configure(
    host="https://your-company.open-metadata.org/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.root}")

// client is an initialized OpenMetadataClient.
var tagId = "68ec158c-5f5e-4277-8a19-5e9e0cd5294f";
var tag = client.tags().get(tagId);
tag.setDescription("Updated: Bronze level certification for data assets");

var updated = client.tags().update(tagId, tag);

# Update by ID
curl -X PATCH "{base_url}/api/v1/tags/68ec158c-5f5e-4277-8a19-5e9e0cd5294f" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Bronze level certification for data assets"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/tags/name/Certification.Bronze" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Bronze level certification for data assets"}
  ]'

{
  "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
}

PUT

tags

PUT /v1/tags

curl -X PUT "{base_url}/api/v1/tags" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Bronze",
    "classification": "Certification",
    "description": "Bronze certified Data Asset.",
    "style": {"color": "#C08320"},
    "owners": []
  }'

from metadata.sdk import configure
from metadata.sdk.entities import Tags

configure(
    host="https://your-company.open-metadata.org/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.root}")

// client is an initialized OpenMetadataClient.
var tagId = "68ec158c-5f5e-4277-8a19-5e9e0cd5294f";
var tag = client.tags().get(tagId);
tag.setDescription("Updated: Bronze level certification for data assets");

var updated = client.tags().update(tagId, tag);

# Update by ID
curl -X PATCH "{base_url}/api/v1/tags/68ec158c-5f5e-4277-8a19-5e9e0cd5294f" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Bronze level certification for data assets"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/tags/name/Certification.Bronze" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Bronze level certification for data assets"}
  ]'

{
  "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

Create a tag or update it if it already exists, using PUT /v1/tags with the full request body. Send the complete definition, not just the fields you want to change. To change only some fields, use PATCH with a JSON Patch array and the application/json-patch+json content type, as shown in the PATCH examples below.

Body Parameters

string

required

Name of the tag. Must be unique within the parent classification or parent tag.

string

required

Fully qualified name of the parent classification, for example Certification.

string

Human-readable display name for the tag.

string

required

Description of the tag in Markdown format.

string

Fully qualified name of the parent tag for creating nested tags, for example PII.Sensitive.

object

Visual styling for the tag.

Show properties

string

Hex color code, for example #C08320.

string

URL to a custom icon for the tag.

array

Array of owner references (users or teams) to assign to the tag.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

string

Name of the owner entity.

string

Provider of the tag: user (custom) or system (built-in).

PUT /v1/tags

curl -X PUT "{base_url}/api/v1/tags" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Bronze",
    "classification": "Certification",
    "description": "Bronze certified Data Asset.",
    "style": {"color": "#C08320"},
    "owners": []
  }'

from metadata.sdk import configure
from metadata.sdk.entities import Tags

configure(
    host="https://your-company.open-metadata.org/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.root}")

// client is an initialized OpenMetadataClient.
var tagId = "68ec158c-5f5e-4277-8a19-5e9e0cd5294f";
var tag = client.tags().get(tagId);
tag.setDescription("Updated: Bronze level certification for data assets");

var updated = client.tags().update(tagId, tag);

# Update by ID
curl -X PATCH "{base_url}/api/v1/tags/68ec158c-5f5e-4277-8a19-5e9e0cd5294f" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Bronze level certification for data assets"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/tags/name/Certification.Bronze" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Bronze level certification for data assets"}
  ]'

{
  "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

string

Unique identifier for the tag (UUID format).

string

Tag name.

string

Fully qualified name of the tag.

string

Updated description.

number

Incremented version number.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid or malformed request body
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this tag
`409`	`CONFLICT`	Concurrent modification detected

API Reference

Data Assets

Collaboration

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Update a Tag

Update a Tag

Body Parameters

Returns

Response

Error Handling