Push

Register this device for notifications

Idempotent: registering an address that is already known updates it in place and returns the same id, so a client can call this on every launch. An address registered under a different account moves to this one — a device only ever belongs to whoever last signed in on it.

post/me/push-devices

Request

  • Base URL: https://bodylab.lol/api/v1
  • URL: https://bodylab.lol/api/v1/me/push-devices
  • Auth: HTTP bearer

Headers

X-Client-Platformstring

The native client's platform, e.g. ios. Server-side and non-native callers omit it.

X-Client-Versionstring

The native client's own semver version. With X-Client-Platform, a version below that platform's minimum is refused with CLIENT_UPGRADE_REQUIRED (426).

Request body

platform'apns' | 'web' required
tokenstring required

APNs: the device token as hex. Web Push: the subscription's endpoint URL.

environment'sandbox' | 'production' nullable

APNs only, and required there: which APNs environment issued the token. A development or TestFlight build gets a sandbox token, an App Store build a production one, and neither works against the other host — the token itself doesn't say which it is, so the client must.

labelstring nullable

How to name this device back to its owner, e.g. "iPhone" or "Firefox on macOS". Display only.

Response

OK

idstring required

Opaque identifier.

Changes

No recorded changes to this operation across all 1 revision of this API.