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

Move document to trash

Soft-delete the document by moving it to trash. The document can be restored using the unremove endpoint. If the permanent query parameter is set to true, the document is permanently deleted instead.

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

2 parameters
docIdstringrequired
A string id (UUID)
permanentbooleanoptional
If true, permanently delete instead of moving to trash

1 status code
200Document moved to trash (or permanently deleted)