Create or update a help center category

POST

/api/v1/help-center/categories

Create a category, or update an existing one by passing its categoryId.

Notes

• category.websiteId must be set in the body as well as in the x-website-id header
• The URL slug is derived from the name and kept unique within the workspace. An existing category keeps its slug across a rename so published URLs stay stable; pass slug explicitly to override
• Changes only reach visitors after POST /api/v1/help-center/publish
• Deleting a category is not available with an API key, only from the dashboard

Parameters

Header Parameters

x-api-key

required

string

Your API key from account settings.

x-user-email

required

string

The email address of your user.

x-account-id

required

string

The ID of your account. You can find this in the account settings.

x-website-id

required

string

The ID of the workspace you want to use.

Request Body ^required

object

category

required

object

categoryId

ID of an existing category to update. Omit to create a new one.

string

name

required

string

websiteId

required

string

description

string

nullable

order

Sort position. Defaults to 0.

number

slug

URL slug. Derived from the name when omitted.

string

translationContext

string

nullable

Example

{
  "category": {
    "name": "Billing",
    "websiteId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "description": "Invoices, plans and payment questions.",
    "order": 1
  }
}

Responses

200

The stored category.

400

Bad request - missing websiteId, category name or category websiteId.

401

Unauthorized - invalid API key.