Skip to main content

Set Auto Updates Paused

Available November 2026 and later.

Pause or resume automatic query execution for a worksheet, or for a dashboard and every worksheet it contains. Pause to batch edits before the next refresh. Resuming a dashboard re-enables every worksheet it contains, not only ones paused earlier.

APIs called​

This tool changes automatic query execution on a worksheet or dashboard in the workbook open in the running Tableau Studio instance, through the local Tableau Studio External Client API. There are no OAuth scopes. Storyboards are not a target.

Required arguments​

sheetId​

Id of the worksheet or dashboard. A unique sheet name also works.

Example​

{ "sheetId": "Sales by Region" }

kind​

Which kind of sheet sheetId is. One of worksheet or dashboard.

Example​

"dashboard"


isAutoUpdatesPaused​

true pauses automatic query execution. false resumes it.

Example​

true

Optional arguments​

session​

Session ID. Optional when a session is pinned or only one Tableau Studio instance is connected.

Example​

"studio-1"

Notes and caveats​

  • The result includes sheet (id, kind, and name as they were before the call) and a message. The flag is true only when the pause or resume has completed. When Tableau Studio accepts the request first, the flag is false and the message says the change is still being applied.
  • Pausing a sheet whose automatic updates are already paused, or resuming one that is already running, is safe to repeat. Resuming a dashboard re-enables every worksheet it contains, not only ones paused earlier.