Skip to navigation
Developer ReferenceAPI ReferenceStyle AgentTerminology

Create Category Type

Create a category type.

Returns 409 if a type with the same name already exists.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
namestringRequired<=255 characters
Unique name of the type within the organization.
displaynamestringRequired<=255 characters
Name shown to users.
hierarchicalbooleanOptionalDefaults to true
Whether categories of this type can be nested under a parent.
systembooleanOptionalDefaults to false

Marks a built-in type, which cannot be renamed or deleted.

closedbooleanOptionalDefaults to false

Whether new top-level categories are blocked for this type.

relationtypeintegerOptionalDefaults to 0

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.

membershaveseparatedisplaynamebooleanOptionalDefaults to true
Whether this type's categories may have a display name that differs from their name.

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