Skip to main content
PATCH
Update Sheet Inputs

Authorizations

Authorization
string
header
required

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

Headers

Authorization
string
required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

sheetId
string<uuid>
required

Sheet UUID. Accepted in canonical, uppercase, braced, or unhyphenated form, as projectId is on POST /v1/templates/{code}/sheets.

Body

application/json
attributes
object
required

Widget reference IDs and their new values. At least one key, at most 200.

Response

The attributes were updated on the same sheet.

Acknowledges an input update. Updating does not recalculate — solve the sheet to refresh results.

sheetId
string<uuid>
required

Unique identifier for the sheet. Unchanged by updates.

status
enum<string>
required

Updated inputs take effect at the next solve.

Available options:
unsolved
updatedAttributes
string[]
required

Reference IDs the sheet now holds from this request. A key the template does not define is skipped, so it is absent here and named in warnings — compare the two to confirm a write landed.

warnings
object[]

Keys that were not applied, and why. Absent when there is nothing to report.