Skip to main content
DELETE
https://sandbox.getcollate.io/api
/
v1
/
tags
/
{id}
DELETE /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"
)

# Soft delete by ID
Tags.delete("68ec158c-5f5e-4277-8a19-5e9e0cd5294f")

# Hard delete
Tags.delete(
    "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
    hard_delete=True
)

# Delete by name
Tags.delete_by_name("Certification.Bronze")

# Restore a soft-deleted tag
Tags.restore("68ec158c-5f5e-4277-8a19-5e9e0cd5294f")

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

​
Delete a Tag

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

​
Delete by ID

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

​
Delete by Name

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

​
Restore a Soft-Deleted Tag

Use PUT /v1/tags/restore to restore a soft-deleted tag.
​
id
string
required
UUID of the soft-deleted tag to restore.
DELETE /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"
)

# Soft delete by ID
Tags.delete("68ec158c-5f5e-4277-8a19-5e9e0cd5294f")

# Hard delete
Tags.delete(
    "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
    hard_delete=True
)

# Delete by name
Tags.delete_by_name("Certification.Bronze")

# Restore a soft-deleted tag
Tags.restore("68ec158c-5f5e-4277-8a19-5e9e0cd5294f")

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

​
Returns

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

​
Error Handling

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