API ReferenceToolsSheets

Update Range

Beta
Update 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
start_columnintegerRequired

1-based starting column index

start_rowintegerRequired

1-based starting row index

valueslist of lists of nullable strings or booleans or integers or doublesRequired
2D list of cells for each row
formattinglist of lists of nullable objects or nullOptional
Optional 2D list of cell formats matching the structure of values. Each row is a list of CellFormat objects for each cell in that row. Use None for cells without formatting. numberFormat is not required unless user explicity asked to change
sheet_idintegerOptionalDefaults to 1

Sheet ID (defaults to 1)

treat_as_textbooleanOptionalDefaults to false

Store every value in the range as text (plain-text cell format): no numeric coercion, leading zeros preserved, formula-looking input kept literal — like text-formatted cells in Excel. Use for string identifiers such as zero-padded codes, ZIP codes, and long numeric IDs.

Response

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

ID of the newly created sheet when the operation creates one (e.g. duplicate). For rnc-engine sheets this is the engine-assigned id, which may differ from a requested new_sheet_id.

Errors

422
Unprocessable Entity Error