Update a help collection

Patch a help collection's name, slug, description, icon, or color. Only present fields are applied.

Updates a help collection. 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.

This endpoint sets values — it cannot clear them. Passing null for a field is treated the same as omitting it, so there is no way to unset description, icon, or color via the API.

Endpoint

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

Arguments

body

api_keystring

Required

Your organization's public API key. See Authentication.

body

collection_idstring

Required

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

body

namestring

New display name. 1–512 characters.

body

slugstring

New URL-safe identifier. Unlike create, a slug already in use is rejected with 400 rather than auto-suffixed — a rename means that exact slug. 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.

Changing a collection's slug changes the public URL of every article inside it — help center URLs are built as /help/{collection_slug}/{category_slug?}/{article_slug}. Existing links to those articles will break.

Returns

{ "success": true }

Example request

curl -X POST https://api.productbridge.io/api/external/v1/help-collections/update \
  -H 'Content-Type: application/json' \
  -d '{
    "api_key": "pb_YOUR_PUBLIC_API_KEY",
    "collection_id": "553c3ef8-b8cd-cd15-01ba-12bb12bb12bb",
    "name": "Billing, Plans & Invoices",
    "color": "#4E938A"
  }'

const res = await fetch(
  "https://api.productbridge.io/api/external/v1/help-collections/update",
  {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({
      api_key: process.env.PRODUCTBRIDGE_API_KEY,
      collection_id: "553c3ef8-b8cd-cd15-01ba-12bb12bb12bb",
      name: "Billing, Plans & Invoices",
      color: "#4E938A",
    }),
  }
);
if (!res.ok) throw new Error(`HTTP ${res.status}`);

import os, httpx

resp = httpx.post(
    "https://api.productbridge.io/api/external/v1/help-collections/update",
    json={
        "api_key": os.environ["PRODUCTBRIDGE_API_KEY"],
        "collection_id": "553c3ef8-b8cd-cd15-01ba-12bb12bb12bb",
        "name": "Billing, Plans & Invoices",
        "color": "#4E938A",
    },
)
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 collection 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 collection not found"}}`	No such collection, or it belongs to another organization.
`422`	Validation error envelope	`collection_id` is 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?