Skip to main content
POST
Create category
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Body

application/json
name
string
required

Unique among sibling categories, ignoring case.

Maximum string length: 120
Example:

"Billing"

description
string
Example:

"Invoices and payments"

is_private
boolean
default:false

Private categories are hidden from logged-out visitors only.

parent_id
string

Parent category UUID or slug. Leave it out to create a top-level category.

position
integer

1-based position among its siblings. A number larger than the sibling count puts the category last.

Required range: x >= 1

Response

Created - Category created

category
object