SAsamsara
Settings

Update driver app settings

Update driver app settings.

<b>Rate limit:</b> 100 requests/min (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Write Driver App Settings under the Drivers category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

patch/fleet/settings/driver-app

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Request body

driverFleetIdstring

Global login user name for the fleet driver app

gamificationboolean

Driver gamification feature. Enabling this will turn on the feature for all drivers using the mobile app. Drivers can be configured into peer groups within the Drivers Page. Unconfigured drivers will be grouped on an organization level.

orgVehicleSearchboolean

Allow drivers to search for vehicles outside of their selection tag when connected to the internet.

trailerSelectionboolean

Allow drivers to see and select trailers in the Samsara Driver app.

Example request

{
  "driverFleetId": "abc-trucking-co",
  "orgVehicleSearch": true
}

Response

OK response.

Example response

{
  "data": {
    "driverFleetId": "abc_trucking_co",
    "gamificationConfig": {
      "anonymizeDriverNames": true
    },
    "trailerSelectionConfig": {
      "driverTrailerCreationEnabled": true
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.