Skip to main content

Refresh Auto Updates

Available November 2026 and later.

Run pending automatic updates now, without changing the active sheet: for one worksheet, every worksheet in a dashboard's current device layout, or the current point of a storyboard. Use after batching edits with set-auto-updates-paused. If a dashboard or storyboard worksheet fails, the error result reports a PARTIAL or FAILED outcome per worksheet.

APIs called​

This tool acts on the workbook open in the running Tableau Studio instance, not on the Tableau Cloud or Tableau Server REST API. Under the hood these are calls to the local Tableau Studio External Client API — a REST API the running Tableau Studio instance serves at http://127.0.0.1:<port>/v<x>, where <x> is the latest API version. There are no OAuth scopes: each call is authorized by the running Tableau Studio instance's per-session bearer token over the loopback interface.

  • Settles on which Tableau Studio session to target before anything is sent. Resolved in-process (not an API call).
  • Reads the worksheet, dashboard, and storyboard inventories of the open workbook so the requested name or id can be matched to one sheet. Requires a connected Tableau Studio session with an open workbook; authorized by that session's loopback bearer token.
    • GET /v<x>/workbook/worksheets — list the worksheets in the open workbook. API reference
    • GET /v<x>/workbook/dashboards — list the dashboards in the open workbook. API reference
    • GET /v<x>/workbook/storyboards — list the storyboards in the open workbook. API reference
  • Asks Tableau Studio to run pending automatic updates on the matched worksheet now. Issued only after the match succeeds. Requires a connected Tableau Studio session; authorized by that session's loopback bearer token. The request carries no body.
    • POST /v<x>/workbook/worksheets/{id}:refreshNow — run pending automatic updates on a worksheet now. [API reference link TBD]

Required arguments​

sheetId​

Id of the sheet whose pending updates should run now (available November 2026 and later). A unique sheet name also works. Type: string.

Example​

{ "sheetId": "Sales by Region" }

kind​

Which kind of sheet sheetId is (available November 2026 and later). Type: enum. One of worksheet, dashboard, or storyboard.

Example​

"worksheet"

Optional arguments​

session​

Identifier of the target Tableau Studio session. When omitted, the session is resolved automatically (for example, when exactly one Tableau Studio instance is connected).

Example​

"studio-1"

Session resolution does not guess

With no session given and no Tableau Studio instance running, or more than one running, the tool reports an error rather than picking one; the multiple-instance error lists the session IDs to choose from. A session that names an instance which is not among the running ones is refused the same way.

Notes and caveats​

  • refreshed is true only when the refresh has completed. The result also includes worksheet (id and name as it was before the call) and a message. When Tableau Studio accepts the request before the change has settled, refreshed is false and the message says the refresh was requested and is still being applied, rather than claiming it finished.
  • Not read-only, and not idempotent. The tool asks Tableau Studio to run pending automatic updates now, so it is not a read-only operation and repeating the call can start another refresh.

Example results​

Refreshed a worksheet​

{
"refreshed": true,
"worksheet": { "id": "sheet-sales", "name": "Sales by Region" },
"message": "Refreshed auto-updates for worksheet \"Sales by Region\"."
}

Accepted, still being applied​

{
"refreshed": false,
"worksheet": { "id": "sheet-sales", "name": "Sales by Region" },
"message": "Requested refreshing auto-updates for worksheet \"Sales by Region\"; Desktop is still applying it."
}
  • set-auto-updates-paused — pauses or resumes automatic query execution so you can batch edits before this refresh.
  • get-sheets — lists the worksheets in the open workbook, including stable ids, so you can pick a valid target.