Broadcasts

Cancel a broadcast

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.

post/v1/broadcasts/{id}/cancel

Request

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

Path parameters

idstring uuid required

The broadcast id.

Response

A broadcast and how far it has come.

broadcastIdstring uuid required
streamIdstring 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.

fromstring required
subjectstring required
tagstring nullable required
metadataobject required
totalinteger required

Messages stored, after suppressed addresses were dropped.

releasedinteger required

Messages handed to the mail server so far.

failedinteger required

Messages that could not be handed over, cancelled ones included.

suppressedinteger required

Addresses dropped from the list for standing on the stream’s suppression list.

submittedAtstring date-time required
completedAtstring date-time nullable required

Set once nothing is left to send, or on cancel.

Changes

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