Set render options
set_render_optionsConfigure how a site is delivered, without touching its sandbox. spa_fallback (free on every plan) serves the entry page for unknown in-app routes so client-side navigation and shared deep links resolve, but real missing files (scripts, images, styles) still 404. document_kind and printable say what the site is as a document (see publish_site). auto_refresh (free on every plan) makes a viewer that is open when a new version is published reload on its own, instead of offering a Refresh prompt; off by default, since a reload mid-read loses a reader their place. external_origins extends the site's content-security policy to allow specific https origins it calls at runtime (fonts, images, APIs, embeds); this is a paid capability (Pro) and each entry must be a bare https://host[:port] with no path. Pass an empty array to clear the list, or use add_external_origins to add origins without replacing the list. include_original false stops a Word, PowerPoint or Excel site offering its file for download, by rendering the page again from the file it holds as a new version; true is refused, since a withheld file was never kept: update_site with the file and include_original true instead. Omit a field to leave it unchanged. Needs edit access to the site (its creator or an editor grant, in a role that can edit); rejected requests (forbidden, plan_limit, validation_failed) leave the stored options unchanged.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site_id | Yes | The id of the site to configure | |
| printable | No | The page is built to print (a PDF that keeps the look): the design check asks for print styles, and a plain page gets the viewer's Print action (a report or a deck carries its own Download PDF button instead). Kept on later updates unless given again. | |
| auto_refresh | No | Reload open viewers on their own when a new version is published, instead of offering a Refresh prompt | |
| spa_fallback | No | Serve the entry page for unknown in-app routes (deep-link routing) | |
| workspace_id | No | Optional: the workspace to act in, from list_workspaces (the connection reaches the person's personal space and every workspace they are a member of). Required on a write when the connection reaches more than one workspace. Omit to act in the personal space (for an older single-workspace connection, the one workspace it was authorized for). | |
| document_kind | No | What the site is: a report, a presentation, a dashboard, or a plain page (the default). A publish or content update of such a site runs the design check (`design_warnings`); a presentation may go full screen. Kept on later updates unless given again. | |
| external_origins | No | Full set of https origins to allow in the site CSP; replaces the existing list | |
| include_original | No | false: stop offering the Office file this site renders for download (a new version, rendered from the file already held). true is refused; upload the file again with update_site and `include_original` true. |