Skip to main content
DELETE
Cancel Scheduled Email
Cancel a scheduled email before it is sent. Scheduled emails are held in Lettr until their send time, so cancelling works right up to the moment of sending. Only an email whose status is still scheduled can be cancelled; once it is sending, sent, cancelled or failed, the request returns 409 with the code schedule_cancellation_failed.

Authorizations

Authorization
string
header
required

API key for authentication

Path Parameters

transmissionId
string
required

The request_id returned when the email was scheduled (sch_...). A bare SparkPost transmission id is also accepted, for emails scheduled before Lettr owned the schedule.

Example:

"sch_01JQZ3N2K8XW9V6M4TBRC7YHDE"

Response

Scheduled transmission cancelled successfully. The email was never handed to SparkPost.

message
string
required
Example:

"Scheduled transmission cancelled successfully."

data
object
required

A scheduled email held by Lettr. This is the data object of POST /emails/scheduled, GET /emails/scheduled/{transmissionId} and DELETE /emails/scheduled/{transmissionId}, and each entry of scheduled_emails in GET /emails/scheduled.

Breaking change. Scheduled emails are no longer parked inside SparkPost with options.start_time — SparkPost retired its per-transmission GET and DELETE endpoints. Lettr now holds the email in its own store and injects it into SparkPost when it is due, so request_id is Lettr's own sch_... id, transmission_id is a separate field that stays null until injection, and state values are Lettr's own rather than SparkPost's pass-through states.