volanea
Start sending

Cancel a scheduled message

DELETE/v1/emails/{id}

Secret key — sk_… or sk_test_… · Base URL https://api.volanea.com

Stops a message that was queued with sendAt before it is dispatched. Only a queued message that actually has a scheduledFor can be cancelled: one sent immediately answers 409 not_scheduled, and one already dispatched answers 409 already_dispatched. Cancelling emits an email.cancelled event.

Path parameters

  • idstringrequired

Response

The cancelled message.

  • emailIdstringrequired
  • statusenumrequired
    cancelled

Errors

Every failure returns the standard envelope — branch on `code`, never on the wording of `error`.

  • 401Missing or invalid API key.
  • 404Not found.
  • 409Not scheduled, or already dispatched.

Request

curl https://api.volanea.com/v1/emails/id_123 \
  -X DELETE \
  -H "Authorization: Bearer sk_..."

Response

200 · application/json

{
  "success": true,
  "data": {
    "emailId": "em_1c4f",
    "status": "cancelled"
  }
}

92 endpoints · OpenAPI document