Cancel an email

DELETE/v1/emails/{id}API key

Stops a scheduled email from going out. Its status and every recipient's status become canceled, an email.canceled event is added to the timeline, and webhooks subscribed to email.canceled are called.

Only emails with status scheduled can be canceled. Emails sent without scheduledAt go to the queue straight away and can't be stopped. If the send queue picks up a scheduled email at the same moment you cancel it, whichever gets there first wins: the cancel either succeeds, or fails with 409 not_cancelable and the email is sent.

The email record is kept. Nothing is deleted.

Path parameters

idstringpathrequired

The email ID.

Response

idstring

The email ID.

status'canceled'

Always canceled.

Errors

Status	Code	When
404	`email_not_found`	No email with that ID in this project.
409	`not_cancelable`	The email isn't `scheduled`, or the send queue claimed it first.

Request

import { Flaresend } from '@flaresend/client';

const flaresend = new Flaresend({
  apiKey: process.env.FLARESEND_API_KEY!,
  baseUrl: 'https://mailer.example.com',
});

await flaresend.emails.cancel('email_01K6B2Y4ZP9R3M7T8V5N2QXW4C');

Response

{
  "id": "email_01K6B2Y4ZP9R3M7T8V5N2QXW4C",
  "status": "canceled"
}

Path parametersCopy Anchor Link

ResponseCopy Anchor Link

ErrorsCopy Anchor Link

Path parameters

Response

Errors