Reorder help center categories

POST

/api/v1/help-center/categories/reorder

Set the sort position of several categories at once.

Notes

• Only the categories you list are touched; the rest keep their order
• Changes only reach visitors after POST /api/v1/help-center/publish

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

items

required

Array<object>

>= 1 items

object

categoryId

required

string

order

required

number

Example

{
  "items": [
    {
      "categoryId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "order": 0
    },
    {
      "categoryId": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy",
      "order": 1
    }
  ]
}

Responses

200

The categories were reordered.

object

success

boolean

400

Bad request - missing websiteId, or an empty items list.

401

Unauthorized - invalid API key.