Push

Register a push device

Changed on

Registers or refreshes a device, typically from your app backend after the app receives its APNs or FCM token. Re-registering a known token reactivates it, refreshes its metadata and moves it to the given contact. An unknown email becomes a contact quietly (no lists, no contact_added sequences). Each contact keeps at most 20 active devices; the least recently seen are retired. Returns 201 for a new token and 200 for an existing one. Requires the subscribers:write scope.

post/push/devices

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/push/devices
  • Auth
    HTTP bearer

Request body

platform'ios' | 'android' | 'web' required
tokenstring required

iOS: the hex APNs device token. Android: the FCM registration token. Web: the PushSubscription endpoint (also send keys).

emailstring

Contact to link. Created quietly when new.

subscriberIdstring

Existing subscriber to link instead of email.

deviceNamestring
appVersionstring
osVersionstring
localestring
timezonestring

IANA timezone.

Response

Device already known and updated

successboolean
createdboolean
messagestring

Example response

{
  "device": {
    "tokenPreview": "…ab12cd34"
  },
  "message": "Device updated."
}

Changes

  • 54f67ac2d016Revision changes
    • warning

      added the new mobile_sdk enum value to the / response property for the response status

    • warning

      added the new mobile_sdk enum value to the / response property for the response status

  • db3873ca3d4dRevision changes
    • info

      endpoint added