Help collections
Collections are the top level of your Help Center. Use the API to list, retrieve, create, update, and delete them.
A collection is the top level of your Help Center — a broad topic area such as "Getting Started" or "Billing" that users see first on your help center home page. Collections hold categories, and categories hold articles.
An article can be filed either inside a category or directly inside a collection, so a standalone topic doesn't need a category of its own.
Every Help Center endpoint requires the knowledgebase feature on your plan — reads included, not just writes. Calls from an organization without it return 403. This is stricter than the dashboard, which keeps reads available after a downgrade.
The help collection object
A unique identifier for the collection (UUID).
The display name shown on your help center home page.
URL-safe identifier, unique within your organization. Forms the first segment of an article's public URL: /help/{collection_slug}/...
Optional supporting text shown beneath the collection name. May be null.
Optional icon identifier rendered next to the collection. May be null.
Optional hex color string (e.g. "#4E938A") used as an accent. May be null.
The collection's position in the curated order, as a decimal string. Read-only — see Ordering below.
How many active categories this collection contains.
ISO 8601 timestamp at which the collection was created.
ISO 8601 timestamp of the most recent change.
Example help collection object
{
"id": "553c3ef8-b8cd-cd15-01ba-12bb12bb12bb",
"name": "Getting Started",
"slug": "getting-started",
"description": "Set up your account and learn the basics.",
"icon": "rocket",
"color": "#4E938A",
"seq_number": "1000.0000",
"category_count": 4,
"created_at": "2026-08-01T10:12:00",
"updated_at": "2026-08-04T09:30:00"
}
Slugs
Every collection has a slug that is unique within your organization. Omit slug when creating and one is derived from name; if that slug is already taken, a unique suffix is appended automatically so creation never fails on a collision.
Updating behaves differently: an explicit slug that is already in use is rejected with 400 rather than silently suffixed, because a caller renaming a slug means that exact slug.
Deleting a collection frees its slug for reuse.
Ordering
seq_number controls the order collections appear in on your help center, and is read-only through the API. New collections are appended to the end.
Reordering is a dashboard-only operation: it uses drag-and-drop, whose contract is "place this item between these two neighbours", which assumes the caller can already see the list. Reorder collections in the ProductBridge dashboard under Help Center.
Deleting
Deletes are soft and cascade downward. Deleting a collection also soft-deletes its categories and every article inside them. Nothing is permanently removed, and the freed slugs become available again.
What you can do
Retrieve a collection
Look up a single collection by its UUID, including its category count.
List collections
Page through every collection in your organization, in curated order.
Create a collection
Add a new top-level topic area to your Help Center.
Update a collection
Rename, recolor, or re-slug an existing collection.
Delete a collection
Soft-delete a collection along with its categories and articles.