Skip to main content
DELETE
Cancel a scheduled email

Authorizations

Authorization
string
header
required

An API key created in the dashboard, sent as Authorization: Bearer mk_....

Headers

Idempotency-Key
string

A unique key making this write retry-safe. A repeat request with the same key and a byte-identical body returns the original response instead of executing again (24-hour window). Max 256 characters. See Idempotency.

Maximum string length: 256

Path Parameters

id
string<uuid>
required

The scheduled email's id (the platform message UUID returned when it was scheduled).

Response

The email was canceled.

The acknowledgment of a cancellation.

id
string<uuid>
required

Platform message UUID of the canceled email.

object
string
required

Always scheduled_email.

Allowed value: "scheduled_email"
status
string
required

Always canceled.

Allowed value: "canceled"