Help Center: Add a new category
gapify_add_categoryCreates a new category in a help center portal, supporting parent and associated categories, locale, slug, and position. Use it to structure portal content into navigable sections.
Instructions
Add a category to a help center portal [Help Center]
POST /api/v1/accounts/{account_id}/portals/{portal_id}/categories
Auth: User API key (header api-access-token).
Body fields: description, locale, name, slug, position, portal_id, account_id, associated_category_id, parent_category_id. Extra fields can be passed via extra_body.
Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Category name | |
| slug | No | Category slug | |
| locale | No | Category locale Example: "en/es" | |
| position | No | Category position in the portal list to sort Example: 0 | |
| portal_id | Yes | portal_id (string) | |
| account_id | Yes | The numeric ID of the account | |
| extra_body | No | Additional JSON body fields to merge into the request (for keys not listed above). | |
| description | No | Category description | |
| parent_category_id | No | To define parent category, e.g product documentation has multiple level features in sales category or in engineering category. Example: 1 | |
| associated_category_id | No | To associate similar categories to each other, e.g same category of product documentation in different languages Example: 1 |