Skip to main content
Languages: every operation supports cURL, Node.js (TypeScript), Python, Go, Ruby, and PHP. The first 15 operations on this page show all six languages; the remaining 9 show cURL and TypeScript — the two most-used.

Push API

Mobile push notification delivery and device registration Base path: /api/v1/push Endpoint count: 24

List push notification categories

GET /api/v1/push/categories

Get push notification category by ID

GET /api/v1/push/categories/{id}
string
required

GET /api/v1/push/config

GET /api/v1/push/config

GET /api/v1/push/device-tokens

GET /api/v1/push/device-tokens

List Live Activities

GET /api/v1/push/live-activities
List this tenant’s iOS ActivityKit Live Activities, most recently started first, so the dashboard’s Live Activities tab can render the start → update → end lifecycle. Read-only and tenant-scoped; capped at the same limit as the sibling notifications list.

GET /api/v1/push/notifications

GET /api/v1/push/notifications

GET /api/v1/push/scheduled

GET /api/v1/push/scheduled

GET /api/v1/push/scheduled/

GET /api/v1/push/scheduled/{id}
string
required

GET /api/v1/push/telemetry/summary

GET /api/v1/push/telemetry/summary

POST /api/v1/push/badge/clear

POST /api/v1/push/badge/clear

Create a push notification category

POST /api/v1/push/categories
Per-tenant APNs / FCM notification category. The identifier is wire-bound — the iOS / Android client matches on it — so it cannot be modified after create.

POST /api/v1/push/device-tokens

POST /api/v1/push/device-tokens

POST /api/v1/push/live-activities

POST /api/v1/push/live-activities

POST /api/v1/push/notifications//ack

POST /api/v1/push/notifications/{id}/ack
string
required

POST /api/v1/push/register

POST /api/v1/push/register

POST /api/v1/push/send

POST /api/v1/push/send

Report device-side push wake telemetry

POST /api/v1/push/telemetry
Mobile / web clients call this every ~15min after a push wake to report battery_pct + wake_count + delivery_latency_ms. The dashboard surfaces the aggregate so operators see we don’t drain (UCAAS-GAP-01).

POST /api/v1/push/test-send

POST /api/v1/push/test-send

PUT /api/v1/push/live-activities/

PUT /api/v1/push/live-activities/{id}
string
required

PATCH /api/v1/push/device-tokens/

PATCH /api/v1/push/device-tokens/{id}
string
required

Delete push notification category

DELETE /api/v1/push/categories/{id}
string
required

DELETE /api/v1/push/device-tokens/

DELETE /api/v1/push/device-tokens/{id}
string
required

DELETE /api/v1/push/live-activities/

DELETE /api/v1/push/live-activities/{id}
string
required

DELETE /api/v1/push/scheduled/

DELETE /api/v1/push/scheduled/{id}
string
required