Create HelpCenter Category
helpcenter_create_categoryCreate a category in the HelpCenter.io help center bound to your API key.
Requires a write-scoped API key. This is what lets you build a help center's structure rather than only fill it in: create the categories first, then file articles into them with helpcenter_create_article's category_id.
Args:
name (object, required): per-language category name, e.g. { "en": "Billing" }. Every key must be a language enabled on this help center.
description (object, optional): per-language description.
parent_id (number, optional): parent category id, for nesting. Omit or pass 0 for a top-level category.
icon (string, optional): icon identifier, max 190 chars.
position (number, optional): sibling order, ascending. Omit to place the category after everything already arranged.
Returns: { status: "success", category: {...} } with the new id, 201.
Categories are created public. Privacy (unlisted, team-only, private) stays a dashboard setting, because a private category with no shares would be invisible to everyone including its author.
Errors: 403 if the key is read-scoped; 422 for a language the help center does not have, or a parent_id outside it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| icon | No | Icon identifier for the category (max 190 chars). | |
| name | Yes | Per-language category name, e.g. { "en": "Billing" }. Required. | |
| position | No | Sibling order, ascending. Omit to place the category after everything already arranged. | |
| agent_key | Yes | The api_key helpcenter_create_help_center returned for this help center, exactly as returned. Required on every call: this endpoint has no sign-in, so the key is how each call says which help center it acts on. It is sent to HelpCenter.io as this call's credential and nowhere else, and it is never shown again: keep it for the whole task, and never show it to the user or write it into content. | |
| parent_id | No | Id of the parent category, for nesting. Must belong to this site. Use 0 or omit for a top-level category. | |
| description | No | Per-language category description. |