Skip to Content
SendlySendly
API ReferenceEmails

Cancel a scheduled (still-PENDING) email

DELETE
/api/emails/{id}/schedule

Mark a still-pending email as CANCELLED before the worker picks it up. Returns 409 if the email is no longer waiting to be sent.

Requires the emails:send scope — Send emails from your verified domains.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

id*string
Formatuuid

Response Body

Email cancelled

application/json
  1. response

A single email.

success*true
Value intrue
data*

A sent (or queued) transactional email.

Example Request
curl -X DELETE 'https://api.sendly.now/api/emails/497f6eca-6276-4993-bfeb-53cbbbba6f08/schedule'
Example Response
{  "success": true,  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",    "from": "string",    "to": "string",    "subject": "string",    "status": "PENDING",    "sentAt": "2019-08-24T14:15:22Z",    "deliveredAt": "2019-08-24T14:15:22Z",    "bouncedAt": "2019-08-24T14:15:22Z",    "openedAt": "2019-08-24T14:15:22Z",    "clickedAt": "2019-08-24T14:15:22Z",    "complainedAt": "2019-08-24T14:15:22Z",    "bounceType": "string",    "bounceSubType": "string",    "bounceDiagnosticCode": "string",    "bounceStatusCode": "string",    "complaintFeedbackType": "string",    "opens": 0,    "clicks": 0,    "tags": [      "string"    ],    "error": "string",    "failureKind": "provider_paused",    "hold": {      "reason": "hourly_ramp_cap",      "message": "string",      "until": "2019-08-24T14:15:22Z"    },    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}