Skip to main content
PUT
Update alert setting

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Body

application/json

At least one of the flags or limits is required.

geofence
boolean

Record geofence enter and leave alerts. Default false. Example: true

idle
boolean

Record idle alerts (user stopped moving). Default false. Example: true

lateness
boolean

Record predicted task lateness alerts. Default false. Example: false

routeDeviation
boolean

Record route deviation alerts. Default false. Example: false

overspeed
boolean

Record overspeed alerts (user drove above the speed limit). Default false. Example: true

lowBattery
boolean

Record low battery alerts (the phone battery of a user is at or below the battery limit). Default false. Example: true

driverOffline
boolean

Record driver offline alerts (a user on a trip sent no location for the offline limit). Default false.
Example: true

geofenceNotification
boolean

Also send recorded geofence alerts to the notification bell. Default true. Example: true

idleNotification
boolean

Also send recorded idle alerts to the notification bell. Default true. Example: false

latenessNotification
boolean

Also send recorded lateness alerts to the notification bell. Default true. Example: true

routeDeviationNotification
boolean

Also send recorded route deviation alerts to the notification bell. Default true. Example: true

overspeedNotification
boolean

Also send recorded overspeed alerts to the notification bell. Default true. Example: true

lowBatteryNotification
boolean

Also send recorded low battery alerts to the notification bell. Default true. Example: true

driverOfflineNotification
boolean

Also send recorded driver offline alerts, and the second notification when the driver is back online, to the notification bell. Default true.
Example: true

overspeedSpeedKmh
integer

Speed limit of the overspeed alert, in km/h. Only a location update faster than this counts; exactly this speed does not. Whole number from 20 to 200. Default 80. Example: 60

Required range: 20 <= x <= 200
idleDistanceMeters
integer

The user counts as idle when they move less than this distance, in metres, within idleWindowMinutes. Whole number from 10 to 1000. Default 50. Example: 50

Required range: 10 <= x <= 1000
idleWindowMinutes
integer

Time window the idle distance is measured over, in minutes. Whole number from 5 to 120. Default 30. Example: 30

Required range: 5 <= x <= 120
latenessGraceMinutes
integer

A lateness alert is raised when the predicted arrival is more than this many minutes after the planned ETA. Whole number from 0 to 60. Default 2. Example: 2

Required range: 0 <= x <= 60
routeDeviationDistanceMeters
integer

Distance from the planned route that counts as off-route, in metres. Whole number from 76 to 2000. Default 150. Example: 150

Required range: 76 <= x <= 2000
lowBatteryPercent
integer

Battery limit of the low battery alert, in percent. An alert is raised when a location update reports a level at or below this. Whole number from 2 to 60. Default 15. Example: 15

Required range: 2 <= x <= 60
driverOfflineMinutes
integer

Minutes without a location after which a user on a trip is offline. Whole number from 10 to 120. Default 30.
Example: 30

Required range: 10 <= x <= 120

Response

Success

status
boolean

Status of response.

message
string

Message of API response.

data
object

Full alert setting after the update, including the effective thresholds.