Skip to main content
DELETE
https://sandbox.getcollate.io/api
/
v1
/
glossaryTerms
/
{id}
DELETE /v1/glossaryTerms/{id}
from metadata.sdk import configure
from metadata.sdk.entities import GlossaryTerms

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

# Soft delete by ID
GlossaryTerms.delete("d3a50b09-g258-7h57-defg-42g1d5517ed4")

# Hard delete
GlossaryTerms.delete(
    "d3a50b09-g258-7h57-defg-42g1d5517ed4",
    hard_delete=True
)

# Delete by name
GlossaryTerms.delete_by_name("BusinessGlossary.Revenue")

# Restore a soft-deleted glossary term
GlossaryTerms.restore("d3a50b09-g258-7h57-defg-42g1d5517ed4")

{
  "id": "d3a50b09-g258-7h57-defg-42g1d5517ed4",
  "name": "Revenue",
  "fullyQualifiedName": "BusinessGlossary.Revenue",
  "description": "Total income generated from business operations",
  "synonyms": ["Income", "Earnings", "Sales"],
  "glossary": {
    "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    "type": "glossary",
    "name": "BusinessGlossary",
    "fullyQualifiedName": "BusinessGlossary"
  },
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "deleted": true,
  "owners": [],
  "tags": [],
  "children": []
}

​
Delete a Glossary Term

Delete a glossary term by ID or fully qualified name. Supports soft delete (default), hard delete, and restore operations.

​
Delete by ID

​
id
string
required
UUID of the glossary term to delete.
​
recursive
boolean
default:"false"
Recursively delete child glossary terms.
​
hardDelete
boolean
default:"false"
Permanently delete the glossary term. If false, the glossary term is soft-deleted and can be restored.

​
Delete by Name

Use DELETE /v1/glossaryTerms/name/{fqn} to delete by fully qualified name.
​
fqn
string
required
Fully qualified name of the glossary term (e.g., BusinessGlossary.Revenue).
​
recursive
boolean
default:"false"
Recursively delete child glossary terms.
​
hardDelete
boolean
default:"false"
Permanently delete the glossary term.

​
Restore a Soft-Deleted Glossary Term

Use PUT /v1/glossaryTerms/restore to restore a soft-deleted glossary term.
​
id
string
required
UUID of the soft-deleted glossary term to restore.
DELETE /v1/glossaryTerms/{id}
from metadata.sdk import configure
from metadata.sdk.entities import GlossaryTerms

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

# Soft delete by ID
GlossaryTerms.delete("d3a50b09-g258-7h57-defg-42g1d5517ed4")

# Hard delete
GlossaryTerms.delete(
    "d3a50b09-g258-7h57-defg-42g1d5517ed4",
    hard_delete=True
)

# Delete by name
GlossaryTerms.delete_by_name("BusinessGlossary.Revenue")

# Restore a soft-deleted glossary term
GlossaryTerms.restore("d3a50b09-g258-7h57-defg-42g1d5517ed4")

{
  "id": "d3a50b09-g258-7h57-defg-42g1d5517ed4",
  "name": "Revenue",
  "fullyQualifiedName": "BusinessGlossary.Revenue",
  "description": "Total income generated from business operations",
  "synonyms": ["Income", "Earnings", "Sales"],
  "glossary": {
    "id": "c2940a98-f147-6g46-cdef-31f0c4406dc3",
    "type": "glossary",
    "name": "BusinessGlossary",
    "fullyQualifiedName": "BusinessGlossary"
  },
  "version": 0.2,
  "updatedAt": 1769984330261,
  "updatedBy": "admin",
  "deleted": true,
  "owners": [],
  "tags": [],
  "children": []
}

​
Returns

Soft delete returns the glossary term object with deleted: true. Hard delete returns no content (204). Restore returns the restored glossary term object.

​
Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to delete this glossary term
404NOT_FOUNDGlossary term with given ID or FQN does not exist