API ReferenceToolsSheets

Format Range

Beta
Apply formatting to a range of cells in an Athena spreadsheet.

Headers

X-API-KEYstringRequired

Request

This endpoint expects an object.
asset_idstringRequired
The ID of the spreadsheet asset
end_columnintegerRequired

1-based ending column index

end_rowintegerRequired

1-based ending row index

start_columnintegerRequired

1-based starting column index

start_rowintegerRequired

1-based starting row index

typestringRequired

Formatting type (e.g. backgroundColor, textFormat, borders, etc.)

value_jsonstringRequired

JSON string for value param (e.g. ’“#FF0000”’ or ’{“fontSize”:12}’)

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