Skip to main content
POST
POST /v1/classifications

Create a Classification

Create a new classification for organizing tags into categories.

Body Parameters

name
string
required
Name of the classification. Must be unique.
displayName
string
Human-readable display name for the classification.
description
string
Description of the classification in Markdown format.
mutuallyExclusive
boolean
default:"false"
If true, only one tag from this classification can be applied to an entity at a time.
owners
array
Array of owner references (users or teams) to assign to the classification.
provider
string
Provider of the classification: user (custom) or system (built-in).
POST /v1/classifications

Returns

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

Response

id
string
Unique identifier for the classification (UUID format).
name
string
Classification name.
fullyQualifiedName
string
Fully qualified name of the classification.
displayName
string
Human-readable display name.
description
string
Description of the classification in Markdown format.
mutuallyExclusive
boolean
Whether tags in this classification are mutually exclusive.
provider
string
Provider of the classification: user or system.
owners
array
List of owners assigned to the classification.
version
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.
PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead.

Error Handling