Schedule a broadcast

Requires `write` (`broadcast:send`). Arms a SendBroadcastWorkflow instance that sleeps until `send_at`. Callable from any status except `sending` (including re-scheduling an already-scheduled broadcast, or re-scheduling a terminal one) — see docs/api/broadcast-lifecycle.md §1 for the full state machine.

POST/api/broadcasts/{id}/schedule

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

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

Request Body

send_atstring

ISO 8601 datetime WITH a UTC offset (zod .datetime({ offset: true })).

Formatdate-time

timezone?string

IANA zone name.

Default"UTC"

Response Body

curl -X POST "https://app.stethq.com/api/broadcasts/string/schedule" \
  -H "Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Content-Type: application/json" \
  -d '{
    "send_at": "2019-08-24T14:15:22Z"
  }'

curl -X POST "https://app.stethq.com/api/broadcasts/string/schedule" \  -H "Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "send_at": "2019-08-24T14:15:22Z"  }'

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

{
  "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"
}