Create a new driver-vehicle assignment

Assign vehicle drive-time to a driver via API. For a step-by-step instruction on how to leverage this endpoint, see this guide

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Assignments under the Assignments category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

POST /fleet/driver-vehicle-assignments

Create a new driver-vehicle assignment

cURL

curl --request POST \
  --url https://api.samsara.com/fleet/driver-vehicle-assignments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "driverId": "494123",
  "vehicleId": "281474978683353",
  "assignedAtTime": "2019-06-13T19:08:25Z",
  "endTime": "2019-06-13T19:08:25Z",
  "isPassenger": true,
  "metadata": {
    "sourceName": "My custom assignment source"
  },
  "startTime": "2019-06-13T19:08:25Z"
}
'

201

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Driver Assignment to be created

driverId · string · required

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

Example:

"494123"

vehicleId · string · required

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

Example:

"281474978683353"

assignedAtTime · string

The time at which the assignment was made in RFC 3339 format. Defaults to now if not provided. 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).

Example:

"2019-06-13T19:08:25Z"

endTime · string

The end time in RFC 3339 format. Defaults to max-time (meaning it's an ongoing assignment) if not provided. 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).

Example:

"2019-06-13T19:08:25Z"

isPassenger · boolean

Is this driver a passenger? Defaults to false if not provided

Example:

true

metadata · object

Metadata about this driver assignment

Show child attributes

startTime · string

The start time in RFC 3339 format. Defaults to now if not provided. 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).

Example:

"2019-06-13T19:08:25Z"

Response

201

application/json

Created response.

data · object · required

Response after successfully submitting a Driver Assignment

Show child attributes