Skip to content

delete_google_sheet_rows

Delete rows from one explicit Google Sheet tab.

destructive

NameTypeRequiredDefaultDescription
model_nameAnnotated[str, Field(description='Name of the Bridge Town model.')]Yes
sheet_idAnnotated[int, Field(ge=0, description='Numeric tab ID from metadata.')]Yes
start_rowAnnotated[int, Field(ge=0, description='Zero-based first row index.')]Yes
num_rowsAnnotated[int, Field(ge=1, le=10000, description='Rows to delete.')]Yes
spreadsheet_id`Annotated[strNone, Field(description=‘Google Spreadsheet ID; provide this or source_name.’)]`NoNone
source_name`Annotated[strNone, Field(description=‘Connected Sheet data-source name; provide this or spreadsheet_id.’)]`NoNone
workspace_id`Annotated[strNone, Field(description=WORKSPACE_ID_FIELD_DESCRIPTION)]`NoNone

Returns a structured object. Top-level fields:

  • spreadsheet_id (string)
  • operation (string)
  • detail (string)

See the response example below for the full payload shape.

{
"name": "delete_google_sheet_rows",
"arguments": {
"model_name": "forecasts",
"sheet_id": 0,
"start_row": 20,
"num_rows": 2,
"spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG"
}
}
{
"spreadsheet_id": "1aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789ABCDEFG",
"operation": "deleted",
"detail": "Deleted 2 rows at index 20 in sheet 0."
}
  • Module: Google Sheets
  • Requires authentication via API token or Auth0 JWT.