Skip to main content
PATCH
Update 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.

Path Parameters

id
string
required

Category UUID or slug.

Body

application/json
name
string

Unique among sibling categories, ignoring case.

Maximum string length: 120
description
string
is_private
boolean

Also applies to the subcategories.

parent_id
string

New parent category UUID or slug. An empty string moves the category to the top level. Leave it out to keep the parent.

position
integer

1-based position among its siblings.

Required range: x >= 1

Response

OK - Request succeeded

category
object