Skip to main content
POST
Create category

Authorizations

Authorization
string
header
required

Behalf of an Operator. The JWT issued by Talqui Core when an operator signs in. Send as Authorization: Bearer <jwt-token>.

Path Parameters

tenantID
string<uuid>
required

The tenant the help center belongs to.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
categoryTitle
string
required
Required string length: 1 - 200
categoryDescription
string
Maximum string length: 2000
categoryIconUrl
string<uri> | null
categoryOrder
integer
Required range: 0 <= x <= 10000
categorySlug
string

Derived from the title when omitted.

Required string length: 1 - 160
categoryStatus
enum<string>

Defaults to draft — nothing goes public by accident.

Available options:
draft,
published

Response

Response for status 201.

category
object
required