Update device settings

Update the device settings.

Note: PUT calls update data entirely. Any data not mentioned in the call, will be deleted.

Request

Security:

bearerAuth

path Parameters

imei

required

string (IMEI)

The IMEI of the device. The IMEI number can be found on a sticker on the device itself or on the back of the device box.

Example: 357660101000198

Request Body schema: application/json

	object The road-facing ADAS calibration status.
	object Distracted driver alerts
	object Live video streaming
	object In-cab lens
	object Text overlay for recordings
	object In-cab recording.
	object Side of driver seat
	object Speed units
	object Audio alerts
	object Live video streaming notification
	object Admin PIN
	object Driver PIN
	object Screen brightness
	object Date and time units
	object Audio recording
	object Standby
	object (hotSpot) Internet access
	object Recording encryption
	object Privacy settings (These settings are in use until the first time the device privacy mode is enabled or disabled")
	object Driver identification code
	object QR code driver identification
	object Driver idenfication with qrDi or pinCodeDi is enabled
	object When virtual ignition is enabled, the device enters and exits standby mode based on motion. When disabled, the device enters and exits standby mode based on the vehicle ignition.
	object Screen timeout
	object Passenger Limit
	object The message to inform the driver they are being recorded, after the device wakes up.
	object Enable LED functionality for AI-14 devices. This feature is available for AI-14 devices with firmware 14.2.111 or above.
	object Enable or disable device retrieval of time zone information from the cloud, based on GPS location.

Responses

200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

put/devices/{imei}/device-config

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"adas": {"value": true
},
"distractedDriver": {"value": true
},
"liveVideo": {"value": true
},
"driverCamera": {"value": true
},
"textOverlay": {"value": true
},
"inCabinCameraRecording": {"value": true
},
"driverPosition": {"value": "left"
},
"speedUnits": {"value": "mph"
},
"audioAlarms": {"value": true
},
"notifyLiveStreaming": {"value": true
},
"adminPin": {"value": "1234"
},
"driverPin": {"value": "4321"
},
"brightness": {"value": 128
},
"dateTimeUnits": {"value": "us"
},
"voiceRecording": {"value": true
},
"standby": {"timeout": 10
},
"hotSpot": {"internetAccess": false,
"hotspotEnabled": true
},
"recordingEncryption": {"enabled": true,
"password": "0123456789ABCDEF"
},
"privacy": {"gpsEnabled": true,
"mvaiEnabled": true,
"liveStreamEnabled": true,
"allEventsEnabled": true,
"cameras": [{"cameraId": 1,
"recordingEnabled": true,
"eventsEnabled": true
}
]
},
"pinCodeDi": {"value": true
},
"qrDi": {"value": true
},
"driverIdentification": {"driverPrompt": true,
"audioAlert": true,
"driverPromptDurationSeconds": 30
},
"virtualIgnition": {"value": true
},
"screenTimeout": {"value": 120
},
"passengerLimit": {"value": 1
},
"wakeupMsg": {"enabled": true,
"timeout": 10
},
"ledEnabled": {"value": true
},
"setTimezoneByCloud": {"value": true
}
}

Response samples

application/json

{"data": {"effectedImeis": ["357660101000198"
],
"config": {"adas": {"value": true
},
"distractedDriver": {"value": true
},
"liveVideo": {"value": true
},
"driverCamera": {"value": true
},
"textOverlay": {"value": true
},
"inCabinCameraRecording": {"value": true
},
"driverPosition": {"value": "left"
},
"speedUnits": {"value": "mph"
},
"audioAlarms": {"value": true
},
"notifyLiveStreaming": {"value": true
},
"adminPin": {"value": "1234"
},
"driverPin": {"value": "4321"
},
"brightness": {"value": 128
},
"dateTimeUnits": {"value": "us"
},
"voiceRecording": {"value": true
},
"standby": {"timeout": 10
},
"hotSpot": {"internetAccess": false,
"hotspotEnabled": true
},
"recordingEncryption": {"enabled": true
},
"privacy": {"gpsEnabled": true,
"mvaiEnabled": true,
"liveStreamEnabled": true,
"allEventsEnabled": true,
"cameras": [{"cameraId": 1,
"recordingEnabled": true,
"eventsEnabled": true
}
]
},
"pinCodeDi": {"value": true
},
"qrDi": {"value": true
},
"setTimezoneByCloud": {"value": true
}
}
},
"requestId": "06327cae-e075-42ca-b620-c5cfdd3b4e37"
}