refreshSiteCache
Clears internal caches (template, theme, widget, menu, page) to make recent admin edits visible on the public site.
Instructions
Refresh the site cache (template/theme/widget/menu/page invalidation) - Clears BD's internal template/theme/widget caches. Useful when recent admin edits to design settings or widgets aren't showing on the public site yet.
Use when: the user has just updated a template, theme setting, widget, menu, or page layout and the public site is still serving the old version. Also a safe troubleshooting step if they report a recent admin-edit not appearing after ~1 minute.
Optional parameters:
scope- target one cache area only (data_widgets,settings,web_pages,css,menus,sidebars). Faster than a full refresh. Omit to refresh all 6.full=1- include heavier db_optimization + file_permissions passes in addition to the 6 core areas. Slower; use only when the user reports persistent issues and lighter refreshes didn't help.
Not needed after createWebPage / updateWebPage / createWidget / updateWidget — those tools auto-refresh and return auto_cache_refreshed: true in the response. Only call manually if a write returned auto_cache_refreshed: false (check auto_cache_refresh_error for the cause).
Do NOT use for:
Routine workflow noise - do not call after every bulk op on non-page resources. Most BD writes unrelated to pages are live immediately; cache invalidation is a targeted fallback, not a default post-step.
Returns: { status: "success", message: "Cache refreshed successfully", areas_refreshed: [...], scope: "full", full: false }. The areas_refreshed array lists exactly what was cleared - useful for logging or reporting back to the user. Example default response:
{
"status": "success",
"message": "Cache refreshed successfully",
"areas_refreshed": ["data_widgets", "settings", "web_pages", "css", "menus", "sidebars"],
"scope": "full",
"full": false
}With full=1 the areas_refreshed additionally includes db_optimization and file_permissions. Invalid scope values return an error listing the valid set: { status: "error", message: "Invalid scope value: <x>. Valid values: ..." }.
Undocumented by BD publicly; exposed via admin API-permissions UI.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scope | No | Target a specific cache area instead of refreshing all 6. Omit to refresh all. Valid values: data_widgets, settings, web_pages, css, menus, sidebars. Invalid scope returns an error listing the valid set. | |
| full | No | Pass 1 to also run db_optimization + file_permissions refresh (heavier, slower). Pass 0 or omit for standard refresh of the 6 core areas only. |