FLfleetio
Vehicles

Update Vehicle

Changed on

Update a Vehicle. If you need to update many Vehicles at once, use the Bulk API to avoid Rate Limiting errors.

patch/vehicles/{id}

Request

Path parameters

idstring required

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.

Request body

colorstring

The color of this Vehicle.

fuel_type_idinteger

The ID of the Fuel Type associated with this Vehicle.

fuel_volume_units'us_gallons' | 'uk_gallons' | 'liters'
group_idinteger
group_hierarchystring

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.

label_idsId[]

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.

license_platestring

The license plate number of this Vehicle.

makestring

The name of this Vehicle's manufacturer.

meter_unit'km' | 'hr' | 'mi' nullable

The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.

modelstring

The name of the model of this Vehicle.

namestring

A name to assign to this Vehicle. Must be unique.

ownership'owned' | 'leased' | 'rented' | 'customer' | 'financed' | 'rent_to_own'
registration_expiration_monthinteger

The month in which this Vehicle's registration expires.

registration_statestring

The state, province, or territory in which this Vehicle is registered.

secondary_meterboolean

Indicates whether or not this Vehicle has a secondary meter.

secondary_meter_unit'km' | 'hr' | 'mi' nullable

The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.

system_of_measurement'imperial' | 'metric'
trimstring

The trim level of this Vehicle.

vehicle_status_idinteger
vehicle_type_idinteger
vinstring

The Vehicle Identification Number of this Vehicle. Must be unique.

yearinteger

This Vehicle's model year.

linked_vehicle_idsId[]

The vehicle_id(s) of any Vehicles to link to this Vehicle.

external_idsobject

Any External IDs associated with this Vehicle.

vehicle_status_namestring

The name of the Vehicle Status associated with this Vehicle.

vehicle_type_namestring

The name of the Vehicle Type associated with this Vehicle.

in_service_datestring date-time

The date on which this Vehicle was put into service. We recommend using ISO-8601 formatted dates to avoid ambiguity.

in_service_meternumber float

The meter value at which this Vehicle was put into service.

estimated_service_monthsinteger

The estimated number of months this Vehicle will be in service.

estimated_replacement_mileagenumber float

The estimated number of miles before which this Vehicle will be replaced.

estimated_resale_pricenumber float

The estimated resale price of this Vehicle.

out_of_service_datestring date-time

The date on which this Vehicle was or will be retired. We recommend using ISO-8601 formatted dates to avoid ambiguity.

out_of_service_meternumber float

The meter value at which this Vehicle was or will be retired.

custom_fieldsCustomFields nullable

*Full details on working with Custom Fields here.

Example request

{
  "out_of_service_date": "2023-03-14T13:46:27-06:00"
}

Response

OK

idinteger
account_idinteger
archived_atstring date-time nullable

The iso8601 date and time at which the vehicle was archived, for an archived vehicle.

fuel_type_idinteger nullable
fuel_type_namestring nullable

The name of the Fuel Type associated with this vehicle.

fuel_volume_units'us_gallons' | 'uk_gallons' | 'liters'
group_idinteger nullable
group_namestring nullable

The name of the Group associated with this vehicle, for vehicles associated with a group.

namestring

This vehicle's name.

ownership'owned' | 'leased' | 'rented' | 'customer' | 'financed' | 'rent_to_own'
current_location_entry_idinteger nullable
system_of_measurement'imperial' | 'metric'
vehicle_type_idinteger

This vehicles Vehicle Type id.

vehicle_type_namestring

The name of the Vehicle Type associated with this Vehicle.

is_sampleboolean

Indicates whether this Vehicle record is Sample Data.

vehicle_status_idinteger

The id of the Vehicle Status of this vehicle.

vehicle_status_namestring

The name of the Vehicle Status associated with this Vehicle.

vehicle_status_colorstring nullable

The hex color code of the Vehicle Status associated with this Vehicle.

primary_meter_unit'km' | 'hr' | 'mi' nullable

The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.

primary_meter_valuestring nullable

The current value of the primary meter for this Vehicle.

primary_meter_datestring date-time nullable

The date and time at which the primary meter was last updated.

primary_meter_usage_per_daystring nullable

The average number of units of the primary meter used per day.

secondary_meter_unit'km' | 'hr' | 'mi' nullable

The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.

secondary_meter_valuestring nullable

The current value of the secondary meter for this Vehicle.

secondary_meter_datestring date-time nullable

The date and time at which the secondary meter was last updated.

secondary_meter_usage_per_daystring nullable

The average number of units of the secondary meter used per day.

in_service_meter_valuestring nullable

The meter value at which this Vehicle was put into service.

in_service_datestring date-time nullable

The date on which this Vehicle was put into service.

out_of_service_meter_valuestring nullable

The meter value at which this Vehicle was or will be retired.

out_of_service_datestring date-time nullable

The date on which this Vehicle was or will be retired.

estimated_service_monthsinteger nullable

The estimated number of months this Vehicle will be in service.

estimated_replacement_mileagestring nullable

The estimated number of miles before which this Vehicle will be replaced.

estimated_resale_price_centsinteger nullable

The estimated resale price of this Vehicle in cents.

fuel_entries_countinteger

The number of Fuel Entries associated with this Vehicle.

service_entries_countinteger

The number of Service Entries associated with this Vehicle.

service_reminders_countinteger

The number of Service Reminders associated with this Vehicle.

vehicle_renewal_reminders_countinteger

The number of Vehicle Renewal Reminders associated with this Vehicle.

comments_countinteger

The number of Comments associated with this Vehicle.

documents_countinteger

The number of documents attached to this Vehicle.

images_countinteger

The number of images attached to this Vehicle.

issues_countinteger

The number of Issues this Vehicle is associated with.

work_orders_countinteger

The number of Work Orders this Vehicle is associated with.

group_ancestrystring nullable

The ancestry of the Group associated with this Vehicle.

colorstring nullable

The color of this Vehicle.

license_platestring nullable

The license plate number of this Vehicle.

vinstring nullable

The Vehicle Identification Number of this Vehicle.

yearnumber nullable

This Vehicle's model year.

makestring nullable

The name of this Vehicle's manufacturer.

modelstring nullable

The name of the model of this Vehicle.

trimstring nullable

The trim level of this Vehicle.

registration_expiration_monthinteger nullable

The month in which this Vehicle's registration expires.

registration_statestring nullable

The state, province, or territory in which this Vehicle is registered.

default_image_url_smallstring nullable

The URL of a small-sized version of the default image for this Vehicle.

external_idsobject

Any External IDs associated with this Vehicle.

ai_enabledboolean

Whether this Vehicle has Auto Integrate enabled for it.

assetable_type'Vehicle'

Assetable type for Vehicle is always Vehicle for vehicles.

custom_fieldsCustomFields nullable

*Full details on working with Custom Fields here.

axle_config_idinteger nullable

The id of the Axle Configuration of this vehicle.

meter_namestring

The name of the primary meter for this Vehicle.

secondary_meter_namestring

The name of the secondary meter for this Vehicle.

loan_account_numberstring nullable

The account number for this Vehicle's loan, if applicable.

loan_ended_atstring date-time nullable

The date and time at which this Vehicle's loan ends.

loan_interest_ratenumber float nullable

The interest rate for this Vehicle's loan.

loan_notesstring nullable

Notes about this Vehicle's loan.

loan_started_atstring date-time nullable

The date and time at which this Vehicle's loan began. Formatted according to ISO-8601 in User's local time.

loan_vendor_idinteger nullable
loan_vendor_namestring nullable

The name of the Vendor for this Vehicle's loan.

inspection_schedules_countinteger

The number of inspection schedules this Vehicle is associated with.

default_image_urlstring nullable

The URL of the default image for this Vehicle.

default_image_url_mediumstring nullable

The URL of a medium-sized version of the default image for this Vehicle.

default_image_url_largestring nullable

The URL of a large-sized version of the default image for this Vehicle.

Example response

{
  "archived_at": "2023-03-14T13:46:27-06:00",
  "primary_meter_date": "2023-03-14T13:46:27-06:00",
  "secondary_meter_date": "2023-03-14T13:46:27-06:00",
  "in_service_date": "2023-03-14T13:46:27-06:00",
  "out_of_service_date": "2023-03-14T13:46:27-06:00",
  "loan_ended_at": "2023-03-14T13:46:27-06:00",
  "loan_started_at": "2023-03-14T13:46:27-06:00"
}

Changes

  • 49558d744bd7Revision changes
    • info

      added the new optional request property

  • 4098a1c81821Revision changes
    • breaking

      the // response's property type changed from string to number, and format from no format to float for status

    • breaking

      the // response's property type changed from string to number, and format from no format to float for status

    • breaking

      the // response's property type changed from string to number, and format from no format to float for status

    • breaking

      the // response's property type changed from string to number, and format from no format to float for status

    • breaking

      the // response's property type changed from string to number, and format from no format to float for status

    • breaking

      the // response's property type changed from string to integer for status

    • breaking

      the // response's property type changed from string to number, and format from no format to float for status

    • breaking

      the // response's property type changed from string to integer for status

    • breaking

      the // response's property type changed from string to number, and format from no format to float for status

    • breaking

      the / response's property type changed from string to number for status

    • breaking

      the // response's property type changed from string to number, and format from no format to float for status

    • breaking

      the // response's property type changed from string to number, and format from no format to float for status

    • breaking

      the // response's property type changed from string to number, and format from no format to float for status

    • breaking

      the // response's property type changed from string to number, and format from no format to float for status

    • breaking

      the // response's property type changed from string to number, and format from no format to float for status

    • breaking

      the // response's property type changed from string to integer for status

    • breaking

      the // response's property type changed from string to number, and format from no format to float for status

    • breaking

      the // response's property type changed from string to integer for status

    • breaking

      the // response's property type changed from string to number, and format from no format to float for status