SAsamsara
Driver-Vehicle Assignments

Update API generated driver-vehicle assignments

Update driver assignments that were created using the POST fleet/driver-vehicle-assignments. Identify the assignment either with vehicleId, driverId, and startTime, or with metadata.sourceName alone.

<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 Assignments under the Assignments 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/driver-vehicle-assignments

Request

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

Request body

assignedAtTimestring

The time at which the assignment was made in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

driverIdstring

ID of the driver. This can be either a unique Samsara ID or an external ID for the driver.

endTimestring

The end time in RFC 3339 format. To make this an ongoing assignment (ie. an assignment with no end time), provide an endTime value of 'null'. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

isPassengerboolean

Is this driver a passenger?

startTimestring

The start time in RFC 3339 format that identifies the assignment to update. Required together with vehicleId and driverId, unless metadata.sourceName is provided instead. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

vehicleIdstring

ID of the vehicle. This can be either a unique Samsara ID or an external ID for the vehicle.

Example request

{
  "assignedAtTime": "2019-06-13T19:08:25Z",
  "driverId": "494123",
  "endTime": "2019-06-13T19:08:25Z",
  "isPassenger": true,
  "metadata": {
    "sourceName": "My custom assignment source"
  },
  "startTime": "2019-06-13T19:08:25Z",
  "vehicleId": "281474978683353"
}

Response

Accepted response.

Example response

{
  "data": {
    "message": "Driver assignment was successfully updated"
  }
}

Changes

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