Emails

Cancel a scheduled message

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.

delete/v1/emails/{id}

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/emails/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

The cancelled message.

emailIdstring required
status'cancelled' required

Changes

No recorded changes to this operation across all 1 revision of this API.