rename_native_sheet_tab

Rename one editable native-sheet tab without changing its cells or bounds.

Parameters

Name	Type	Required	Default	Description
model_name	Annotated[str, Field(description='Name of the Bridge Town model that owns the sheet.')]	Yes	—
sheet_id	Annotated[str, Field(description='Sheet identifier, as returned by list_native_sheets.')]	Yes	—
tab_id	Annotated[str, Field(description='Tab identifier to rename.')]	Yes	—
name	Annotated[str, Field(min_length=1, max_length=200, description='New display name for the tab.')]	Yes	—
expected_sha	Annotated[str, Field(description='Expected sheet blob SHA-1 for optimistic concurrency.')]	No	''
commit_message	Annotated[str, Field(description='Optional Git commit message.')]	No	''
branch	`Annotated[str	None, Field(description=‘Scenario branch; null uses the sheet default.’)]`	No	None
workspace_id	`Annotated[str	None, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`	No	None

Returns

Returns a structured object. Top-level fields:

• _bt_tool (string)
• model_name (string)
• sheet_id (string)
• tab_id (string)
• branch (string)
• commit_sha (string)
• sha (string)
• updated_cells (integer)
• range_formatted_cells (integer)
• calculation_status (string)
• new_tab_id (null)
• workspace_id (string)
• staged_count (null)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "rename_native_sheet_tab",
  "arguments": {
    "model_name": "forecasts",
    "sheet_id": "assumptions",
    "tab_id": "tab1",
    "name": "Drivers",
    "expected_sha": "abc1234def5678901234567890abcdef12345678"
  }
}

Response

{
  "_bt_tool": "rename_native_sheet_tab",
  "model_name": "forecasts",
  "sheet_id": "assumptions",
  "tab_id": "tab1",
  "branch": "main",
  "commit_sha": "abc1234def5678901234567890abcdef12345678",
  "sha": "abc1234def5678901234567890abcdef12345678",
  "updated_cells": 0,
  "range_formatted_cells": 0,
  "calculation_status": "dirty",
  "new_tab_id": null,
  "workspace_id": "dddddddd-dddd-dddd-dddd-dddddddddddd",
  "staged_count": null
}

Notes

• Module: Native Sheets
• Requires authentication via API token or Auth0 JWT.