Update a help category

Patch a help category's fields, or move it to a different collection. Only present fields are applied.

Updates a help category. The endpoint is patch-style: any subset of the optional body fields may be present, and only those fields are applied. Omitted fields keep their current values.

Passing collection_id moves the category to that collection, taking its articles with it.

Endpoint

POST https://api.productbridge.io/api/external/v1/help-categories/update

Arguments

body

api_keystring

Required

Your organization's public API key. See Authentication.

body

category_idstring

Required

UUID of the category to update. Must belong to your organization.

body

collection_idstring

Move the category to this collection. Must belong to your organization. Omit to leave the parent unchanged.

body

namestring

New display name. 1–512 characters.

body

slugstring

New URL-safe identifier. A slug already in use is rejected with 400 rather than auto-suffixed. Max 512 characters.

body

descriptionstring

New supporting text. Max 512 characters.

body

iconstring

New icon identifier. Max 512 characters.

body

colorstring

New hex color string. Max 50 characters.

Moving a category or changing its slug changes the public URL of every article inside it. Existing links to those articles will break.

Returns

{ "success": true }

Example request

Moving a category to a different collection:

curl -X POST https://api.productbridge.io/api/external/v1/help-categories/update \
  -H 'Content-Type: application/json' \
  -d '{
    "api_key": "pb_YOUR_PUBLIC_API_KEY",
    "category_id": "884c3ef8-b8cd-cd15-01ba-44bb44bb44bb",
    "collection_id": "773c3ef8-b8cd-cd15-01ba-99bb99bb99bb",
    "name": "Account & Security"
  }'

const res = await fetch(
  "https://api.productbridge.io/api/external/v1/help-categories/update",
  {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      api_key: process.env.PRODUCTBRIDGE_API_KEY,
      category_id: "884c3ef8-b8cd-cd15-01ba-44bb44bb44bb",
      collection_id: "773c3ef8-b8cd-cd15-01ba-99bb99bb99bb",
      name: "Account & Security",
    }),
  }
);
if (!res.ok) throw new Error(`HTTP ${res.status}`);

import os, httpx

resp = httpx.post(
    "https://api.productbridge.io/api/external/v1/help-categories/update",
    json={
        "api_key": os.environ["PRODUCTBRIDGE_API_KEY"],
        "category_id": "884c3ef8-b8cd-cd15-01ba-44bb44bb44bb",
        "collection_id": "773c3ef8-b8cd-cd15-01ba-99bb99bb99bb",
        "name": "Account & Security",
    },
)
resp.raise_for_status()

Example response

{
  "success": true
}

Errors

Status	Body	Cause
`400`	`{"detail":"Slug already exists"}`	The explicit `slug` is already used by another category in your organization.
`401`	`{"detail":{"error":"invalid api_key"}}`	Missing / unknown / inactive `api_key`.
`403`	`{"detail":{"error":"The Help Center is not enabled on your current plan..."}}`	Your plan does not include the `knowledgebase` feature.
`404`	`{"detail":{"error":"help category not found"}}`	No such category, or it belongs to another organization.
`404`	`{"detail":{"error":"help collection not found"}}`	The target `collection_id` doesn't exist, or belongs to another organization.
`422`	Validation error envelope	`category_id` missing or not a valid UUID, or a field has the wrong type.

See Errors for the full envelope shape and a recommended client-side handler.

Was this page helpful?