Skip to content

Subscribers API

Base: /org/subscribers

A subscriber’s id is the id you already use for that customer. You choose it on create. It is unique per organization and immutable. URL-encode it in paths.

Create subscriber

POST /org/subscribers
{
  "id": "cust_123",
  "name": "Acme Corp"
}
Field Required Rules
id yes 1–255; no spaces or /; unique per org; immutable
name yes 1–255

201 — subscriber

409 — id taken

List subscribers

GET /org/subscribers

Cursor + limit. See Lists.

200

{
  "subscribers": [ … ],
  "has_more": false
}

When has_more is true, pass the last subscriber’s id as starting_after.

Get subscriber

GET /org/subscribers/{subscriber_id}

200 — subscriber · 404 — not found

{
  "id": "cust_123",
  "name": "Acme Corp",
  "created_at": "2026-01-15T12:00:00.000Z",
  "updated_at": "2026-01-15T12:00:00.000Z"
}

Update subscriber

PATCH /org/subscribers/{subscriber_id}
{
  "name": "Acme Corporation"
}

id cannot change.

200 — subscriber

Delete subscriber

DELETE /org/subscribers/{subscriber_id}

204 — deleted

Deletes the subscriber and their subscriptions and overrides.