Delete a broadcast

DELETE/v1/broadcasts/{id}API key

Deletes a broadcast in the draft, sent or canceled status. A scheduled or sending broadcast has to be canceled first.

Emails the broadcast already sent are not deleted. They stay in the email log with their broadcast_id tag.

Path parameters

idstringpathrequired

The broadcast ID.

Response

idstring

The ID of the deleted broadcast.

deletedtrue

Always true.

Errors

Status	Code	When
404	`broadcast_not_found`	No broadcast with that ID in this project.
409	`broadcast_active`	The broadcast is scheduled or sending.

Request

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

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

await flaresend.broadcasts.remove('bc_01K6C3D9G2J4L7N0Q3S5U8W1YZ');

Response

{
  "id": "bc_01K6C3D9G2J4L7N0Q3S5U8W1YZ",
  "deleted": true
}

Path parametersCopy Anchor Link

ResponseCopy Anchor Link

ErrorsCopy Anchor Link

Path parameters

Response

Errors