Actions18
- Auth Actions
- Collection Actions
- Global Actions
Overview
This node interacts with Payload CMS to perform operations on collections, globals, and authentication. Specifically, for the Collection resource with the Delete operation, it deletes documents from a specified collection based on filtering criteria or by document ID. This is useful for automating content management tasks such as removing outdated or unwanted entries from a CMS collection.
Use Case Examples
- Deleting multiple documents from a blog posts collection based on a filter condition.
- Deleting a specific user document by its ID from a users collection.
Properties
| Name | Meaning |
|---|---|
| Collection | The specific collection in Payload CMS to operate on, from which documents will be deleted. |
| Additional Options | Optional parameters to refine the delete operation, including depth of relationship population, limit on number of documents, pagination page number, sorting order, filtering conditions (where clause), fields to select, and locale for localized content. |
Output
JSON
json- The JSON response from Payload CMS after the delete operation, containing details of the deleted documents or operation status.
Dependencies
- Requires an API key credential for Payload CMS to authenticate requests.
Troubleshooting
- Authentication failures due to invalid or expired API credentials. Ensure the API key is valid and has necessary permissions.
- Errors parsing the 'where' JSON filter if the input is malformed. Validate JSON syntax before input.
- Network or connectivity issues to the Payload CMS instance. Verify the base URL and network access.
- Errors if the specified collection or document ID does not exist. Confirm collection names and document IDs are correct.