Broadcasts

Cancel a broadcast send

Requests cancellation for delivery work that has not reached the provider. Provider-accepted emails cannot be recalled. Repeat the same request with the same idempotency key when the response is lost.

post/v1/broadcasts/{broadcast_id}/cancel

Request

  • Base URL: https://api.mailrith.com
  • URL: https://api.mailrith.com/v1/broadcasts/{broadcast_id}/cancel
  • Auth: HTTP bearer

Path parameters

broadcast_idstring required

The broadcast identifier.

Headers

Idempotency-Keystring

Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.

Response

Broadcast cancellation accepted or already complete

Changes

No recorded changes to this operation across all 1 revision of this API.