Skip to content

Subscribers API

Base: /api/organizations/{organization_id}/subscribers

Create subscriber

POST /api/organizations/{organization_id}/subscribers
{
  "external_id": "cust_123",
  "name": "Acme Corp"
}
Field Required Rules
name yes 1–255
external_id no unique per org if set

201 — subscriber

409external_id taken

List subscribers

GET /api/organizations/{organization_id}/subscribers

Query (optional):

Param Description
external_id Exact match

200 { "subscribers": [ … ] }

Get subscriber

GET /api/organizations/{organization_id}/subscribers/{subscriber_id}

200

{
  "id": "01H…",
  "external_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 /api/organizations/{organization_id}/subscribers/{subscriber_id}
{
  "name": "Acme Corporation",
  "external_id": "cust_123"
}

200 — subscriber

Delete subscriber

DELETE /api/organizations/{organization_id}/subscribers/{subscriber_id}

204 — deleted

Deletes the subscriber and their subscriptions and overrides.