Skip to navigation
Developer ReferenceAPI ReferenceStyle AgentTerminology

Create Category

Create a category, such as a new domain or language.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
typestringRequiredformat: "uuid"
Category type ID
namestringRequired<=255 characters
Name, unique within the type. Terms, searches and ACTIF documents refer to the category by this name.
displaynamestringRequired<=255 characters
Name shown to users.
parentstring or nullOptionalformat: "uuid"
Parent category of the same type, for hierarchical types.
priorityintegerOptionalDefaults to 0

Sort position among its siblings; lower first.

issystembooleanOptionalDefaults to false

Marks a built-in category, which cannot be deleted.

Response

Successful Response
idstringformat: "uuid"
Identifier used by this API.
typestringformat: "uuid"
Category type ID
namestring

Name, unique within the type; for languages, the language code such as en.

displaynamestring
issystemboolean
uuidstring
Stable identifier carried over from Acrolinx terminology.
external_idstring
parentstring or nullOptionalformat: "uuid"
priorityinteger or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error