Update default event settings

Update the default event settings for all devices in an organization. These settings apply to all devices currently in the organization and any devices added in the future.
Note: This API call only updates the existing event settings object with the values provided in the request payload. If no values are provided, the existing settings are deleted.

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

vehicleType required	string (Vehicle type) The type of vehicle associated with the device. The type of vehicle affects the sensitivity of the device's motion sensor. Private is the most sensitive to movements, and trailer is the least sensitive. Enum: "Private" "Van" "Trailer"
required	Array of objects (Event settings) The events array.

Responses

200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

500

Internal server error

post/organizations/{orgId}/event-settings

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"vehicleType": "Private",
"events": [{"eventType": "cellPhoneUse",
"dataType": "none",
"weight": 3,
"speedLimit": 120,
"numberOfBeeps": 2,
"minimumSpeed": 60,
"config": {"headwayAlertDayThreshold": 2000,
"headwayAlertNightThreshold": 3000,
"headwayAlertTime": 3000,
"timeWindow": 0,
"numberOfYawns": 1,
"assumeMoving": false
},
"laneWeavingTimes": 3,
"laneWeavingDurationSeconds": 30,
"drivingDuration": 8,
"visualAlert": true,
"audioAlert": true
}
]
}

Response samples

application/json

{"requestId": "df5fg-45fgfdsg-45fg-45454"
}