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

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

# Soft delete by ID
Classifications.delete("06d90883-6be9-4f7e-9475-753f10a95e94")

# Hard delete
Classifications.delete(
    "06d90883-6be9-4f7e-9475-753f10a95e94",
    hard_delete=True
)

# Delete by name
Classifications.delete_by_name("Certification")

# Restore a soft-deleted classification
Classifications.restore("06d90883-6be9-4f7e-9475-753f10a95e94")
{
  "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
  "name": "Certification",
  "fullyQualifiedName": "Certification",
  "description": "Certifying Data Asset will provide the users with a clear idea of...",
  "version": 0.2,
  "updatedAt": 1769982619610,
  "updatedBy": "admin",
  "deleted": true,
  "owners": [],
  "provider": "system",
  "mutuallyExclusive": true
}

Delete a Classification

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

Delete by ID

id
string
required
UUID of the classification to delete.
recursive
boolean
default:"false"
Recursively delete all tags within this classification.
hardDelete
boolean
default:"false"
Permanently delete the classification. If false, the classification is soft-deleted and can be restored.

Delete by Name

Use DELETE /v1/classifications/name/{fqn} to delete by fully qualified name.
fqn
string
required
Fully qualified name of the classification (e.g., Certification).
recursive
boolean
default:"false"
Recursively delete all tags.
hardDelete
boolean
default:"false"
Permanently delete the classification.

Restore a Soft-Deleted Classification

Use PUT /v1/classifications/restore to restore a soft-deleted classification.
id
string
required
UUID of the soft-deleted classification to restore.
DELETE /v1/classifications/{id}
from metadata.sdk import configure
from metadata.sdk.entities import Classifications

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

# Soft delete by ID
Classifications.delete("06d90883-6be9-4f7e-9475-753f10a95e94")

# Hard delete
Classifications.delete(
    "06d90883-6be9-4f7e-9475-753f10a95e94",
    hard_delete=True
)

# Delete by name
Classifications.delete_by_name("Certification")

# Restore a soft-deleted classification
Classifications.restore("06d90883-6be9-4f7e-9475-753f10a95e94")
{
  "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
  "name": "Certification",
  "fullyQualifiedName": "Certification",
  "description": "Certifying Data Asset will provide the users with a clear idea of...",
  "version": 0.2,
  "updatedAt": 1769982619610,
  "updatedBy": "admin",
  "deleted": true,
  "owners": [],
  "provider": "system",
  "mutuallyExclusive": true
}

Returns

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

Error Handling

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