---
title: "Cancel a broadcast"
method: POST
path: "/v1/broadcasts/{id}/cancel"
tags: ["Broadcasts"]
---

# Cancel a broadcast

`POST /v1/broadcasts/{id}/cancel`

## Request

- Base URL: `https://api.sendora.se`
- URL: `https://api.sendora.se/v1/broadcasts/{id}/cancel`
- Auth: HTTP bearer

Holds every message of the broadcast that has not been handed to the mail server yet; those count as failed. A message already on its way is delivered. A completed or cancelled broadcast answers 409.

## Path parameters

- `id` string, uuid, required

## Response `200`

A broadcast and how far it has come.

- object: A broadcast and how far it has come.
  - `broadcastId` string, uuid, required
  - `streamId` string, uuid, required: The broadcast stream the messages go on.
  - `status` 'accepted' | 'processing' | 'completed' | 'cancelled', required: accepted until the first message leaves, processing while messages are leaving, completed when every message has left or failed, cancelled once cancelled.
  - `from` string, required
  - `subject` string, required
  - `tag` string, nullable, required
  - `metadata` object, required
  - `total` integer, required: Messages stored, after suppressed addresses were dropped.
  - `released` integer, required: Messages handed to the mail server so far.
  - `failed` integer, required: Messages that could not be handed over, cancelled ones included.
  - `suppressed` integer, required: Addresses dropped from the list for standing on the stream’s suppression list.
  - `submittedAt` string, date-time, required
  - `completedAt` string, date-time, nullable, required: Set once nothing is left to send, or on cancel.

## Other responses

- `401`: The key is missing, malformed or revoked.
- `403`: The key is of the other kind, or a connected app may not do this here: it is not for connections, the connection may only read here, or it is for test servers only.
- `404`: No such broadcast of this server.
- `409`: The broadcast is completed or cancelled already; nothing is left to cancel.

---

[API](https://skmtc.dev/sendora/apis/sendora-api.md) · [All operations](https://skmtc.dev/sendora/apis/sendora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sendora/apis/sendora-api/revisions/72efbbb34b64?raw)