Broadcasts

A broadcast sends a workflow to everyone who matches an audience, such as all opted-in subscribers, rather than one person at a time. You can send it all at once or spread it over up to a week.

Send a broadcast

Pick a workflow and an audience. Spreading the send over a few hours or days is gentler on your email provider and your sending reputation. Or ask your agent: “How many opted-in subscribers would the changelog broadcast reach? Send it to them over the next 48 hours.” It previews the audience before it sends.

echo '{"type": "optedIn"}' > audience.json
subscriber workflows broadcast <workflowId> --audience audience.json --send-over-hours 48

Open Broadcasts, choose the workflow, press b and choose an audience.

Preview the audience, then send:

curl -X POST https://api.subscriber.dev/workflows/$WORKFLOW/broadcast/preview \
  -H "x-api-key: $KEY" -H "content-type: application/json" \
  -d '{"audience": {"type": "optedIn"}}'

curl -X POST https://api.subscriber.dev/workflows/$WORKFLOW/broadcast \
  -H "x-api-key: $KEY" -H "content-type: application/json" \
  -d '{"audience": {"type": "optedIn"}, "sendOverHours": 48}'

Pause, resume or cancel

While a broadcast is still sending, you can pause it, carry on later, or stop it for good. Emails that already went out stay sent.

subscriber workflows broadcasts <workflowId>
subscriber workflows broadcast-pause <workflowId> <broadcastId>
subscriber workflows broadcast-resume <workflowId> <broadcastId>
subscriber workflows broadcast-cancel <workflowId> <broadcastId>

Open Broadcasts, choose the workflow and press h for its broadcasts. On a broadcast, press p to pause, r to resume or c to cancel.

curl -X POST https://api.subscriber.dev/workflows/$WORKFLOW/broadcasts/$BROADCAST/pause \
  -H "x-api-key: $KEY"

Use /resume or /cancel the same way.

Audiences

An audience is who the broadcast goes to. It’s a filter over your subscribers:

Filter	Matches
`{"type": "optedIn"}`	Everyone opted in to email
`{"type": "tag", "tag": "beta"}`	Subscribers with a tag
`{"type": "attribute", "field": "plan", "op": "equals", "value": "pro"}`	A custom attribute that `equals` or `contains` a value, or `exists`
`{"type": "and", "clauses": [...]}`	All of the filters
`{"type": "or", "clauses": [...]}`	Any of the filters
`{"type": "not", "clause": {...}}`	Everyone the filter doesn’t match

For example, opted-in subscribers on the pro plan who aren’t tagged beta:

{
  "type": "and",
  "clauses": [
    { "type": "optedIn" },
    { "type": "attribute", "field": "plan", "op": "equals", "value": "pro" },
    { "type": "not", "clause": { "type": "tag", "tag": "beta" } }
  ]
}

Unsubscribed people are never emailed, whatever the audience says.

Get started

Tools

Guides

Integrations

API reference

Self-hosting

Send a broadcast

Pause, resume or cancel

Audiences

​Send a broadcast

​Pause, resume or cancel

​Audiences

Send a broadcast

Pause, resume or cancel

Audiences