Skip to main content
PUT
PUT /v1/classifications

Update a Classification

Create a classification or update it if it already exists, using PUT /v1/classifications with the full request body. Send the complete definition, not just the fields you want to change. To change only some fields, use PATCH with a JSON Patch array and the application/json-patch+json content type, as shown in the PATCH examples below.

Body Parameters

string
required
Name of the classification. Must be unique.
string
Human-readable display name for the classification.
string
required
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.
string
Provider of the classification: user (custom) or system (built-in).
PUT /v1/classifications

Returns

Returns the updated classification object with the new version number.

Response

string
Unique identifier for the classification (UUID format).
string
Classification name.
string
Fully qualified name of the classification.
string
Updated description.
number
Incremented version number.

Error Handling