Delete a broadcast

Delete a draft, or cancel a scheduled send.

DELETE /v1/broadcasts/{id}

Requires a Full access API key — a broadcast reaches your audience, so a sending key embedded in an app cannot delete one.

Path parameters

Parameter	Type	Required	Description
id	string	Yes	The broadcast id.

Example

curl

curl -X DELETE "https://api.sendgrail.com/v1/broadcasts/$BROADCAST_ID" \
  -H "Authorization: Bearer $SENDGRAIL_API_KEY"

Node.js

await fetch(`https://api.sendgrail.com/v1/broadcasts/${id}`, {
  method: 'DELETE',
  headers: { Authorization: `Bearer ${process.env.SENDGRAIL_API_KEY}` },
});

Response

{
  "object": "broadcast",
  "id": "e4f9a2c1-7b83-4d6e-9a1f-2c5b8e0d3a47",
  "deleted": true
}

Deleting a scheduled broadcast cancels the send

Delete works on a broadcast that is either a draft or scheduled. Deleting a scheduled one cancels the send — the email won't go out. That is the whole point of allowing it.

A broadcast that has already been sent (or is queued, or failed) answers 409 broadcast_already_sent — there is nothing left to cancel:

{
  "message": "Only a draft or scheduled broadcast can be deleted.",
  "code": "broadcast_already_sent",
  "request_id": "8f2c1e64-1b17-4f8c-9f0e-3b6c1e0f5c31"
}

A broadcast belonging to another team answers 404, not 403. See Errors for the full list of codes.