Skip to main content
POST
Pause 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
broadcastId
string
required

Response

publicId
string
required
status
enum<string>
required

completed: every matched subscriber has a run and no sends are pending.

Available options:
pending,
queued,
failed,
paused,
cancelled,
completed
matchedCount
number | null
required
sendOverHours
number | null
required
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$