/tenant

Set driver app settings and photo policies for the organization. Fields left out keep their current values. The answer includes effective settings, with defaults applied. Requires update access to CompanyProfile.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The settings to change; include at least one field.

string
enum

Whether a driver must attach a photo when manually confirming a load instead of scanning it. Absent or optional allows the confirmation without a photo; mandatory requires one. Independent of loadDeviationPhotoPolicy.

Allowed:
string
enum

Whether a driver must take a photo of a load when reporting a deviation for it: a failed pickup or delivery, or a handover with a remark such as damaged or partial quantity. Absent or optional makes the photo possible but not required. With mandatory the driver app asks for the photo before the deviation is confirmed and before the stop is left. The server never refuses a departure; instead an automatic review rule keeps a tour in review while one of its deviations has no photo. Independent of scanExceptionPhotoPolicy.

Allowed:
string
enum

Whether drivers confirm the loads at a pickup stop in Cockpit. Absent or manual keeps the confirmation; automatic counts every pickup load whose shipment has no Scan requirement at that stop as loaded when the driver departs, so the driver confirms only the remaining loads.

Allowed:
boolean

Whether Cockpit automatically recognizes stop arrival and departure from device location. Absent means disabled.

integer
≤ 9007199254740991

Tenant-wide stop geofence radius in meters. Cockpit uses 200 meters when this setting is absent.

Responses

400

The body is empty, names an unknown field, contains null, or has an invalid value

401

Unauthorized

403

The role of the API key does not allow updating CompanyProfile

409

The tenant was changed by another request at the same time and the change could not be applied; send it again

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json