Grist Octri Preview
POST/docs/{docId}/apply

Apply user actions to a document

Applies a sequence of user actions to a document using Grist's internal action format. Supply actions as arrays whose first element is an action type, such as AddRecord, UpdateRecord, or RemoveRecord; set noparse to store string values without parsing them. Use this low-level endpoint to apply batch changes.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters
docIdstringrequired
The UUID of the document to apply actions to.
noparsebooleanoptional
Set to true to store string values as-is without parsing them, for example to prevent automatic date conversion.

1 status code
200Returns an object containing the assigned action number and the return values from each action, such as newly assigned row IDs.
actionNumintegeroptional
The action number assigned
retValuesarrayoptional
Return values from each action (e.g. new row IDs)

Error handling

The docId path parameter must be a UUID, and the request body must be an array of user action arrays. Each action array must start with an action type, such as AddRecord, UpdateRecord, or RemoveColumn; set the noparse query parameter to true to store string values as-is.