Book a demo

Add Records

grist.add_records
ActionDatabases & warehousesconnection required

Calls the Grist API with the connection's credentials.

Add one or more rows to a table and return the ids Grist assigned.

Ask about GristAll Grist nodesProvider 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.

FieldTypeRequiredDefaultConstraintsExample
table_id
The table to act on, as its table id (the TABLE ID shown in Raw Data).
stringYes——People
records
Rows to add. Each entry is a 'fields' object of column values, or a bare column map, which is wrapped for you.
arrayYes—≥ 1 characters; array of object[{"fields":{"Age":36,"Name":"Ada"}}]
doc_id
Document to act in; overrides the document set on the connection.
stringNo——mR9tqLGSKB2Z
noparse
Send values exactly as given instead of letting Grist parse them into the column type.
booleanNofalse——

Example configuration

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

{
  "doc_id": "mR9tqLGSKB2Z",
  "noparse": false,
  "records": [
    {
      "fields": {
        "Age": 36,
        "Name": "Ada"
      }
    }
  ],
  "table_id": "People"
}

Output

One shape.

result

FieldTypeExample
records
One object per row added, each carrying its new id.
array—
ids
The Grist row ids of the rows that were added.
array—
count
How many rows Grist reported adding.
number—
requested
How many rows were sent.
number—
table_id
The table id the call acted on.
string—
doc_id
The Grist document the call acted on.
string—
{
  "count": 0,
  "doc_id": "",
  "ids": [],
  "records": [],
  "requested": 0,
  "table_id": ""
}

Related Grist nodes

See Add 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 demoTalk to sales