Skip to navigation
Developer ReferenceAPI ReferenceStyle AgentTerminology

Update Category Type

Update a category type. Omitted fields are left unchanged.

Returns 404 if the type does not exist in this organization.

Authentication

AuthorizationBearer

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

Path parameters

category_type_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
namestring or nullOptional<=255 characters
displaynamestring or nullOptional<=255 characters
hierarchicalboolean or nullOptional
closedboolean or nullOptional
relationtypeinteger or nullOptional

How many categories of this type one term may carry: 0 at least one, 1 zero or more, 2 exactly one, 3 at most one.

membershaveseparatedisplaynameboolean or nullOptional

Response

Successful Response
idstringformat: "uuid"
Identifier used by this API.
namestring

Unique name; ACTIF documents refer to it.

displaynamestring
hierarchicalboolean
systemboolean

Built-in types cannot be renamed or deleted.

closedboolean
relationtypeinteger

How many categories of this type one term may carry: 0 at least one, 1 zero or more, 2 exactly one, 3 at most one.

membershaveseparatedisplaynameboolean
uuidstring
Stable identifier carried over from Acrolinx terminology.
external_idstring

External identifier; built-in types use the Acrolinx system identifier, for example com.acrolinx.api.category.SystemCategoryTypeIdentifier.DOMAIN.

category_countintegerOptionalDefaults to 0
Number of categories of this type.

Errors

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