Delete Records
grist.delete_records
ActionDatabases & warehousesconnection required
Calls the Grist API with the connection's credentials.
Remove rows from a table by their Grist row ids.
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
3 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 |
record_ids The Grist row ids to remove, as whole numbers. | array | Yes | — | ≥ 1 characters; array of number | [101,102] |
doc_id Document to act in; overrides the document set on the connection. | string | No | — | — | mR9tqLGSKB2Z |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"doc_id": "mR9tqLGSKB2Z",
"record_ids": [
101,
102
],
"table_id": "People"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
deleted How many row ids were sent for deletion. | number | — |
ids The Grist row ids that were deleted. | array | — |
table_id The table id the call acted on. | string | — |
doc_id The Grist document the call acted on. | string | — |
{
"deleted": 0,
"doc_id": "",
"ids": [],
"table_id": ""
}See Delete 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.