libredesk_help_center
Create and manage help centers, collections, and their settings, themes, and locales. List, inspect, reorder, and analyze search insights to organize public knowledge base content.
Instructions
Manage help centers and their collections. Undocumented API.
Actions:
list(): List all help centers.
get(id): Get one help center with all settings and theme.
locales(): List the locale codes a help center can use.
tree(id, ...): Collections and articles of a help center as a tree, without content.
insights(id): Top and zero-result search terms of the public help center.
create(name, slug, page_title, ...): Create a help center.
update(id, ...): Change only the given settings of a help center.
collection_list(help_center_id): List the collections of a help center.
collection_create(help_center_id, name, ...): Create a collection in a help center.
collection_update(help_center_id, id, ...): Change only the given fields of a collection.
collection_reorder(help_center_id, order): Sort many collections at once.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Help center id. For collection_update: Collection id. | |
| icon | No | Lucide icon name, for example "rocket". | |
| name | No | Help center name. For collection_create, collection_update: Collection name. | |
| slug | No | URL slug (/hc/<slug>): unique; a-z, 0-9, - and _; not articles, search, api, sitemap.xml. | |
| order | No | Map of collection id to position, for example {"3":0,"5":1}. | |
| theme | No | Branding object such as {"color":"#1f93ff"}. Replaces the whole theme: send the full object from get. | |
| action | Yes | Action. | |
| locale | No | Locale code, for example "en". For tree: Only this locale; omit for all. | |
| profile | No | Stored profile to use; omit for the default. | |
| template | No | Page layout, "classic" by default. | |
| custom_js | No | Extra JavaScript for the public pages. | |
| parent_id | No | Parent collection id (max 3 levels); null for top level. | |
| custom_css | No | Extra CSS for the public pages. | |
| page_title | No | Title of the public pages. | |
| sort_order | No | Position among siblings, lowest first. | |
| description | No | Short text under the collection name. | |
| custom_domain | No | Own domain origin such as "https://help.example.com"; "" removes it. | |
| default_locale | No | Default locale code (from locales); "en" when unset. | |
| help_center_id | No | Help center id. | |
| allowed_locales | No | Locale codes (from locales) content can use; ones with articles cannot be removed. | |
| meta_description | No | SEO description, up to 500 characters. | |
| livechat_inbox_id | No | Live chat inbox for the public chat widget; null removes it. |