POST /v1/classifications

from metadata.sdk import configure
from metadata.sdk.entities import Classifications
from metadata.generated.schema.api.classification.createClassification import CreateClassificationRequest

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

request = CreateClassificationRequest(
    name="Certification",
    description="Certifying Data Asset will provide the users with a clear idea of...",
    mutuallyExclusive=True
)

classification = Classifications.create(request)
print(f"Created: {classification.fullyQualifiedName.root}")

import org.openmetadata.schema.api.classification.CreateClassification;

// client is an initialized OpenMetadataClient.
var request = new CreateClassification()
    .withName("Certification")
    .withDescription("Certifying Data Asset will provide the users with a clear idea of...")
    .withMutuallyExclusive(true);

var classification = client.classifications().create(request);

curl -X POST "{base_url}/api/v1/classifications" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Certification",
    "description": "Certifying Data Asset will provide the users with a clear idea of...",
    "mutuallyExclusive": true,
    "owners": []
  }'

{
  "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.1,
  "updatedAt": 1769982619610,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "provider": "system",
  "mutuallyExclusive": true
}

POST

classifications

POST /v1/classifications

from metadata.sdk import configure
from metadata.sdk.entities import Classifications
from metadata.generated.schema.api.classification.createClassification import CreateClassificationRequest

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

request = CreateClassificationRequest(
    name="Certification",
    description="Certifying Data Asset will provide the users with a clear idea of...",
    mutuallyExclusive=True
)

classification = Classifications.create(request)
print(f"Created: {classification.fullyQualifiedName.root}")

import org.openmetadata.schema.api.classification.CreateClassification;

// client is an initialized OpenMetadataClient.
var request = new CreateClassification()
    .withName("Certification")
    .withDescription("Certifying Data Asset will provide the users with a clear idea of...")
    .withMutuallyExclusive(true);

var classification = client.classifications().create(request);

curl -X POST "{base_url}/api/v1/classifications" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Certification",
    "description": "Certifying Data Asset will provide the users with a clear idea of...",
    "mutuallyExclusive": true,
    "owners": []
  }'

{
  "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.1,
  "updatedAt": 1769982619610,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "provider": "system",
  "mutuallyExclusive": true
}

Create a Classification

Create a new classification for organizing tags into categories.

Body Parameters

string

required

Name of the classification. Must be unique.

string

Human-readable display name for the classification.

string

Description of the classification in Markdown format.

boolean

default:"false"

If true, only one tag from this classification can be applied to an entity at a time.

array

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

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 classification: user (custom) or system (built-in).

POST /v1/classifications

from metadata.sdk import configure
from metadata.sdk.entities import Classifications
from metadata.generated.schema.api.classification.createClassification import CreateClassificationRequest

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

request = CreateClassificationRequest(
    name="Certification",
    description="Certifying Data Asset will provide the users with a clear idea of...",
    mutuallyExclusive=True
)

classification = Classifications.create(request)
print(f"Created: {classification.fullyQualifiedName.root}")

import org.openmetadata.schema.api.classification.CreateClassification;

// client is an initialized OpenMetadataClient.
var request = new CreateClassification()
    .withName("Certification")
    .withDescription("Certifying Data Asset will provide the users with a clear idea of...")
    .withMutuallyExclusive(true);

var classification = client.classifications().create(request);

curl -X POST "{base_url}/api/v1/classifications" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Certification",
    "description": "Certifying Data Asset will provide the users with a clear idea of...",
    "mutuallyExclusive": true,
    "owners": []
  }'

{
  "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.1,
  "updatedAt": 1769982619610,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "provider": "system",
  "mutuallyExclusive": true
}

Returns

Returns the created classification object with all specified properties and system-generated fields.

Response

string

Unique identifier for the classification (UUID format).

string

Classification name.

string

Fully qualified name of the classification.

string

Human-readable display name.

string

Description of the classification in Markdown format.

boolean

Whether tags in this classification are mutually exclusive.

string

Provider of the classification: user or system.

array

List of owners assigned to the classification.

number

Version number for the entity (starts at 0.1).

Create or Update (PUT)

Use PUT /v1/classifications instead of POST to perform an upsert. If a classification with the same fullyQualifiedName already exists, it will be updated; otherwise, a new classification is created. The request body is the same as POST.

curl -X PUT "{base_url}/api/v1/classifications" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'

Note: PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead. However, for certain fields (such as description, tags, owners, and custom properties), PUT preserves an already-populated value instead of overwriting it with an empty or omitted one — the exact behavior depends on the field and the calling user or bot’s permissions, not a blanket rule. See Entity Update Behavior for the full preserve/merge rules. Use PATCH to intentionally replace an existing value.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid request body or missing required fields
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to create classifications
`409`	`ENTITY_ALREADY_EXISTS`	Classification with same name already exists (POST only)

API Reference

SDK

API

Data Assets

AI Assets

Discovery

Lineage

Data Contracts

Teams & Users

Data Governance

Data Quality

Alerts

Incidents

Billing

Query Runner

Context Plugins

Standards

Create a Classification

Create a Classification

Body Parameters

Returns

Response

Create or Update (PUT)

Error Handling