delete_native_sheet_row_column

Preview and explicitly confirm deletion of exactly one row or column from an editable native-sheet tab. The dry-run confirmation token is scoped to the sheet, tab, axis, index, user, tenant, and branch.

destructive

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 change.')]	Yes	—
axis	Annotated[Literal['row', 'column'], Field(description='Axis to delete.')]	Yes	—
index	Annotated[int, Field(ge=0, description='Zero-based row or column to remove.')]	Yes	—
dry_run	Annotated[bool, Field(description='Preview and return a confirmation token instead of deleting.')]	No	True
confirmation_token	`Annotated[str	None, Field(description=‘Token returned by the dry run.’)]`	No	None
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)
• axis (string)
• index (integer)
• row_count_before (integer)
• column_count_before (integer)
• row_count_after (integer)
• column_count_after (integer)
• dry_run (boolean)
• confirmation_token (string)
• deleted (boolean)
• commit_sha (null)
• sha (null)
• calculation_status (null)
• message (string)
• workspace_id (string)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "delete_native_sheet_row_column",
  "arguments": {
    "model_name": "forecasts",
    "sheet_id": "assumptions",
    "tab_id": "tab1",
    "axis": "row",
    "index": 3,
    "dry_run": true
  }
}

Response

{
  "_bt_tool": "delete_native_sheet_row_column",
  "model_name": "forecasts",
  "sheet_id": "assumptions",
  "tab_id": "tab1",
  "branch": "main",
  "axis": "row",
  "index": 3,
  "row_count_before": 100,
  "column_count_before": 26,
  "row_count_after": 99,
  "column_count_after": 26,
  "dry_run": true,
  "confirmation_token": "<signed-confirmation-token>",
  "deleted": false,
  "commit_sha": null,
  "sha": null,
  "calculation_status": null,
  "message": "Dry run: delete row 3 from tab 'tab1'; pass dry_run=False with confirmation_token to commit.",
  "workspace_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}

Notes

• Module: Native Sheets
• Requires authentication via API token or Auth0 JWT.
• Deletion is two-phase: call with dry_run: true, then repeat with the returned confirmation_token and dry_run: false.