Grist icon

Grist

Consume the Grist API

Actions5

Record → Update

AI-generated

Summary

Update existing records in a specified Grist table by providing a JSON array of record objects containing their unique IDs and the fields to modify.

Inputs

  • Organization (required) — Select the Grist organization to which the target document belongs.
  • Workspace (required) — Select the workspace within the organization containing the target document.
  • Document (required) — Select the document within the organization where the table resides.
  • Table (required) — Select the table within the document where records will be updated.
  • Records (JSON) (required) — Provide a JSON array of objects, each with an "id" key for the record ID and a "fields" key mapping column names to their new values.

Output shape

a single array containing the updated records as returned by Grist API

Input JSON is parsed and sent via a PATCH request to update the specified records. The response includes the updated records; errors such as invalid JSON raise node errors. Returned data is output as one item with JSON containing the API response array.

Examples

Example 1: Updating two records in a table

Provide org, workspace, document, and table IDs, then specify [{"id":1, "fields":{"Name":"Alice", "Age":31}}, {"id":2, "fields":{"Name":"Bob", "Age":29}}] in the Records (JSON) parameter.

Links

Discussion