/devices

post

https://api.dev.orbit.do/v5/devices

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

device to create

driverId

string

required

Internal id of the CarrierUser (driver) this device is registered to.

modelName

string

osName

string

osVersion

string

appVersion

string

status

string

enum

required

Registration liveness of the device record. Active devices are eligible to receive push. Independent of the OS permission fields below.

Allowed:

appType

string

enum

Which carrier-facing app registered this device: 'Drive' is the driver mobile app, 'Dispatch' is the carrier web app.

Allowed:

type

string

enum

required

Device platform, fixed to "External" for devices registered through the external API (the in-app clients register as IOS/Android/Web instead).

Allowed:

pushToken

string

webPushEndpoint

string

webPushKeys

object

notificationAuthorizationStatus

string

enum

required

OS-level push-notification permission the user granted to the app. Independent of status: an Active device can still read 'Denied', meaning it is registered but the OS will drop push.

Allowed:

locationTrackingAuthorizationStatus

string

enum

required

OS-level location permission the user granted to the app. Independent of status: an Active device can read 'Denied', meaning live GPS tracking is unavailable even while the device is otherwise usable.

Allowed:

Responses

400

bad request

401

unauthorized

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200created device