Sign in

v26

latestOpenAPI 3.0.0raw.githubusercontent.com2023-06-09375890.9 KB
Device

Register a device

Register a device, either new or an existing one. If a deviceID changes, send along the old deviceID in oldDeviceID property

post/device

Request body

oldDeviceIDstring

The old deviceID, whenever deviceID changes. Inbox will move to the new deviceID.

appVersionstring
deviceIDstring
deviceStringstring
browserNamestring
browserVersionstring
allowedUIboolean

Device has visible notifications enabled

backgroundAppRefreshboolean

Device has background refresh enabled (iOS only)

bluetoothEnabledboolean

Device has bluetooth enabled

locationServicesAuthStatus'none' | 'use' | 'always'

Device has location permissions granted

locationServicesAccuracyAuth'full' | 'reduced'

Device has location accuracy granted

languagestring
locationAccuracynumber
altitudenumber
coursenumber
speednumber
osStringstring
osVersionstring
platform'iOS' | 'tvOS' | 'Android' | 'Web' | 'Email' | 'SMS'
sdkVersionstring
timeZoneOffsetnumber
transport'APNS' | 'GCM' | 'HMS' | 'WebPush' | 'WebsitePush' | 'Email' | 'SMS' | 'Notificare'
userIDstring

The app-defined user identifier

Example request

{
  "oldDeviceID": "00a9b9bf-c099-45aa-9278-64d6a3f22476",
  "appVersion": "1.0",
  "deviceID": "00a9b9bf-c099-45aa-9278-64d6a3f22476",
  "deviceString": "Chrome 80 | Mac OS X 10.14.6",
  "browserName": "Chrome",
  "browserVersion": "80",
  "language": "nl",
  "location": {
    "coordinates": [
      4.23456,
      52.184884
    ]
  },
  "locationAccuracy": 15.731,
  "altitude": 100,
  "course": 90,
  "speed": 10,
  "osString": "Mac OS X 10.9.2",
  "osVersion": "10.9.2",
  "platform": "Web",
  "sdkVersion": "2.1.1",
  "timeZoneOffset": -5
}

Response

OK