Set the Navigation Menu
helpcenter_set_template_navigationReplace the help center's navigation menu — the one every Navigation component draws, in the header or elsewhere — with the items given, in order.
It edits the help center's design DRAFT (its v2 template): the draft the dashboard's Template Editor opens, with a live preview. Nothing reaches visitors until helpcenter_publish_template — after editing, give the customer the Template Editor link from the result to review, and publish only when they ask. v2 help centers only (a classic one answers template_migration_required). Ids come from helpcenter_get_template.
The whole menu is replaced: include every item to keep, with its id (helpcenter_get_template, section 'navigation'), so its translations survive; an empty list clears it. Links are '/', '/category/' (ids from helpcenter_list_categories), '/content/', '/contacts', or a full https:// URL with type 'external' to open in a new tab. Items take one level of children, and a cssClass to style one — a button-like "Sign up" — with custom CSS. This is the guide's set_navigation operation.
Args:
items (array, up to 30): {label, href, type?, cssClass?, id?, children?}.
etag (string, optional): from your last read or edit; refuses (stale_draft) if the draft changed since.
Returns: what each entry did (new ids), warnings worth relaying, and the draft status with its new etag.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| etag | No | Optimistic lock: the draft etag from your last read, or the one your last edit returned. When given, the call is refused (stale_draft) if someone changed the draft since — so you never build on a state you have not seen. Omit to apply to the current draft. | |
| items | Yes | The whole menu, in order. An empty array clears it. | |
| 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. |