POST/v1/emails/messages/{messageId}/cancel

Authorization

Bearer token

Authorizationrequiredheader

Send your API key as Bearer YOUR_API_KEY.

Permissionemail.send

A key restricted to one sending domain can cancel only emails sent from that domain.

Path parameters

messageIdrequiredstring

The messageId returned when you scheduled the send.

Response

application/json200 OK

Every scheduled delivery of the message becomes canceled, and email.canceled fires for each one.

Cancelling an email that is already canceled returns the same result, so retrying is safe. Recipients that were suppressed when you scheduled the send keep the suppressed status.

Nexiom Connect
Open dashboard