Format Range | Athena | API Reference Docs

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

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

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

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

formattingobjectRequired

Cell format

start_columnintegerRequired

1-based starting column index

start_rowintegerRequired

1-based starting row index

sheet_idintegerOptionalDefaults to 1

Sheet ID (defaults to 1)

Successful Response

asset_idstring

The ID of the spreadsheet asset

messagestring

Success message or error description

successboolean

Whether the operation was successful

1	from athena import Athena, CellFormat
2
3	client = Athena(
4	api_key="YOUR_API_KEY",
5	)
6	client.tools.sheets.format_range(
7	asset_id="asset_id",
8	end_column=1,
9	end_row=1,
10	formatting=CellFormat(),
11	start_column=1,
12	start_row=1,
13	)