API reference

Devices

3 endpoints under /v1/devices.

List Devices

get/v1/devices

Headers

X-Organization-IDstringoptional

Failures return the error envelope; branch on error_code.

Request

Response

Register Device

post/v1/devices

Register a push device. Idempotent on push_token. Re-registering moves the existing row instead of duplicating it, so it is safe to call on every launch.

Headers

X-Organization-IDstringoptional

Request body

platformstringrequired
push_tokenstringrequired
apns_environmentstringoptional
installation_idstring (uuid)optional

Failures return the error envelope; branch on error_code.

Request

Response

Remove Device

delete/v1/devices/{device_id}

Path parameters

device_idstring (uuid)required

Headers

X-Organization-IDstringoptional

Failures return the error envelope; branch on error_code.

Request

Response