stet
API reference

Create a draft broadcast

Requires a `write`-scope key (capability `broadcast:compose`). Optionally seeds blocks from a known `templateId`.

POST/api/broadcasts

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

Header Parameters

Idempotency-Key?string

Optional client-generated key (UUID). Replaying a request with the same key returns the original result instead of repeating the side effect.

Formatuuid

Request Body

title?string
Default""
Lengthlength <= 200
sendingProfileIdstring
Length1 <= length
audienceIds?array<string>

Must be saved-kind audiences owned by this workspace; a one-time group can't be targeted here.

Default[]
templateId?string

Optional starter-template id; unknown ids 400.

Length1 <= length

Response Body

curl -X POST "https://app.stethq.com/api/broadcasts" \  -H "Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "sendingProfileId": "string"  }'
{
  "id": "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"
}

Append a block

Requires `write` (`broadcast:compose`). Draft-only — `409` on any other status.

Create a sending profile

Requires `write` (`sending_profile:manage`). `avatarUrl`, if set, must already be an absolute URL from `POST /api/sending-profiles/avatar`.