API ReferenceToolsSheets

Clear Range

Beta
Clear a range of cells in an Athena spreadsheet.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
asset_idstringRequired
The ID of the spreadsheet asset
num_columnsintegerRequired
Number of columns to clear
num_rowsintegerRequired
Number of rows to clear
start_columnintegerRequired

1-based starting column index

start_rowintegerRequired

1-based starting row index

sheet_idintegerOptionalDefaults to 1

Sheet ID (defaults to 1)

Response

Successful Response
asset_idstring
The ID of the spreadsheet asset
messagestring
Success message or error description
successboolean
Whether the operation was successful

Errors