Skip to main content
PUT
Upsert Driver

Authorizations

Authorization
string
header
required

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

Body

application/json

PUT /v1/fleet/drivers/upsert request body — see FLE-2224.

Upsert identity is external_identifier, scoped to the calling org's own internal-fleet provider. The required phone links a User who already belongs to the calling organization or creates a new one, so portal roster queries include the driver. A phone owned outside the organization is rejected. The endpoint attaches the organization's driver role and provisions an Auth0 passwordless SMS identity. An optional email provisions the Auth0 email identity on that user.

Wire format is camelCase, matching the rest of Nash's customer-facing REST API (populate_by_name=True also accepts snake_case).

externalIdentifier
string
required

Caller's own id for this driver; the upsert identity key.

phoneNumber
string
required

Required. Links or creates the driver's Nash User record, attaches the driver role, and provisions SMS login. Supply an international number with a leading country code; the value is stored in E.164 form. Does not send a welcome message.

Minimum string length: 1
email
string | null

Optionally provisions a Nash driver-app email login on the phone-linked User, mirroring the portal's own driver create/edit behavior. Omit, null, or blank leaves the existing email unchanged.

firstName
string | null
lastName
string | null
vehicleInfo
Vehicleinfo · object | null
vehicleIds
string[] | null

Existing Vehicle ids to link to this driver.

storeLocationIds
string[] | null
firstVersionContractIds
string[] | null

Driver group membership, by first_version_contract_id. Omit to leave unchanged.

isShiftActive
boolean
default:true

Whether the driver is available. Defaults to true for a newly created driver when omitted; an update call that omits it leaves the existing value unchanged.

enabled
boolean | null
dateOfBirth
string<date> | null
workRelationship
enum<string> | null
Available options:
EMPLOYEE,
CONTRACTOR
driversLicense
string | null

Response

422 - application/json

Unprocessable Content

error
NashErrorDetails · object
required
response_status
string
required
RequestID
string
required