NAnash
Fleet

Upsert Driver

Create or update a driver in your internal fleet, keyed on your own externalIdentifier. There is no separate create vs. update call — sending the same externalIdentifier again updates the existing driver. The response's created field tells you which happened. To disable a driver, upsert with isShiftActive: false (or enabled: false) — there is no separate delete/disable call.

put/v1/fleet/drivers/upsert

Request

  • Base URL
    https://api.sandbox.usenash.com
  • Auth
    none declared

Request body

externalIdentifierstring required

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

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

emailstring nullable

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.

firstNamestring nullable
lastNamestring nullable
vehicleInfoobject nullable
vehicleIdsstring[] nullable

Existing Vehicle ids to link to this driver.

storeLocationIdsstring[] nullable
firstVersionContractIdsstring[] nullable

Full driver group membership, by first_version_contract_id. Omit or null to leave unchanged. Cannot be combined with addFirstVersionContractIds / removeFirstVersionContractIds.

addFirstVersionContractIdsstring[] nullable

Driver groups to add this driver to; other memberships are kept.

removeFirstVersionContractIdsstring[] nullable

Driver groups to remove this driver from; other memberships are kept.

isShiftActiveboolean

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.

enabledboolean nullable
dateOfBirthstring date nullable
workRelationship'EMPLOYEE' | 'CONTRACTOR'
driversLicensestring nullable

Changes

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