Skip to main content

Rename Sheet

Available September 2026 and later.

Renames a worksheet, dashboard, or storyboard in the workbook open in Tableau Studio, matching the target by name or id. The sheet keeps its id and kind; only the display name changes.

Not read-only

This tool is not read-only and not idempotent. It changes a sheet name in the live Tableau Studio workbook, so repeating the call is not a no-op: a second call that still uses the previous name is refused because that name is already gone.

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
  • Matches the request to one sheet. Validated in-process (not an API call). When that match refuses, nothing is posted.
  • Renames the matched sheet. Issued only after the match succeeds. Requires a connected Tableau Studio session; authorized by that session's loopback bearer token. The request body is { "name": "<new name>" }.
    • POST /v<x>/workbook/worksheets/{id}:rename — rename a worksheet. API reference
    • POST /v<x>/workbook/dashboards/{id}:rename — rename a dashboard. API reference
    • POST /v<x>/workbook/storyboards/{id}:rename — rename a storyboard. API reference

Required arguments​

sheet​

Name or id of the worksheet, dashboard, or storyboard to rename. Type: string. The tool matches against the live inventories of all three kinds after trimming whitespace: an exact id match wins; otherwise an exact, case-sensitive name match. A name that matches more than one sheet — including the same caption on a worksheet and a dashboard — is refused, and the tool asks you to pass an id. A name or id that matches nothing is refused with the sheets that are available, each listed as name (id).

Example​

{ "sheet": "Sales by Region" }

name​

The new display name for the matched sheet. Type: string. Range: 1 or more characters. An empty string is refused.

Example​

{ "name": "Regional Sales" }

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​

  • sheet.name in the result is the new name. The result also includes previousName (what the sheet was called before this call), sheet.id, sheet.kind, and a message. When Tableau Studio accepts the request before the change has settled, the message says the rename was requested and is still being applied, rather than claiming it finished.

Example results​

Renamed a worksheet​

{
"sheet": { "id": "sheet-sales", "kind": "worksheet", "name": "Regional Sales" },
"previousName": "Sales by Region",
"message": "Renamed worksheet \"Sales by Region\" to \"Regional Sales\"."
}

Renamed a dashboard​

{
"sheet": { "id": "dash-exec", "kind": "dashboard", "name": "Exec Summary" },
"previousName": "Executive Dashboard",
"message": "Renamed dashboard \"Executive Dashboard\" to \"Exec Summary\"."
}

Renamed a storyboard​

{
"sheet": { "id": "story-qbr", "kind": "storyboard", "name": "QBR 2026" },
"previousName": "QBR Story",
"message": "Renamed storyboard \"QBR Story\" to \"QBR 2026\"."
}

Accepted, still being applied​

{
"sheet": { "id": "sheet-sales", "kind": "worksheet", "name": "Regional Sales" },
"previousName": "Sales by Region",
"message": "Requested rename to \"Regional Sales\"; Desktop is still applying it."
}
  • activate-sheet — brings the renamed sheet to the foreground by name or id.
  • get-sheets — lists every sheet in the open workbook, including stable ids, so you can pick a valid target.