Update Vehicle
PATCHhttps://secure.fleetio.com/api/v1/vehicles/:id
Update a Vehicle. If you need to update many Vehicles at once, use the Bulk API to avoid Rate Limiting errors.
Request
Path Parameters
The Fleetio ID of the relevant Vehicle.
You may also look up Vehicles by their VIN, license plate, or other external ID. See the guide on External Vehicle Ids for information on how to set this up.
- application/json
Body
The color of this Vehicle.
Possible values: <= 255 characters
The ID of the Fuel Type associated with this Vehicle.
Possible values: [us_gallons, uk_gallons, liters]
Possible values: >= 1
A pipe delimited group hierarchy. Ex: "Level 1|Level 2|Level 3". Where Level 1 is the parent of Level 2, and 2 is the parent of 3. Any missing nodes in the hierarchy will be created.
The label_id(s) of any Labels to assign to this Vehicle.
If you wish to keep any existing Labels, those IDs must be included in this array as well.
Possible values: >= 1
The license plate number of this Vehicle.
Possible values: <= 255 characters
The name of this Vehicle's manufacturer.
Possible values: <= 255 characters
The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.
Possible values: [km, hr, mi]
The name of the model of this Vehicle.
Possible values: <= 255 characters
A name to assign to this Vehicle. Must be unique.
Possible values: <= 255 characters
Possible values: [owned, leased, rented, customer]
The month in which this Vehicle's registration expires.
Possible values: >= 0 and <= 12
The state, province, or territory in which this Vehicle is registered.
Possible values: <= 255 characters
Indicates whether or not this Vehicle has a secondary meter.
The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.
Possible values: [km, hr, mi]
Possible values: [imperial, metric]
The trim level of this Vehicle.
Possible values: <= 255 characters
Possible values: >= 1
Possible values: >= 1
The Vehicle Identification Number of this Vehicle. Must be unique.
Possible values: <= 17 characters
This Vehicle's model year.
The vehicle_id(s) of any Vehicles to link to this Vehicle.
Possible values: >= 1
purchase_detail_attributes object
Any External IDs associated with this Vehicle.
The name of the Vehicle Status associated with this Vehicle.
Possible values: <= 255 characters
The name of the Vehicle Type associated with this Vehicle.
Possible values: <= 255 characters
The date on which this Vehicle was put into service. We recommend using ISO-8601 formatted dates to avoid ambiguity.
The meter value at which this Vehicle was put into service.
The estimated number of months this Vehicle will be in service.
The estimated number of miles before which this Vehicle will be replaced.
The estimated resale price of this Vehicle.
The date on which this Vehicle was or will be retired. We recommend using ISO-8601 formatted dates to avoid ambiguity.
2023-03-14T13:46:27-06:00The meter value at which this Vehicle was or will be retired.
specs_attributes object
*Full details on working with Custom Fields here.
Responses
- 200
- 401
- 403
- 404
- 422
- 500
OK
Response Headers
- application/json
- Schema
- Example (auto)
Schema
The iso8601 date and time at which the vehicle was archived, for an archived vehicle.
2023-03-14T13:46:27-06:00The name of the Fuel Type associated with this vehicle.
Possible values: [us_gallons, uk_gallons, liters]
The name of the Group associated with this vehicle, for vehicles associated with a group.
This vehicle's name.
Possible values: [Owned, Leased, Rented, Customer]
Possible values: [imperial, metric]
This vehicles Vehicle Type id.
The name of the Vehicle Type associated with this Vehicle.
Indicates whether this Vehicle record is Sample Data.
The id of the Vehicle Status of this vehicle.
The name of the Vehicle Status associated with this Vehicle.
The hex color code of the Vehicle Status associated with this Vehicle.
The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.
Possible values: [km, hr, mi]
The current value of the primary meter for this Vehicle.
The date and time at which the primary meter was last updated.
2023-03-14T13:46:27-06:00The average number of units of the primary meter used per day.
The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.
Possible values: [km, hr, mi]
The current value of the secondary meter for this Vehicle.
The date and time at which the secondary meter was last updated.
2023-03-14T13:46:27-06:00The average number of units of the secondary meter used per day.
The meter value at which this Vehicle was put into service.
The date on which this Vehicle was put into service.
2023-03-14T13:46:27-06:00The meter value at which this Vehicle was or will be retired.
The date on which this Vehicle was or will be retired.
2023-03-14T13:46:27-06:00The estimated number of months this Vehicle will be in service.
The estimated number of miles before which this Vehicle will be replaced.
The estimated resale price of this Vehicle in cents.
The number of Fuel Entries associated with this Vehicle.
Possible values: >= 0
The number of Service Entries associated with this Vehicle.
Possible values: >= 0
The number of Service Reminders associated with this Vehicle.
Possible values: >= 0
The number of Vehicle Renewal Reminders associated with this Vehicle.
Possible values: >= 0
The number of Comments associated with this Vehicle.
Possible values: >= 0
The number of documents attached to this Vehicle.
Possible values: >= 0
The number of images attached to this Vehicle.
Possible values: >= 0
The number of Issues this Vehicle is associated with.
Possible values: >= 0
The number of Work Orders this Vehicle is associated with.
Possible values: >= 0
labels object[]
The ancestry of the Group associated with this Vehicle.
The color of this Vehicle.
The license plate number of this Vehicle.
The Vehicle Identification Number of this Vehicle.
This Vehicle's model year.
The name of this Vehicle's manufacturer.
The name of the model of this Vehicle.
The trim level of this Vehicle.
The month in which this Vehicle's registration expires.
Possible values: >= 0 and <= 12
The state, province, or territory in which this Vehicle is registered.
The URL of a small-sized version of the default image for this Vehicle.
Any External IDs associated with this Vehicle.
Whether this Vehicle has Auto Integrate enabled for it.
Assetable type for Vehicle is always Vehicle for vehicles.
Possible values: [Vehicle]
*Full details on working with Custom Fields here.
The id of the Axle Configuration of this vehicle.
The name of the primary meter for this Vehicle.
The name of the secondary meter for this Vehicle.
The account number for this Vehicle's loan, if applicable.
The date and time at which this Vehicle's loan ends.
2023-03-14T13:46:27-06:00The interest rate for this Vehicle's loan.
Notes about this Vehicle's loan.
The date and time at which this Vehicle's loan began.
Formatted according to ISO-8601 in User's local time.
2023-03-14T13:46:27-06:00Possible values: >= 1
The name of the Vendor for this Vehicle's loan.
The number of inspection schedules this Vehicle is associated with.
Possible values: >= 0
The URL of the default image for this Vehicle.
The URL of a medium-sized version of the default image for this Vehicle.
The URL of a large-sized version of the default image for this Vehicle.
specs object
driver object
current_location_entry objectnullable
{
"id": 0,
"account_id": 0,
"archived_at": "2023-03-14T13:46:27-06:00",
"fuel_type_id": 0,
"fuel_type_name": "string",
"fuel_volume_units": "us_gallons",
"group_id": 0,
"group_name": "string",
"name": "string",
"ownership": "Owned",
"current_location_entry_id": 0,
"system_of_measurement": "imperial",
"vehicle_type_id": 0,
"vehicle_type_name": "string",
"is_sample": true,
"vehicle_status_id": 0,
"vehicle_status_name": "string",
"vehicle_status_color": "string",
"primary_meter_unit": "km",
"primary_meter_value": "string",
"primary_meter_date": "2023-03-14T13:46:27-06:00",
"primary_meter_usage_per_day": "string",
"secondary_meter_unit": "km",
"secondary_meter_value": "string",
"secondary_meter_date": "2023-03-14T13:46:27-06:00",
"secondary_meter_usage_per_day": "string",
"in_service_meter_value": "string",
"in_service_date": "2023-03-14T13:46:27-06:00",
"out_of_service_meter_value": "string",
"out_of_service_date": "2023-03-14T13:46:27-06:00",
"estimated_service_months": 0,
"estimated_replacement_mileage": "string",
"estimated_resale_price_cents": 0,
"fuel_entries_count": 0,
"service_entries_count": 0,
"service_reminders_count": 0,
"vehicle_renewal_reminders_count": 0,
"comments_count": 0,
"documents_count": 0,
"images_count": 0,
"issues_count": 0,
"work_orders_count": 0,
"labels": [
{
"id": 0,
"name": "string"
}
],
"group_ancestry": "string",
"color": "string",
"license_plate": "string",
"vin": "string",
"year": "string",
"make": "string",
"model": "string",
"trim": "string",
"registration_expiration_month": 0,
"registration_state": "string",
"default_image_url_small": "string",
"external_ids": {},
"ai_enabled": true,
"assetable_type": "Vehicle",
"custom_fields": {},
"axle_config_id": 0,
"meter_name": "string",
"secondary_meter_name": "string",
"loan_account_number": "string",
"loan_ended_at": "2023-03-14T13:46:27-06:00",
"loan_interest_rate": 0,
"loan_notes": "string",
"loan_started_at": "2023-03-14T13:46:27-06:00",
"loan_vendor_id": 0,
"loan_vendor_name": "string",
"inspection_schedules_count": 0,
"default_image_url": "string",
"default_image_url_medium": "string",
"default_image_url_large": "string",
"specs": {
"id": 0,
"vehicle_id": 0,
"account_id": 0,
"body_type": "string",
"body_subtype": "string",
"drive_type": "string",
"brake_system": "string",
"msrp_cents": 0,
"fuel_tank_capacity": 0,
"fuel_tank_2_capacity": 0,
"front_track_width": 0,
"ground_clearance": 0,
"height": 0,
"length": 0,
"rear_track_width": 0,
"width": 0,
"wheelbase": 0,
"front_tire_psi": "string",
"rear_tire_psi": "string",
"base_towing_capacity": "string",
"curb_weight": 0,
"gross_vehicle_weight_rating": 0,
"bed_length": "string",
"max_payload": "string",
"rear_axle_type": "string",
"front_tire_type": "string",
"front_wheel_diameter": "string",
"rear_tire_type": "string",
"rear_wheel_diameter": "string",
"epa_city": 0,
"epa_highway": 0,
"epa_combined": 0,
"engine_description": "string",
"engine_brand": "string",
"engine_aspiration": "string",
"engine_block_type": "string",
"engine_bore": "string",
"engine_cam_type": "string",
"engine_compression": "string",
"engine_cylinders": 0,
"engine_displacement": "string",
"fuel_induction": "string",
"fuel_quality": "string",
"max_hp": "string",
"max_torque": "string",
"oil_capacity": "string",
"redline_rpm": "string",
"engine_stroke": "string",
"engine_valves": 0,
"transmission_description": "string",
"transmission_brand": "string",
"transmission_type": "string",
"transmission_gears": 0,
"cargo_volume": 0,
"interior_volume": 0,
"passenger_volume": "string",
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z",
"duty_type": "string",
"weight_class": "string",
"engine_bore_with_units": "string",
"wheelbase_with_units": "string",
"msrp": "string"
},
"driver": {
"id": 0,
"first_name": "string",
"last_name": "string",
"full_name": "string",
"default_image_url": "string"
},
"current_location_entry": {
"id": 0,
"locatable_type": "string",
"locatable_id": 0,
"date": "2024-07-29T15:51:28.071Z",
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z",
"contact_id": 0,
"address": "string",
"is_current": true,
"item_type": "string",
"item_id": 0,
"location": "string",
"address_components": {
"street_number": "string",
"street": "string",
"city": "string",
"region": "string",
"region_short": "string",
"country": "string",
"country_short": "string",
"postal_code": "string"
},
"geolocation": {
"latitude": 0,
"longitude": 0
}
}
}
Request could not be authenticated
- application/json
- Schema
- Example (auto)
Schema
Possible values: >= 400 and <= 599
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Insufficient permission to perform this operation
- application/json
- Schema
- Example (auto)
Schema
Possible values: >= 400 and <= 599
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
The requested resource could not be located
- application/json
- Schema
- Example (auto)
Schema
Possible values: >= 400 and <= 599
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Unprocessable Entity
- application/json
- Schema
- Example (auto)
- Example
Schema
errors object
{
"errors": {}
}
{
"errors": {
"field1": [
"error1",
"error2"
],
"field2": [
"error3"
]
}
}
Something unexpected happened
- application/json
- Schema
- Example (auto)
Schema
Possible values: >= 400 and <= 599
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Authorization: Authorization
name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64". You can generate a new API key [here](https://secure.fleetio.com/api_keys).
name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)
- curl
- ruby
- python
- csharp
- go
- java
- nodejs
- php
- CURL
curl -L -X PATCH 'https://secure.fleetio.com/api/v1/vehicles/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
"color": "string",
"fuel_type_id": 0,
"fuel_volume_units": "us_gallons",
"group_id": 0,
"group_hierarchy": "string",
"label_ids": [
0
],
"license_plate": "string",
"make": "string",
"meter_unit": "km",
"model": "string",
"name": "string",
"ownership": "owned",
"registration_expiration_month": 0,
"registration_state": "string",
"secondary_meter": true,
"secondary_meter_unit": "km",
"system_of_measurement": "imperial",
"trim": "string",
"vehicle_status_id": 0,
"vehicle_type_id": 0,
"vin": "string",
"year": 0,
"linked_vehicle_ids": [
0
],
"purchase_detail_attributes": {
"comment": "string",
"date": "2024-07-29T15:51:28.071Z",
"price": 0,
"vendor_id": 0,
"warranty_expiration_date": "2024-07-29T15:51:28.071Z",
"warranty_expiration_meter_value": 0,
"meter_entry_attributes.value": 0,
"meter_entry_attributes.void": true
},
"external_ids": {},
"vehicle_status_name": "string",
"vehicle_type_name": "string",
"in_service_date": "2024-07-29T15:51:28.071Z",
"in_service_meter": 0,
"estimated_service_months": 0,
"estimated_replacement_mileage": 0,
"estimated_resale_price": 0,
"out_of_service_date": "2023-03-14T13:46:27-06:00",
"out_of_service_meter": 0,
"specs_attributes": {
"base_towing_capacity": 0,
"bed_length": 0,
"body_subtype": "string",
"body_type": "string",
"brake_system": "string",
"cargo_volume": 0,
"curb_weight": 0,
"drive_type": "string",
"engine_aspiration": "string",
"engine_block_type": "string",
"engine_bore": 0,
"engine_brand": "string",
"engine_cam_type": "string",
"engine_compression": 0,
"engine_cylinders": 0,
"engine_description": "string",
"engine_displacement": 0,
"engine_stroke": 0,
"engine_valves": 0,
"epa_city": 0,
"epa_combined": 0,
"epa_highway": 0,
"front_tire_psi": 0,
"front_tire_type": "string",
"front_track_width": 0,
"front_wheel_diameter": "string",
"fuel_induction": "string",
"fuel_quality": "string",
"fuel_tank_capacity": 0,
"fuel_tank_2_capacity": 0,
"gross_vehicle_weight_rating": 0,
"ground_clearance": 0,
"height": 0,
"interior_volume": 0,
"length": 0,
"max_hp": 0,
"max_payload": 0,
"max_torque": 0,
"msrp": 0,
"oil_capacity": 0,
"passenger_volume": "string",
"rear_axle_type": "string",
"rear_tire_psi": 0,
"rear_tire_type": "string",
"rear_track_width": 0,
"rear_wheel_diameter": "string",
"redline_rpm": "string",
"transmission_brand": "string",
"transmission_description": "string",
"transmission_gears": 0,
"transmission_type": "string",
"wheelbase": 0,
"width": 0
},
"custom_fields": {}
}'
Click the Send API Request button above and see the response here!