Appearance
This API specification describes the bulk deletion endpoint for deleting multiple emails.
Authentication: Plugin-based authentication using custom headers. Requires valid plugin authentication token and plugin UI data.
Authorization: Only users with "api" role are permitted to use this endpoint. Other roles will receive a 403 Forbidden response.
Validation:
Stripo Plugin API server
Email management operations
Deletes multiple email models by their IDs. Only users with the api role can use this endpoint.
Request body containing email IDs to delete
List of email model IDs to delete. Min: 1, max: 1000.
All emails deleted successfully. No response body is returned.
Bad request - Invalid request format, missing email IDs, array too large, or invalid email ID format detected.
Standard error response structure.
Human-readable error message
Unauthorized - Authentication failed, invalid credentials, missing plugin ID, or plugin authentication response is invalid.
Standard error response structure.
Human-readable error message
Forbidden - User does not have the required "api" role to perform bulk deletions. This endpoint is restricted to plugin users with "api" role only.
Standard error response structure.
Human-readable error message
Method not allowed - Only POST method is supported
Standard error response structure.
Human-readable error message
Internal server error - Failed to delete emails.
Standard error response structure.
Human-readable error message
curl https://plugins.stripo.email/coediting/v1/emails/bulk-delete \
--request POST \
--header 'Content-Type: application/json' \
--header 'ES-PLUGIN-AUTH: YOUR_SECRET_TOKEN' \
--data '{
"emailIds": [
"email-123"
]
}'
All emails deleted successfully. No response body is returned.
Request body containing email IDs to delete
List of email model IDs to delete. Min: 1, max: 1000.
Standard error response structure.
Human-readable error message