PUT /v1/glossaryTerms

curl -X PUT "{base_url}/api/v1/glossaryTerms" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Revenue",
    "glossary": "BusinessGlossary",
    "description": "Total income generated from business operations",
    "synonyms": ["Income", "Earnings", "Sales"],
    "owners": []
  }'

from metadata.sdk import configure
from metadata.sdk.entities import GlossaryTerms

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
term = GlossaryTerms.retrieve("d3a50b09-g258-7h57-defg-42g1d5517ed4")
term.description = "Updated: Total income from all business operations before deductions"
term.synonyms = ["Income", "Earnings", "Sales", "Turnover"]
updated = GlossaryTerms.update(term)

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

// client is an initialized OpenMetadataClient.
var termId = "d3a50b09-g258-7h57-defg-42g1d5517ed4";
var term = client.glossaryTerms().get(termId);
term.setDescription("Updated: Total income from all business operations before deductions");

var updated = client.glossaryTerms().update(termId, term);

# Update by ID
curl -X PATCH "{base_url}/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Total income from all business operations before deductions"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/glossaryTerms/name/BusinessGlossary.Revenue" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Total income from all business operations before deductions"}
  ]'

{
  "id": "d3a50b09-g258-7h57-defg-42g1d5517ed4",
  "name": "Revenue",
  "fullyQualifiedName": "BusinessGlossary.Revenue",
  "displayName": "Revenue",
  "description": "Updated: Total income from all business operations before deductions",
  "synonyms": ["Income", "Earnings", "Sales", "Turnover"],
  "glossary": {
    "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    "type": "glossary",
    "name": "BusinessGlossary",
    "fullyQualifiedName": "BusinessGlossary",
    "deleted": false
  },
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4",
  "deleted": false,
  "owners": [],
  "tags": [],
  "children": [],
  "relatedTerms": []
}

PUT

glossaryTerms

PUT /v1/glossaryTerms

curl -X PUT "{base_url}/api/v1/glossaryTerms" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Revenue",
    "glossary": "BusinessGlossary",
    "description": "Total income generated from business operations",
    "synonyms": ["Income", "Earnings", "Sales"],
    "owners": []
  }'

from metadata.sdk import configure
from metadata.sdk.entities import GlossaryTerms

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
term = GlossaryTerms.retrieve("d3a50b09-g258-7h57-defg-42g1d5517ed4")
term.description = "Updated: Total income from all business operations before deductions"
term.synonyms = ["Income", "Earnings", "Sales", "Turnover"]
updated = GlossaryTerms.update(term)

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

// client is an initialized OpenMetadataClient.
var termId = "d3a50b09-g258-7h57-defg-42g1d5517ed4";
var term = client.glossaryTerms().get(termId);
term.setDescription("Updated: Total income from all business operations before deductions");

var updated = client.glossaryTerms().update(termId, term);

# Update by ID
curl -X PATCH "{base_url}/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Total income from all business operations before deductions"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/glossaryTerms/name/BusinessGlossary.Revenue" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Total income from all business operations before deductions"}
  ]'

{
  "id": "d3a50b09-g258-7h57-defg-42g1d5517ed4",
  "name": "Revenue",
  "fullyQualifiedName": "BusinessGlossary.Revenue",
  "displayName": "Revenue",
  "description": "Updated: Total income from all business operations before deductions",
  "synonyms": ["Income", "Earnings", "Sales", "Turnover"],
  "glossary": {
    "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    "type": "glossary",
    "name": "BusinessGlossary",
    "fullyQualifiedName": "BusinessGlossary",
    "deleted": false
  },
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4",
  "deleted": false,
  "owners": [],
  "tags": [],
  "children": [],
  "relatedTerms": []
}

Update a Glossary Term

Create a glossary term or update it if it already exists, using PUT /v1/glossaryTerms 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 glossary term. Must be unique within the parent glossary or parent term.

string

required

Fully qualified name of the parent glossary, for example BusinessGlossary.

string

Human-readable display name for the glossary term.

string

required

Description of the glossary term in Markdown format.

string

Fully qualified name of the parent glossary term for creating nested terms, for example BusinessGlossary.Revenue.

array

Array of synonym strings for this term.

Array of fully qualified names of related glossary terms.

array

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

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

string

Name of the owner entity.

array

Array of classification tags to apply.

Show properties

string

required

Fully qualified name of the tag.

string

Type of label, for example Manual, Derived, Propagated.

string

State of the tag, for example Suggested, Confirmed.

array

Fully qualified names of the domains to assign for governance purposes.

object

Visual styling for the glossary term.

Show properties

string

Hex color code, for example #FF5733.

string

URL to a custom icon for the term.

PUT /v1/glossaryTerms

curl -X PUT "{base_url}/api/v1/glossaryTerms" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Revenue",
    "glossary": "BusinessGlossary",
    "description": "Total income generated from business operations",
    "synonyms": ["Income", "Earnings", "Sales"],
    "owners": []
  }'

from metadata.sdk import configure
from metadata.sdk.entities import GlossaryTerms

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
term = GlossaryTerms.retrieve("d3a50b09-g258-7h57-defg-42g1d5517ed4")
term.description = "Updated: Total income from all business operations before deductions"
term.synonyms = ["Income", "Earnings", "Sales", "Turnover"]
updated = GlossaryTerms.update(term)

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

// client is an initialized OpenMetadataClient.
var termId = "d3a50b09-g258-7h57-defg-42g1d5517ed4";
var term = client.glossaryTerms().get(termId);
term.setDescription("Updated: Total income from all business operations before deductions");

var updated = client.glossaryTerms().update(termId, term);

# Update by ID
curl -X PATCH "{base_url}/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Total income from all business operations before deductions"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/glossaryTerms/name/BusinessGlossary.Revenue" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Total income from all business operations before deductions"}
  ]'

{
  "id": "d3a50b09-g258-7h57-defg-42g1d5517ed4",
  "name": "Revenue",
  "fullyQualifiedName": "BusinessGlossary.Revenue",
  "displayName": "Revenue",
  "description": "Updated: Total income from all business operations before deductions",
  "synonyms": ["Income", "Earnings", "Sales", "Turnover"],
  "glossary": {
    "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    "type": "glossary",
    "name": "BusinessGlossary",
    "fullyQualifiedName": "BusinessGlossary",
    "deleted": false
  },
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/glossaryTerms/d3a50b09-g258-7h57-defg-42g1d5517ed4",
  "deleted": false,
  "owners": [],
  "tags": [],
  "children": [],
  "relatedTerms": []
}

Returns

Returns the updated glossary term object with the new version number.

Response

string

Unique identifier for the glossary term (UUID format).

string

Glossary term name.

string

Fully qualified name of the glossary term.

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 glossary term
`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 Glossary Term

Update a Glossary Term

Body Parameters

Returns

Response

Error Handling