Share or Unshare a Region Across Pages
helpcenter_sync_template_regionMake a region one shared copy on every page, or let each page keep its own.
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.
header and footer are synced by default: one region mirrored to all six pages under the same component ids. enabled:false unsyncs it, and each page keeps its own copy (same ids), so later edits name the page. enabled:true makes every page take source_page's version (default home), translations included, replacing the other pages' copies wherever they differ. An edit to a synced region whose pages differ is refused until you run this, either way. main cannot be synced. This is the guide's sync_region operation.
Args:
region: header, hero, sidebar, footer or utility.
enabled (boolean): share it (true) or let pages differ (false).
source_page (optional): when enabling, the page every page copies. Default home.
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. | |
| region | Yes | A region that can be shared across pages (every region but main). | |
| enabled | Yes | true: one region shared by every page. false: let pages differ. | |
| 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. | |
| source_page | No | When enabling (or re-syncing), the page whose version every page takes. Default home. |