Skip to navigation
Developer ReferenceAPI ReferenceStyle AgentTerminology

Update Category

Update a category. Omitted fields are left unchanged.

Renaming a category changes how terms, searches and ACTIF documents refer to it; publish afterwards for checks to pick up the change. Returns 404 if the category does not exist in this organization.

Authentication

AuthorizationBearer

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

Path parameters

category_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
namestring or nullOptional<=255 characters
displaynamestring or nullOptional<=255 characters
parentstring or nullOptionalformat: "uuid"
priorityinteger or nullOptional

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