Chimely
Api

Create a broadcast (one row, fan-out on read)

One row per announcement targeting the whole environment, regardless of subscriber count. Visible to each subscriber only if the broadcast is created at or after that subscriber's `created_at`.

POST
/v1/broadcasts

One row per announcement targeting the whole environment, regardless of subscriber count. Visible to each subscriber only if the broadcast is created at or after that subscriber's created_at.

Authorization

ApiKeyBearer
AuthorizationBearer <token>

Environment-scoped management API key.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/broadcasts" \  -H "Content-Type: application/json" \  -d '{    "category": "product.update"  }'
{
  "category": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "id": "bcast_01h455vb4pex5vsknk084sn02q",
  "idempotency_key": "string",
  "payload": {
    "action_url": "http://example.com",
    "body": "string",
    "icon_url": "http://example.com",
    "title": "string"
  }
}
{
  "category": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "id": "bcast_01h455vb4pex5vsknk084sn02q",
  "idempotency_key": "string",
  "payload": {
    "action_url": "http://example.com",
    "body": "string",
    "icon_url": "http://example.com",
    "title": "string"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string"
  }
}

Update an admin user's name, role, or disabled state PATCH

Previous Page

Create direct notifications (1–100 recipients, fan-out on write) POST

Creates one notification per recipient in a single transaction together with counter bumps and the outbox job. The `idempotency_key` covers the **whole request**: a retry never partially re-runs the batch. `deliver_at` schedules delivery (max 13 months out): the notification is durable immediately but invisible to the subscriber until then; counters and real-time hints fire at `deliver_at`. Recipients that don't exist yet are lazily created as subscribers. Need more than 100 recipients? That's a broadcast.