---
title: "Update driver app settings"
method: PATCH
path: "/fleet/settings/driver-app"
tags: ["Settings"]
---

# Update driver app settings

`PATCH /fleet/settings/driver-app`

## Request

- Base URL: `https://api.samsara.com`
- URL: `https://api.samsara.com/fleet/settings/driver-app`
- Auth: HTTP bearer

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.

## Request body

- SettingsPatchDriverAppSettingsRequestBody: The configuration settings for the Samsara Driver App. Can be set or updated through the Samsara Settings page or the API at any time.
  - `driverFleetId` string: Global login user name for the fleet driver app
  - `gamification` boolean: 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.
  - `gamificationConfig` DriverAppSettingsGamificationConfigTinyObjectRequestBody: Gamification configuration for the Driver App.
    - `anonymizeDriverNames` boolean: Hide the names of other drivers when viewing the driver leaderboard in the mobile app.
  - `orgVehicleSearch` boolean: Allow drivers to search for vehicles outside of their selection tag when connected to the internet.
  - `trailerSelection` boolean: Allow drivers to see and select trailers in the Samsara Driver app.
  - `trailerSelectionConfig` DriverAppSettingsTrailerSelectionConfigTinyObjectRequestBody: Trailer selection setting configuration for the Driver App.
    - `driverTrailerCreationEnabled` boolean: Allow drivers to create new trailers in the Samsara Driver app.
    - `maxNumOfTrailersSelected` integer: Trailer selection limit.
    - `orgTrailerSearch` boolean: Allow drivers to search for trailers outside of their selection tag when connected to the internet

## Response `200`

OK response.

- SettingsPatchDriverAppSettingsResponseBody
  - `data` DriverAppSettingsResponseObjectResponseBody, required: The configuration settings for the Samsara Driver App. Can be set or updated through the Samsara Settings page or the API at any time.
    - `driverFleetId` string: Login user name for the fleet driver app
    - `gamification` boolean: 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.
    - `gamificationConfig` DriverAppSettingsGamificationConfigTinyObjectResponseBody: Gamification configuration for the Driver App.
      - `anonymizeDriverNames` boolean: Hide the names of other drivers when viewing the driver leaderboard in the mobile app.
    - `orgVehicleSearch` boolean: Allow drivers to search for vehicles outside of their selection tag when connected to the internet.
    - `trailerSelection` boolean: Allow drivers to see and select trailers in the Samsara Driver app.
    - `trailerSelectionConfig` DriverAppSettingsTrailerSelectionConfigTinyObjectResponseBody: Trailer selection setting configuration for the Driver App.
      - `driverTrailerCreationEnabled` boolean: Allow drivers to create new trailers in the Samsara Driver app.
      - `maxNumOfTrailersSelected` integer: Trailer selection limit.
      - `orgTrailerSearch` boolean: Allow drivers to search for trailers outside of their selection tag when connected to the internet

## Other responses

- `401`: Unauthorized response.
- `404`: Not Found response.
- `405`: Method Not Allowed response.
- `413`: Content Too Large response.
- `429`: Too Many Requests response.
- `500`: Internal Server Error response.
- `501`: Not Implemented response.
- `502`: Bad Gateway response.
- `503`: Service Unavailable response.
- `504`: Gateway Timeout response.
- `default`: Bad Request response.

---

[API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)
