Skip to navigation
Developer ReferenceAPI ReferenceStyle AgentTerminology

Reorder Categories

Set the display order of all categories of one type in a single call.

Returns 422 unless ordered_ids lists exactly the type’s categories.

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
ordered_idslist of stringsRequired

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