Drivers

Update a driver

Updates a driver from your team. The member must have the "driver" role.

patch/drivers/{driverId}

Request

Base URL
https://api.spoke.com/public/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/spoke/apis/spoke-api/docs/drivers/:driverId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

driverIdstring required

The driver id

Request body

namestring nullable

The driver's full name

displayNamestring nullable

The name displayed for the driver in the UI

depotsstring[] nullable

The depot IDs associated with the driver in the format depots/<id>, duplicates will be ignored. If set to null or not provided, the team's Main depot will be set as driver depot.

Response

The updated driver

idstring required

namestring nullable required

The name of the driver.

emailstring nullable required

The email of the driver.

phonestring nullable required

The phone number of the driver.

displayNamestring nullable required

The display name of the driver.

activeboolean required

Whether the driver membership is active or paused. Paused drivers will not be assigned to any routes.

depotsDepotIdSchema[] required

Depots associated with the driver.

Changes

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