Skip to main content
DELETE
Cancel a batch

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

batch_id
string
required

The batch grouping label shared by the scheduled emails to act on.

Maximum string length: 64

Response

The batch cancel result.

The result of a batch cancel or reschedule. canceled_count is present for a cancel; rescheduled_count and scheduled_at for a reschedule.

object
string
required

Always scheduled_email.batch.

Allowed value: "scheduled_email.batch"
batch_id
string
required

The batch that was acted on.

canceled_count
integer

Number of emails canceled (batch cancel only).

rescheduled_count
integer

Number of emails rescheduled (batch reschedule only).

scheduled_at
string<date-time>

The new send time applied to the batch (batch reschedule only), in UTC.