Send a broadcast immediately

Requires `write` (`broadcast:send`). Dispatches an immediate SendBroadcastWorkflow instance (`sendAt: null`). If the broadcast is already `scheduled`, pass `confirm=true` to cancel the pending schedule and send now instead (never transits `canceled`); without `confirm=true` this 409s with the active schedule so the caller can prompt for confirmation. 422s if no audience is targeted or an `actions` block has a link-less button (`assertButtonsLinked`).

POST/api/broadcasts/{id}/send-now

Authorization

AuthorizationBearer <token>

A Stet API key (prefix bk_), created under Settings → API keys. The whole API requires the Growth plan or higher; keys are scoped read or write — composing and sending require write.

In: header

Path Parameters

idstring

Query Parameters

confirm?boolean

Confirms a cancel-and-send when the broadcast is already scheduled.

Defaultfalse

Header Parameters

Idempotency-Keystring

Required client-generated key (UUID). Missing → 400 (idempotency-key-required). Replaying a request with the same key returns the original result instead of repeating the side effect; note that this replay layer is best-effort response caching, not a single-flight lock — the send pipeline's atomic claim is the real exactly-once guarantee for a dispatched send.

Formatuuid

Response Body

curl -X POST "https://app.stethq.com/api/broadcasts/string/send-now?confirm=false" \
  -H "Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08"

curl -X POST "https://app.stethq.com/api/broadcasts/string/send-now?confirm=false" \  -H "Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08"

{
  "broadcastId": "string",
  "workflowInstanceId": "string",
  "status": "sending"
}

{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}