bzzz/docs

Devices

Register iOS devices and manage subscriptions. These endpoints are unauthenticated and used by the bzzz iOS app.

Register a device

POST /v1/devices

bash
curl -X POST https://api.bzzz.sh/v1/devices \
  -H "Content-Type: application/json" \
  -d '{ "apnsToken": "abc123...", "platform": "ios" }'

Response

json
{ "deviceUuid": "clx..." }

Subscribe to an organization

POST /v1/devices/{deviceUuid}/subscriptions

bash
curl -X POST https://api.bzzz.sh/v1/devices/DEVICE_UUID/subscriptions \
  -H "Content-Type: application/json" \
  -d '{ "orgSlug": "my-org", "externalId": "usr_123" }'

The externalId is optional. When set, the org can target this specific user with notifications.

Unsubscribe

DELETE /v1/devices/{deviceUuid}/subscriptions/{orgSlug}

bash
curl -X DELETE https://api.bzzz.sh/v1/devices/DEVICE_UUID/subscriptions/my-org

Returns 204 No Content on success.