Grist icon

Grist

Consume the Grist API

Actions5

Record → Delete

AI-generated

Summary

Delete records from a specified table in a Grist document by providing their row IDs.

Inputs

  • Organization (required) — Select the Grist organization from which the record will be deleted.
  • Workspace (required) — Specify the workspace within the selected organization.
  • Document (required) — Select the document containing the table from which records will be deleted.
  • Table (required) — Select the table within the chosen document.
  • Row IDs (required) — Provide a comma-separated list of the row IDs to delete (e.g., "1,2,3").

Output shape

A single JSON object confirming deletion, including the list of requested deleted row IDs and the API response.

The output contains a JSON object with properties 'success' (boolean), 'deleted' (array of deleted row IDs), and 'response' (API response). If the operation succeeds, 'success' is true and the deleted IDs match those requested.

Examples

Example 1: Deleting multiple records by their IDs

Set Organization, Workspace, Document, and Table, then enter row IDs like "10,12,15" to delete those records.

Links

Discussion