Delete API generated driver-vehicle assignments

Delete driver assignments that were created using the POST fleet/driver-vehicle-assignments endpoint for the requested vehicle in the requested time range.

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.

DELETE /fleet/driver-vehicle-assignments

Delete API generated driver-vehicle assignments

cURL

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

204

This response has no body data.

Authorizations

Authorization · string · header · required

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

Body

application/json

Driver assignments to be deleted

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

Assigned at 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"

endTime · string

An end time 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).

Example:

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

isPassenger · boolean

Indicates if assigned driver is passenger

Example:

true

startTime · string

A start time 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).

Example:

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

Response

204