Broadcasts API

Create a broadcast.

List the team's broadcasts, paged, and optionally filtered by status (DRAFT, PENDING_REVIEW, SCHEDULED, RUNNING, PAUSED, SENT, CANCELED or FAILED), by…

Retrieve one broadcast.

Delete a broadcast.

Schedule a broadcast to send at a time, or now.

Approve a broadcast the key's approval policy held, with the 6-digit code emailed to the key's owner and the team's admins.

Stop a sending broadcast.

Continue a paused broadcast.

The broadcast's results: the same delivered, opened, clicked and unsubscribed figures the broadcast page shows, plus bounces, spam complaints and the…

The sent broadcasts the Migration Center brought over from another provider (Resend, SendGrid or Mailchimp), as read-only history: name, subject, when it…

The Broadcasts list as a spreadsheet, newest first, with the list's filters (status, search, contactBookId): id, name, subject, sender, status, audience,…

Cancel a scheduled, sending or paused broadcast, as Cancel does on the dashboard.

Clicks per link in a sent broadcast, most clicked first: every click (clicks) and how many people clicked it (people).

How many people opened, clicked, bounced and unsubscribed (counts), and the first people who did one of them (event, opened by default), earliest first,…

One row per email the broadcast made, at most 5,000: address, first and last name, delivery status, and whether they opened, clicked or unsubscribed.

Change a draft broadcast's name, sender, subject, preview text, body, audience (contactBookId, segmentId), reply-to, cc or bcc.

Create a DRAFT broadcast with its own copy of a template's subject, preview text and body: changing the template later never changes the broadcast, and…

Replace a draft broadcast's subject, preview text and body with its own copy of a template, as "Choose another template" does on the dashboard.

The dashboard's pre-send review: who it reaches, the sender's domain, the subject, the deliverability check, the unsubscribe link, contacts missing a…

The broadcast rendered through the renderer a send uses, for one contact of its contact book (contactId; a key limited to one domain answers 403…

Who the broadcast goes to, in the order it sends: a book broadcast's subscribed contacts, or a segment broadcast's subscribed matches (live until the…

The free welcome send a team gets when it migrates more than 2,000 contacts by connecting Resend, SendGrid or Mailchimp: one broadcast to its whole…

Create a new DRAFT with the same sender, subject, body and audience as an existing broadcast.