Fleet Management API Beta

Sections

Theme switcher

Update a Driver by id

Header Parameters

user_idstring

Optional audit field that indicates the User that performed a change. This field cannot be updated directly without appropriate permission - it is automatically set to the clientId of the authenticated User making the request.

Authorizationstring

Path Parameters

driver-idstring Required

Driver Id

Min length
1

Body Parameters

contactallof

Driver contact information.

Show child attributes

driver_licenseobject

Driver license information.

Show child attributes

home_reimbursement_requested_statusstring

Status of a drivers request for home reimbursement if account has EV enabled. REQUESTED and DISABLED values can currently be used to change home reimbursement status. Other values are informational only.

prompt_idstring

Driver prompt Id. Required if account is setup as customer assigned DID.

requested_bystring

Name of the person or process who updated this vehicle and the date it was requested.

statusobject

Driver status information.

Show child attributes

user_defined_fieldsarray

A list of User Defined Fields.

Max items
20

Show child attributes

Response

200
Object

200 (OK)

Response Attributes

_linksobject

HATEOAS links related to the driver.

Show child attributes

account_idstring

A unique identifier for the account.

Min length
1
contactallof

Driver contact information.

Show child attributes

driver_idstring

Driver id.

driver_licenseobject

Driver license information.

Show child attributes

driver_numberstring

Number assigned to driver.

evobject

Electric vehicle information

Show child attributes

last_updatedstring

The date and time this object was updated in the format: YYYY-MM-DDTHH:MM:SSZ.

prompt_idstring

Id of driver prompt.

purchase_device_idstring

The id of the card this driver is associated with, if any.

requested_bystring

Id of user updating the driver.

share_modestring

Indicates the level of vehicle sharing.

statusallof

Driver status information.

Show child attributes

user_defined_fieldsarray

A list of User Defined Fields.

Max items
20

Show child attributes

400
Object

400 (Bad Request)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
401
Object

401 (Unauthorized)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
500
Object

500 (Internal Server Error)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
Was this section helpful?

PATCH

/

Select
1

Response

Was this section helpful?