SPspoke
Drivers

Create a new driver

Create a driver with the given data in your team. Prefer using the batch import endpoint for creating multiple drivers at once as it is more efficient, faster.

post/drivers

Request

Request body

namestring nullable

The driver's full name

displayNamestring nullable

The name displayed for the driver in the UI

emailstring email nullable

Driver's email

phonestring nullable

Driver's phone number

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 created 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.