Broadcasts

Send a broadcast

Stores the content once and one message per entry of messages, up to 50,000, on a broadcast stream, in one transaction. Each message is a message in the log with its own events and webhooks, sent with the recipient’s own unsubscribe link where {{ unsubscribe_url }} stands. Each message may carry substitutions, up to 20 strings that replace {{ key }} in the subject, the text and the HTML, escaped in the HTML; a key the content names must be given by every message. Addresses on the stream’s suppression list are dropped and counted; a list with nothing left, a missing placeholder, a missing substitution, a transactional or archived stream and a count over the monthly cap are refused whole. The Idempotency-Key is required: a retry under the same key answers the same broadcast.

post/v1/broadcasts

Request

  • Base URL: https://api.sendora.se
  • URL: https://api.sendora.se/v1/broadcasts
  • Auth: HTTP bearer

Headers

idempotency-keystring required

Any text of 1 to 255 printable characters that identifies this broadcast; the same key with a different body is refused.

Request body

streamIdstring uuid required

The broadcast stream of this server the messages go on.

subjectstring required

The subject line.

textstring

The plain-text part, with {{ unsubscribe_url }} where the link goes. At least one of text and html is required.

htmlstring

The HTML part, with {{ unsubscribe_url }} where the link goes.

headersobject

Custom headers on every message, at most 20. The List-Unsubscribe pair is Sendora’s too. Sendora writes these itself, so a message may not set them: From, Sender, To, Cc, Bcc, Subject, Date, Message-ID, MIME-Version, Return-Path, Received, Delivered-To, DKIM-Signature, DomainKey-Signature, Authentication-Results, Received-SPF, and any name that starts with Content-, Resent-, ARC- or X-Kumo.

tagstring nullable

A label of up to 100 characters, returned with the message and its events.

metadataobject

Up to 20 key-value pairs of your own, on the broadcast and on every message.

Response

The broadcast was stored; Sendora sends its messages from here.

broadcastIdstring uuid required

The id the messages, the progress and the cancel refer to.

status'accepted' required
totalinteger required

Messages stored; each is a message in the log.

suppressedinteger required

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

submittedAtstring date-time required
testboolean required

True when the server is a test server: the messages go through everything but delivery, and nobody receives them.

Changes

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