Update Records

grist.update_records

ActionDatabases & warehousesconnection required

Calls the Grist API with the connection's credentials.

Change the cell values of existing rows, each addressed by its row id.

Ask about Grist All Grist nodes Provider API docs ↗

Connection

Required: Yes — the node will not save without one
Auth type: API key
Providers: Grist
Secret shape: the API key, or {"api_key": "…"}
Config it needs: base_url, doc_id
Resolved by: config.connection_id, else node.connection_id

Configuration

4 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

Field	Type	Required	Default	Constraints	Example
table_id The table to act on, as its table id (the TABLE ID shown in Raw Data).	string	Yes	—	—	People
records Rows to change. Each entry needs the Grist row 'id' and a 'fields' object of the columns to set.	array	Yes	—	≥ 1 characters; array of object	[{"fields":{"Age":37},"id":1}]
doc_id Document to act in; overrides the document set on the connection.	string	No	—	—	mR9tqLGSKB2Z
noparse Send values exactly as given instead of letting Grist parse them into the column type.	boolean	No	false	—	—

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "doc_id": "mR9tqLGSKB2Z",
  "noparse": false,
  "records": [
    {
      "fields": {
        "Age": 37
      },
      "id": 1
    }
  ],
  "table_id": "People"
}

Output

One shape.

result

Field	Type	Example
updated How many rows were sent for update.	number	—
ids The Grist row ids that were updated.	array	—
table_id The table id the call acted on.	string	—
doc_id The Grist document the call acted on.	string	—

{
  "doc_id": "",
  "ids": [],
  "table_id": "",
  "updated": 0
}

Related Grist nodes

See Update Records run in a workflow.

In a technical demo we add the Grist connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demo Talk to sales