Actions14
- Collection Actions
- Global Actions
- Endpoint Actions
Endpoint → Delete
AI-generatedSummary
Delete a Payload CMS endpoint
Inputs
- endpoint (required) — Choose the endpoint to operate on
- data (required) — The data to send (JSON format)
- additionalOptions — Additional Options for the request (e.g., depth, limit, where, select, etc.)
Output shape
response body JSON
Success returns the parsed response body; errors are handled separately and may return an error object depending on workflow settings.
Examples
Example 1: Delete a collection endpoint with custom query parameters
Set Endpoint to '/api/collections/my-collection', provide Data as '{}', add Query Parameters {'depth':2,'limit':5} in Additional Options
Example 2: Delete an endpoint using default additional options
Select the endpoint path, leave Data empty or with required payload, do not set Additional Options
Example 3: Delete endpoint while uploading a file
Choose endpoint, set Data with JSON, set Additional Options → Upload to 'file' and provide a binary item