Update default privacy mode configurations (BETA)

This call is currently in BETA. Contact your Technical Account Manager for more information.

Update default privacy mode configurations for all devices in an organization. These settings apply to all devices currently in the organization and any devices added in the future.
Note:
1. This API call only updates the privacy mode configuration object with the values provided in the requested payload. Any values not provided in the request will remain the same.
2. If an organization profile is enabled, the updated values will be set for all devices in this organization. Any values not provided, will not be updated in the privacy mode' settings.

Request
Security:
bearerAuth
path Parameters
orgId
required
string

The ID of the organization. Obtain this from GET /organizations.

Example: 62
Request Body schema: application/json
gpsTracking
string
Default: "disabled"

When disabled, GPS readings will not be sent to the cloud, GPS data will not be written on media sent to the cloud, trip data will not be available, and events will be created and reported without a location.

Enum: "enabled" "disabled"
liveVideo
string
Default: "disabled"

When disabled, live video from the device is not supported.

Enum: "enabled" "disabled"
cabinEvents
string
Default: "disabled"

Enable/Disable in-cabin MVAI events creation.

Events included:

  • distractedDriving
  • smoking
  • foodDrink
  • cellPhoneUse
  • driverUnbelted
  • obstruction
  • possibleFatigue
  • fatigue
  • passengerUnbelted
  • passengerLimit
  • yawn

    • Enum: "enabled" "disabled"
    cabinLensVideo
    string
    Default: "disabled"

    When disabled, the in-cabin lens video will not be recorded on the device, nor attached to created events.
    NOTE: In the event of an accidents during this time, there will not be any video records available.

    Enum: "enabled" "disabled"
    cabinBeepAlerts
    string
    Default: "disabled"

    In-cabin audio and visual alerts to alert the driver prior to event creation.
    NOTE: In-cabin audio alerts to alert the driver prior to event creation. visual alerts are currently not configurable through privacy mode settings.

    Enum: "enabled" "disabled"
    voiceRecording
    string
    Default: "disabled"

    Audio recording on a device.

    Enum: "enabled" "disabled"
    roadAndAuxEvents
    string
    Default: "disabled"

    ADAS events creation.

    Events included:

  • tailgating
  • laneWeaving
  • followingDistance
  • criticalDistance
  • rollingStop

    • Enum: "enabled" "disabled"
    roadAndAuxLensVideo
    string
    Default: "disabled"

    When disabled, road-facing and AUX lenses videos will not be recorded on the device, nor attached to created events.

    Enum: "enabled" "disabled"
    accelerationEvents
    string
    Default: "disabled"

    Enable/disable events generated based on acceleration.

    Events included:

  • deceleration
  • acceleration
  • sharpTurnLeft
  • sharpTurnRight

    • Enum: "enabled" "disabled"
    gSensorEvents
    string
    Default: "disabled"

    Enable/disable events generated based on the gSensor.

    Events included:

  • jolt
  • accident
  • gsensorRegular
  • gsensorHigh

    • Enum: "enabled" "disabled"
    virtualEvent
    string
    Default: "disabled"

    Enable/disable virtual events.

    Enum: "enabled" "disabled"
    otherEvents
    string
    Default: "disabled"

    Enable/disable other events.

    Events included:

  • button
  • speedLimit
  • geoFence
  • wrongPinCode
  • qrCode
  • driverCheckIn
  • driverCheckOut
  • noCheckIn

    • Enum: "enabled" "disabled"
    Responses
    200

    Successful operation

    400

    Bad request error

    401

    Unauthorized error

    403

    Forbidden error

    500

    Internal server error

    patch/organizations/{orgId}/privacy-config
    Request samples
    application/json
    {
    • "gpsTracking": "enabled",
    • "liveVideo": "enabled",
    • "cabinEvents": "enabled",
    • "cabinLensVideo": "enabled",
    • "cabinBeepAlerts": "enabled",
    • "voiceRecording": "enabled",
    • "roadAndAuxEvents": "enabled",
    • "roadAndAuxLensVideo": "enabled",
    • "accelerationEvents": "enabled",
    • "gSensorEvents": "enabled",
    • "virtualEvent": "enabled",
    • "otherEvents": "enabled"
    }
    Response samples
    application/json
    {
    • "requestId": "06327cae-e075-42ca-b620-c5cfdd3b4e37",
    • "data": {
      }
    }