Fleet Management API Beta

Sections

Theme switcher

Update a vehicle

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

vehicle-idstring Required

Vehicle Id.

Min length
1

Body Parameters

asset_typestring Required
Enum values:
ASSETVEHICLEUNKNOWN
company_vehicle_idstring

Customer identifier for the vehicle/asset.

descriptionstring

Description of the vehicle.

detailobject

Show child attributes

fuelobject

Show child attributes

leaseobject

Show child attributes

license_plateobject

Show child attributes

requested_bystring

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

statusobject

Show child attributes

user_defined_fieldsarray

A list of User Defined Fields.

Max items
20

Show child attributes

vehicle_numberstring

Customer identifier for the vehicle/asset

vehicle_prompt_idstring

Vehicle prompt if account is configured for customer defined prompts.

Response

200
Object

Vehicle information.

Response Attributes

_linksobject

HATEOAS links related to the vehicle.

Show child attributes

account_idstring

A unique identifier for the account.

Min length
1
asset_typestring
Enum values:
ASSETVEHICLEUNKNOWN
company_vehicle_idstring

Customer identifier for the vehicle/asset.

date_enteredstring
descriptionstring

Description of the vehicle.

detailobject

Show child attributes

fuelobject

Show child attributes

leaseobject

Show child attributes

license_plateobject

Show child attributes

purchase_device_idstring

Id of the purchase device associated to this vehicle, if any.

requested_bystring

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

setup_datestring

Date the vehicle was set up. Format: YYYY-MM-DDTHH:MM:SSZ.

share_modestring

Indicates the level of vehicle sharing.

statusobject

Show child attributes

user_defined_fieldsarray

A list of User Defined Fields.

Max items
20

Show child attributes

vehicle_idstring
vehicle_numberstring

Customer identifier for the vehicle/asset

vehicle_prompt_idstring

Vehicle prompt if account is configured for customer defined prompts.

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
403
Object

403 (Forbidden)

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?