Faq portal
Config
Returns the workspace's public FAQ portal configuration (defaults if never saved).
PUT
/api/{tenant:minlength(2)}/v{version:apiVersion}/faq_portal/config
Request arguments
| Name | Type | Source |
|---|---|---|
| input | DTO_faq_portal_config | Body |
Request body example
Response
Response body example
DTO_faq_portal_config
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| enabled | Boolean | Master switch; while false the portal responds 404 to visitors | |
| title | String | Portal heading and HTML title. Empty falls back to "Help Center". | |
| primary_color | String | Main color of the portal, given as six hexadecimal digits with an optional leading number sign | |
| background_color | String | Background color of the portal in the same format as primary_color | |
| show_related | Boolean | Show embedding-based related articles under each portal article | |
| search_enabled | Boolean | Offer the text search on the portal | |
| contact_mailbox_id | Int32 (nullable) | Mailbox whose address is offered as the email contact option; null hides the option | |
| contact_form_id | Int32 (nullable) | Form offered as the contact option (linked as its public /external/forms page); null hides the option | |
| chat_bot_enabled | Boolean | Offers an "or chat with our FAQ" link next to the portal search, opening contact_form_id's chat-first widget (the contact block's "Create support ticket" always skips the chat step). Requires contact_form_id; enabling this turns on the AI chat-bot on that form. | |
| embed_page_url | String | Absolute https URL of the page on the workspace's own website that hosts the embedded portal; used for canonical links so search engines index the workspace's own domain | |
| language_ids | Int32[] | Additional portal languages beyond the workspace primary, as platform language ids. Each renders at /external/faq/{code} with AI-translated content stored per language. Limited per plan (see max_portal_languages, which counts the primary). | |
| max_portal_languages | Int32 | ReadOnly | Plan cap on portal languages including the primary (0 = no cap) |
| primary_language_id | Int32 (nullable) | The portal's primary language as a platform language id: the language the ORIGINAL articles are written in (primary pages render originals; every additional language is AI-translated). Omitted on save = follow the workspace language, English when that is unset too. The GET always returns the effective value. | |
| approved_faq_count | Int32 | ReadOnly | Number of approved FAQ items, regardless of portal visibility (see portal_visible_count for what the portal actually lists) |
| portal_visible_count | Int32 | ReadOnly | Number of items the portal actually lists (approved, categorized, not chat-bot-only), before the plan cap |
| max_portal_items | Int32 | ReadOnly | Plan cap on portal items; listings show at most this many (0 = no cap). Items beyond the cap stay approved and keep feeding the AI, they are just not listed publicly. |
| preview_token | String | ReadOnly | Token for the portal preview link (/external/faq?preview=TOKEN); the preview renders even while the portal is disabled |
Generated Aug 22, 2026 09:36