Skip to main content
POST
Trigger a broadcast

Authorizations

Authorization
string
header
required

A session token from subscriber login, used by subscriber.dev's own apps. Requests about an environment also need its ID in the x-environment-id header. From your own code, use an API key.

Path Parameters

workflowId
string
required

Body

application/json
audience
object
required
sendOverHours
number

Spread sends evenly over this many hours (max 168) instead of sending as fast as possible. Gentler on sender reputation for large audiences, and leaves time to pause or cancel.

Required range: x <= 168
allowOverPlan
boolean

subscriber.dev cloud: confirm sending to more subscribers than the plan includes, which moves the workspace up one plan after 3 days. Without it, such a broadcast is refused with an explanation; ask the user before setting it.

Response

broadcastId
string
required
status
enum<string>
required
Available options:
pending,
queued,
failed,
paused,
cancelled