Actions14
- Collection Actions
- Global Actions
- Endpoint Actions
Collection → Delete
AI-generatedSummary
Delete documents from a collection
Inputs
- collection (required) — The Payload CMS collection to delete documents from.
- additionalOptions — Optional parameters such as depth, limit, page, sort, where, select, locale, upload, and query parameters that affect the delete request.
Output shape
an array of deleted document objects
The response body from Payload CMS; may be empty or contain the deleted documents.
Examples
Example 1: Delete all draft posts
collection: posts; additionalOptions.where: {"status":"draft"}
Example 2: Bulk delete with pagination
collection: orders; additionalOptions.where: {"status":"cancelled"}; additionalOptions.limit: 100
Example 3: Delete with custom query parameters
collection: users; additionalOptions.query: {"role":"admin"}