Configuration reference: Forum category
A forum category’s settings.
Where it is used: POST /orgs/{orgId}/spaces/{spaceId}/forum/categories and PATCH …/categories/{id}.
JSON Schema: https://forumulate.com/schemas/2026-12-01/forum-category.json — point your editor at it with "$schema": "https://forumulate.com/schemas/2026-12-01/forum-category.json" (JSON) or # yaml-language-server: $schema=https://forumulate.com/schemas/2026-12-01/forum-category.json (YAML), and check a whole folder with forumulate validate <dir>.
This page is generated from the schema the API validates with; it cannot describe a key the API does not take.
Casing
Every key in a JSON or YAML configuration document (site config, theme, forumulate.yaml, a category) is camelCase, exactly:
primaryColor,footerColumns,headerLinks.primary_colorandPrimaryColorare unknown keys, refused with the camelCase name in the hint. The one exception is two top-level blocks of a version-2 site manifest, which are snake_case:reader_auth(a list of sign-in configurations) andstatus_monitors;readerAuthis a different key there, the one-word shorthandreaderAuth: atlas.Front matter is the exception: a key is read in any casing (
seo_title,seo-title,SeoTitleall meanseoTitle), and the names other tools use (description,sidebar_label,sidebar_position,image) are read as ours.Enum values are lower-case (
"wide","system"), except space types and visibilities, which are upper-case ("DOCS","PUBLIC").Colours are
#rrggbb(or#rgb); lengths that are numbers are CSS pixels.
Keys
Top-level keys and the keys one level inside them. [] marks “each item of a list”.
Key | Type | Required | What it is |
|---|---|---|---|
| string | null | ||
| string[] | ||
| integer | null | ||
| string | null | ||
| string | null | ||
| string | null | ||
|
| ||
|
| ||
| integer | null | ||
|
| ||
| string[] | ||
|
| ||
| string | ||
| string | null | ||
| string[] | ||
| string | null | An icon name from | |
| string | null | ||
| string | null | ||
| integer | ||
| string | yes | |
| boolean | null | ||
| integer | null | ||
| string | null | ||
| string | null | ||
| boolean | ||
| boolean | ||
| object[] | ||
| integer | yes | |
| string | yes | |
|
| ||
| boolean | ||
| string | ||
| boolean | null | ||
| integer | ||
|
| ||
|
| ||
| string | null | ||
| string | null | ||
|
| ||
| map | null | ||
| map | null | ||
| boolean | null |