Skip to main content
PATCH
Update sheet

Authorizations

Authorization
string
header
required

API key prefixed with finta_

Path Parameters

id
string
required

Document ID returned by list. Worksheet IDs are distinct.

Body

application/json

At least name or nonempty operations is required. Operations execute in order, atomically; later ranges see prior changes. Row numbers are one-based and column references use letters. A batch expands to at most 500 native operations; each changed cell value or cell format consumes one operation. Unmentioned content is preserved. Document renaming precedes operations. Automatic grid growth includes formula-restoration operations to preserve references that the structural engine would otherwise rewrite, including on other worksheets. These consume the same budget as cells, formats, renames, tabs, charts and explicit structural edits. No automatic splitting is performed. For larger edits, use separate sequential calls with each returned revision; earlier successful calls remain saved if a later call fails. A saved mutation may still return calculation errors. Reread and replan on a revision conflict; do not blindly replace base_revision. Operation-free no-ops can retain the revision, so always use the returned value.

base_revision
integer
required
Required range: x >= 0
name
string
required
Required string length: 1 - 50
operations
object[]
Maximum array length: 500

Writes a rectangular matrix matching the range. null skips a cell; an empty string clears contents. Sparse rectangles may span company grid limits; only emitted native operations count toward the shared 500-operation budget.

return_ranges
string[]

Optional A1 selections using final tab names and positions. Up to 100 selections and 10000 cells, calculated after saving. Calculation failures do not roll back edits. Invalid selections report error.param as return_ranges. Omit for metadata only.

Maximum array length: 100

Response

Saved revision, operation results and optional calculated outputs.

Saved document metadata with an absolute configured-app URL and stable worksheet/chart IDs. POST always includes worksheets and their chart definitions; it does not emit operation_results. Use the returned revision rather than assuming a fixed initial value. Optional return_ranges adds calculated selections and status; calculation errors do not roll back the saved document. Revision tracks sheet edits, not freshness of underlying accounting data.

id
string
required
name
string
required
url
string
required
revision
integer
required
Required range: x >= 0
worksheets
object[]
ranges
object[]
calculation
object

Bounded synchronous calculation; no pending job is created. error means one or more formulas failed. unavailable means evaluation could not run; values are omitted rather than invented. Formula-error cells have null values and corresponding errors. A write can be saved even when this status is not complete.

operation_results
object[]