Update Equipment

PATCH https://secure.fleetio.com/api/v1/equipment/:id

Update a Equipment

Request

Path Parameters

id stringrequired

Possible values: Value must match regular expression ^[0-9]+$

The id of the relevant record

application/json

Body

namestring

The name for this Equipment.

brandstring

The name of the brand which makes this Equipment.

modelstring

The model name of this Equipment.

serial_numberstring

The serial number of this Equipment.

type_idId (integer)

Possible values: >= 1

status_idId (integer)

Possible values: >= 1

group_idNullableId (integer)nullable

Possible values: >= 1

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.

purchase_vendor_idNullableId (integer)nullable

Possible values: >= 1

purchase_pricenumber

The price at which the Equipment was purchased.

purchase_datedate

We recommend using ISO-8601 formatted dates to avoid ambiguity.

Example: 2023-03-14

warranty_expiration_datedate

The date on which the Equipment warranty expires.

Example: 2023-03-14

purchase_commentsstring

Any comments about the purchase of this Equipment.

in_service_datedate

We recommend using ISO-8601 formatted dates to avoid ambiguity.

Example: 2023-03-14

estimated_service_lifeinteger

The estimated duration in months of the service life for this Equipment.

estimated_resale_pricenumber

The estimated resale price of this Equipment.

out_of_service_datedate

We recommend using ISO-8601 formatted dates to avoid ambiguity.

Example: 2023-03-14

linked_vehicle_idNullableId (integer)nullable

Possible values: >= 1

assignee_idNullableId (integer)nullable

Possible values: >= 1

default_imageurinullable

The default image URL for this Equipment.

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

documents_attributes object[]

images_attributes object[]

Responses

Response Headers

application/json

Schema
Example (auto)

Schema

idId (integer)required

Possible values: >= 1

created_atdate-timerequired

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-timerequired

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

namestringrequired

The name for this Equipment.

brandstringnullablerequired

The name of the brand which makes this Equipment.

modelstringnullablerequired

The model name of this Equipment.

serial_numberstringnullablerequired

The serial number of this Equipment.

equipment_type_idId (integer)required

Possible values: >= 1

type_namestringrequired

The name of the associated Equipment Type.

equipment_status_idId (integer)required

Possible values: >= 1

status_namestringrequired

The name of the associated Equipment Status.

group_idNullableId (integer)nullablerequired

Possible values: >= 1

group_namestringnullablerequired

The name of the associated Group.

purchase_vendor_idNullableId (integer)nullablerequired

Possible values: >= 1

purchase_price_centsintegernullablerequired

The purchase price in cents.

purchase_datedatenullablerequired

The date on which the Equipment was purchased.

Example: 2023-03-14

estimated_resale_pricefloatnullablerequired

The estimated resale price of this Equipment.

warranty_expiration_datedatenullablerequired

The date on which the Equipment warranty expires.

Example: 2023-03-14

purchase_commentsstringnullablerequired

Any comments about the purchase of this Equipment.

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

in_service_datedatenullablerequired

The date on which the Equipment was put into service.

Example: 2023-03-14

estimated_service_lifeintegernullablerequired

The estimated duration in months of the service life for this Equipment.

out_of_service_datedatenullablerequired

The estimated date on which the Equipment will be retired from service.

Example: 2023-03-14

archived_atdate-timenullablerequired

The date and time at which the Equipment was archived.

status_colorstringnullablerequired

The color of the associated Equipment Status.

linked_vehicle objectnullablerequired

A Vehicle

idinteger

created_atdate-time

updated_atdate-time

account_idId (integer)

Possible values: >= 1

archived_atdate-timenullable

The date and time at which the Vehicle was archived.

Example: 2023-03-14T13:46:27-06:00

fuel_type_idNullableId (integer)nullable

Possible values: >= 1

fuel_type_namestringnullable

The name of the Fuel Type associated with this Vehicle.

fuel_volume_unitsVolumeUnit (string)

Possible values: [us_gallons, uk_gallons, liters]

group_idNullableId (integer)nullable

Possible values: >= 1

group_namestringnullable

The name of the Group associated with this Vehicle.

meter_unitMeterUnit (string)nullable

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

Possible values: [km, hr, mi]

namestring

This Vehicle's name.

ownershipVehicleOwnershipResponse (string)

Possible values: [Owned, Leased, Rented, Customer]

secondary_meterboolean

Indicates whether or not this Vehicle has a secondary meter.

secondary_meter_unitMeterUnit (string)nullable

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

Possible values: [km, hr, mi]

system_of_measurementMeasurementSystem (string)

Possible values: [imperial, metric]

labels object[]

vehicle_status_idId (integer)

Possible values: >= 1

vehicle_status_namestring

The name of the Vehicle Status associated with this Vehicle.

vehicle_status_colorstringnullable

The color of the Vehicle Status associated with this Vehicle.

vehicle_type_idId (integer)

Possible values: >= 1

vehicle_type_namestring

The name of the Vehicle Type associated with this Vehicle.

fuel_entries_countinteger

The number of Fuel Entries associated with this Vehicle.

Possible values: >= 0

service_entries_countinteger

The number of Service Entries associated with this Vehicle.

Possible values: >= 0

service_reminders_countinteger

The number of Service Reminders associated with this Vehicle.

Possible values: >= 0

vehicle_renewal_reminders_countinteger

The number of Vehicle Renewal Reminders associated with this Vehicle.

Possible values: >= 0

comments_countinteger

The number of Comments associated with this Vehicle.

Possible values: >= 0

documents_countinteger

The number of documents attached to this Vehicle.

Possible values: >= 0

images_countinteger

The number of images attached to this Vehicle.

Possible values: >= 0

current_location_entry_idNullableId (integer)nullable

Possible values: >= 1

is_sampleboolean

Indicates whether this Vehicle record is Sample Data.

in_service_datedate-timenullable

The date on which this Vehicle was put into service.

Example: 2023-03-14T13:46:27-06:00

in_service_meterfloatnullable

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

estimated_service_monthsintegernullable

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

estimated_replacement_mileagestringnullable

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

estimated_resale_price objectnullable

out_of_service_datedate-timenullable

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

Example: 2023-03-14T13:46:27-06:00

out_of_service_meterfloatnullable

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

meter_namestring

The name of the primary meter for this Vehicle.

secondary_meter_namestring

The name of the secondary meter for this Vehicle.

primary_meter_usage_per_daystringnullable

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

secondary_meter_usage_per_daystringnullable

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

current_meter_valuefloatnullable

The current value of the primary meter for this Vehicle.

current_meter_datedate-timenullable

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

Example: 2023-03-14T13:46:27-06:00

secondary_meter_valuefloatnullable

The current value of the secondary meter for this Vehicle.

secondary_meter_datedate-timenullable

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

Example: 2023-03-14T13:46:27-06:00

group_ancestrystringnullable

The ancestry of the Group associated with this Vehicle.

colorstringnullable

The color of this Vehicle.

license_platestringnullable

The license plate number of this Vehicle.

vinstringnullable

The Vehicle Identification Number of this Vehicle.

yearstringnullable

This Vehicle's model year.

makestringnullable

The name of this Vehicle's manufacturer.

modelstringnullable

The name of the model of this Vehicle.

trimstringnullable

The trim level of this Vehicle.

registration_expiration_monthintegernullable

The month in which this Vehicle's registration expires.

Possible values: >= 0 and <= 12

registration_statestringnullable

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

loan_account_numberstringnullable

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

loan_ended_atdate-timenullable

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

Example: 2023-03-14T13:46:27-06:00

loan_interest_ratefloatnullable

The interest rate for this Vehicle's loan.

loan_notesstringnullable

Notes about this Vehicle's loan.

loan_started_atdate-timenullable

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

Example: 2023-03-14T13:46:27-06:00

loan_vendor_idNullableId (integer)nullable

Possible values: >= 1

loan_vendor_namestringnullable

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

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

inspection_schedules_countinteger

The number of inspection schedules this Vehicle is associated with.

Possible values: >= 0

issues_countinteger

The number of Issues this Vehicle is associated with.

Possible values: >= 0

work_orders_countinteger

The number of Work Orders this Vehicle is associated with.

Possible values: >= 0

type_namestringnullable

The name of the Vehicle Type associated with this Vehicle.

default_image_urlstringnullable

The URL of the default image for this Vehicle.

default_image_url_mediumstringnullable

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

default_image_url_smallstringnullable

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

default_image_url_largestringnullable

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

specs object

idId (integer)

Possible values: >= 1

vehicle_idinteger

The Vehicle ID these specs belong to.

account_idinteger

body_typestringnullable

The body type of the Vehicle, if available.

body_subtypestringnullable

The subtype of the Vehicle body, if available.

drive_typestringnullable

The drive type of the Vehicle, if available.

brake_systemstringnullable

The brake system used in the Vehicle, if available.

msrp_centsintegernullable

The Manufacturer's Suggested Retail Price (MSRP) in cents, if available.

fuel_tank_capacityfloatnullable

The fuel tank capacity of the Vehicle, if available.

fuel_tank_2_capacityfloatnullable

The capacity of a second fuel tank, if available.

front_track_widthfloatnullable

The front track width of the Vehicle, if available.

ground_clearancefloatnullable

The ground clearance of the Vehicle, if available.

heightfloatnullable

The height of the Vehicle, if available.

lengthfloatnullable

The length of the Vehicle, if available.

rear_track_widthfloatnullable

The rear track width of the Vehicle, if available.

widthfloatnullable

The width of the Vehicle, if available.

wheelbasefloatnullable

The wheelbase of the Vehicle, if available.

front_tire_psistringnullable

The recommended PSI for front tires, if available.

rear_tire_psistringnullable

The recommended PSI for rear tires, if available.

base_towing_capacitystringnullable

The base towing capacity of the Vehicle, if available.

curb_weightfloatnullable

The curb weight of the Vehicle, if available.

gross_vehicle_weight_ratingfloatnullable

The Gross Vehicle Weight Rating (GVWR), if available.

bed_lengthstringnullable

The length of the Vehicle's bed, if available.

max_payloadstringnullable

The maximum payload capacity of the Vehicle, if available.

rear_axle_typestring

The type of rear axle used in the Vehicle.

front_tire_typestring

The type of front tires used in the Vehicle.

front_wheel_diameterstring

The diameter of the front wheels.

rear_tire_typestring

The type of rear tires used in the Vehicle.

rear_wheel_diameterstring

The diameter of the rear wheels.

epa_cityfloatnullable

The EPA city fuel economy rating, if available.

epa_highwayfloatnullable

The EPA highway fuel economy rating, if available.

epa_combinedfloatnullable

The combined EPA fuel economy rating, if available.

engine_descriptionstring

Description of the Vehicle's engine.

engine_brandstring

Brand of the Vehicle's engine.

engine_aspirationstringnullable

Aspiration type of the engine, if available.

engine_block_typestringnullable

Block type of the engine, if available.

engine_borestringnullable

Bore size of the engine, if available.

engine_cam_typestringnullable

Camshaft type of the engine, if available.

engine_compressionstringnullable

Compression ratio of the engine, if available.

engine_cylindersintegernullable

Number of engine cylinders, if available.

engine_displacementstringnullable

Engine displacement, if available.

fuel_inductionstringnullable

Fuel induction method, if available.

fuel_qualitystring

Fuel quality required for the engine.

max_hpstringnullable

Maximum horsepower produced by the engine, if available.

max_torquestringnullable

Maximum torque produced by the engine, if available.

oil_capacitystringnullable

Oil capacity of the engine, if available.

redline_rpmstring

Redline RPM of the engine.

engine_strokestringnullable

Stroke length of the engine, if available.

engine_valvesintegernullable

Number of engine valves, if available.

transmission_descriptionstring

Description of the Vehicle's transmission.

transmission_brandstring

Brand of the Vehicle's transmission.

transmission_typestringnullable

Type of transmission, if available.

transmission_gearsintegernullable

Number of gears in the transmission, if available.

cargo_volumefloatnullable

Cargo volume of the Vehicle, if available.

interior_volumefloatnullable

Interior volume of the Vehicle, if available.

passenger_volumestring

Passenger volume of the Vehicle.

created_atdate-time

The date and time when the specs were created.

updated_atdate-time

The date and time when the specs were last updated.

duty_typestringnullable

Type of duty the Vehicle is designed for, if available.

weight_classstringnullable

Weight class of the Vehicle, if available.

engine_bore_with_unitsstringnullable

Bore size of the engine with units, if available.

wheelbase_with_unitsstringnullable

Wheelbase of the Vehicle with units, if available.

msrpstringnullable

Manufacturer's Suggested Retail Price (MSRP).

external_idsobject

Any External IDs associated with this Vehicle.

ai_enabledboolean

Whether this Vehicle has Auto Integrate enabled for it.

assetable_typestring

Assetable type for Vehicle is always Vehicle for vehicles.

Possible values: [Vehicle]

driver object

current_location_entry objectnullable

loan_amountfloatnullable

The amount of this Vehicle's loan.

loan_paymentfloatnullable

The amount of this Vehicle's loan payment.

warranties_active_countinteger

The number of active warranties associated with this Vehicle.

Possible values: >= 0

warranties_countinteger

The number of warranties associated with this Vehicle.

Possible values: >= 0

residual_valuefloatnullable

The residual value of this Vehicle at the end of its lease.

axle_config_idintegernullable

The id of the Axle Configuration of this vehicle.

assigned_contact objectnullablerequired

A Contact

idinteger

created_atdate-time

updated_atdate-time

emailstringnullable

The Contact's email address.

namestringnullable

The Contact's full name.

first_namestringnullable

The Contact's first name.

middle_namestringnullable

The Contact's middle name.

last_namestringnullable

The Contact's last name.

images_countinteger

The number of images associated with this Contact.

Possible values: >= 0

documents_countinteger

The number of documents associated with this Contact.

Possible values: >= 0

comments_countinteger

The number of comments associated with this Contact.

Possible values: >= 0

group_idintegernullable

If this Contact belongs to a Group, this will be the Fleetio ID of that Group.

group_namestringnullable

If this Contact belongs to a Group, this will be the Group's name.

group_hierarchystringnullable

If this Contact belongs to a Group, this will be a pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.

Example: Group 1|Group 2|Group 3

technicianbooleannullable

Whether or not the Contact is a Technician.

vehicle_operatorbooleannullable

Whether or not the Contact is a Vehicle Operator.

employeebooleannullable

Whether or not the Contact is an Employee.

birth_datedatenullable

The Contact's birth date.

Example: 2023-03-14

street_addressstringnullable

The Contact's street address.

Example: 123 Main St

street_address_line_2stringnullable

The Contact's street address line 2.

Example: Apt 1

citystringnullable

The Contact's city.

regionstringnullable

The Contact's region, state, or province.

postal_codestringnullable

The Contact's postal code, zip code, or equivalent.

countrystringnullable

The Contact's country.

employee_numberstringnullable

The Contact's employee number.

job_titlestringnullable

The Contact's job title.

Possible values: <= 255 characters

license_classstringnullable

The Contact's driver's license class.

license_numberstringnullable

The Contact's driver's license number.

license_statestringnullable

The locality which issued the Contact's license.

license_expirationdatenullable

The Contact's driver's license expiration date.

Example: 2023-03-14

home_phone_numberstringnullable

The Contact's home phone number.

mobile_phone_numberstringnullable

The Contact's mobile phone number.

work_phone_numberstringnullable

The Contact's work phone number.

other_phone_numberstringnullable

Any other phone number for this Contact.

start_datedatenullable

When the Contact started working for the company, if applicable.

leave_datedatenullable

When the Contact left or will leave the company, if applicable.

hourly_labor_ratefloatnullable

The Contact's hourly rate.

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

attachment_permissions objectnullable

default_image_urlstringnullable

The URL of the Contact's default image/profile photo, if any.

userobjectnullable

If the Contact is a Fleetio User, those details will be included here.

account_membership_idNullableId (integer)nullable

Possible values: >= 1

last_api_requestdate-timenullable

The last date and time this Contact's associated User made an API request. Null if Contact is not assocated with a User.

last_web_accessdate-timenullable

The last date and time this Contact's associated User signed into the web application. Null if Contact is not assocated with a User.

last_mobile_app_accessdate-timenullable

The last date and time this Contact's associated User used the mobile app. Null if Contact is not assocated with a User.

attachment_permissions objectnullablerequired

default_image_urlstringnullablerequired

The URL of the Equipment's default image/profile photo, if any.

assetable_typestringnullablerequired

The type of assetable object.

issues_countintegerrequired

The number of Issues associated with this Equipment.

current_location_entry objectnullablerequired

comments_countintegerrequired

The number of Comments associated with this Equipment.

Possible values: >= 0

documents_countintegerrequired

The number of documents associated with this Equipment.

Possible values: >= 0

images_countintegerrequired

The number of images associated with this Equipment.

Possible values: >= 0

is_watchedbooleanrequired

Indicates whether this Equipment is being watched.

Default value: false

watchers_countintegerrequired

The number of users watching this Equipment.

Possible values: >= 0

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "name": "string",
  "brand": "string",
  "model": "string",
  "serial_number": "string",
  "equipment_type_id": 0,
  "type_name": "string",
  "equipment_status_id": 0,
  "status_name": "string",
  "group_id": 0,
  "group_name": "string",
  "purchase_vendor_id": 0,
  "purchase_price_cents": 0,
  "purchase_date": "2023-03-14",
  "estimated_resale_price": 0,
  "warranty_expiration_date": "2023-03-14",
  "purchase_comments": "string",
  "custom_fields": {},
  "in_service_date": "2023-03-14",
  "estimated_service_life": 0,
  "out_of_service_date": "2023-03-14",
  "archived_at": "2024-07-29T15:51:28.071Z",
  "status_color": "string",
  "linked_vehicle": {
    "id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "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",
    "meter_unit": "km",
    "name": "string",
    "ownership": "Owned",
    "secondary_meter": true,
    "secondary_meter_unit": "km",
    "system_of_measurement": "imperial",
    "labels": [
      {
        "id": 0,
        "name": "string",
        "color": "#44DB38"
      }
    ],
    "vehicle_status_id": 0,
    "vehicle_status_name": "string",
    "vehicle_status_color": "string",
    "vehicle_type_id": 0,
    "vehicle_type_name": "string",
    "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,
    "current_location_entry_id": 0,
    "is_sample": true,
    "in_service_date": "2023-03-14T13:46:27-06:00",
    "in_service_meter": 0,
    "estimated_service_months": 0,
    "estimated_replacement_mileage": "string",
    "estimated_resale_price": {
      "cents": 0,
      "currency_iso": "string"
    },
    "out_of_service_date": "2023-03-14T13:46:27-06:00",
    "out_of_service_meter": 0,
    "meter_name": "string",
    "secondary_meter_name": "string",
    "primary_meter_usage_per_day": "string",
    "secondary_meter_usage_per_day": "string",
    "current_meter_value": 0,
    "current_meter_date": "2023-03-14T13:46:27-06:00",
    "secondary_meter_value": 0,
    "secondary_meter_date": "2023-03-14T13:46:27-06:00",
    "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",
    "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",
    "custom_fields": {},
    "inspection_schedules_count": 0,
    "issues_count": 0,
    "work_orders_count": 0,
    "type_name": "string",
    "default_image_url": "string",
    "default_image_url_medium": "string",
    "default_image_url_small": "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"
    },
    "external_ids": {},
    "ai_enabled": true,
    "assetable_type": "Vehicle",
    "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
      }
    },
    "loan_amount": 0,
    "loan_payment": 0,
    "warranties_active_count": 0,
    "warranties_count": 0,
    "residual_value": 0,
    "axle_config_id": 0
  },
  "assigned_contact": {
    "id": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "email": "string",
    "name": "string",
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "images_count": 0,
    "documents_count": 0,
    "comments_count": 0,
    "group_id": 0,
    "group_name": "string",
    "group_hierarchy": "Group 1|Group 2|Group 3",
    "technician": true,
    "vehicle_operator": true,
    "employee": true,
    "birth_date": "2023-03-14",
    "street_address": "123 Main St",
    "street_address_line_2": "Apt 1",
    "city": "string",
    "region": "string",
    "postal_code": "string",
    "country": "string",
    "employee_number": "string",
    "job_title": "string",
    "license_class": "string",
    "license_number": "string",
    "license_state": "string",
    "license_expiration": "2023-03-14",
    "home_phone_number": "string",
    "mobile_phone_number": "string",
    "work_phone_number": "string",
    "other_phone_number": "string",
    "start_date": "2024-07-29",
    "leave_date": "2024-07-29",
    "hourly_labor_rate": 0,
    "custom_fields": {},
    "attachment_permissions": {
      "read_photos": true,
      "manage_photos": true,
      "read_documents": true,
      "manage_documents": true
    },
    "default_image_url": "string",
    "user": {},
    "account_membership_id": 0,
    "last_api_request": "2024-07-29T15:51:28.071Z",
    "last_web_access": "2024-07-29T15:51:28.071Z",
    "last_mobile_app_access": "2024-07-29T15:51:28.071Z"
  },
  "attachment_permissions": {
    "read_photos": true,
    "manage_photos": true,
    "read_documents": true,
    "manage_documents": true
  },
  "default_image_url": "string",
  "assetable_type": "string",
  "issues_count": 0,
  "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
    }
  },
  "comments_count": 0,
  "documents_count": 0,
  "images_count": 0,
  "is_watched": false,
  "watchers_count": 0
}

Request could not be authenticated

application/json

Schema
Example (auto)

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

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

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

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

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

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

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

Body

{
  "name": "string",
  "brand": "string",
  "model": "string",
  "serial_number": "string",
  "type_id": 0,
  "status_id": 0,
  "group_id": 0,
  "group_hierarchy": "string",
  "purchase_vendor_id": 0,
  "purchase_price": 0,
  "purchase_date": "2023-03-14",
  "warranty_expiration_date": "2023-03-14",
  "purchase_comments": "string",
  "in_service_date": "2023-03-14",
  "estimated_service_life": 0,
  "estimated_resale_price": 0,
  "out_of_service_date": "2023-03-14",
  "linked_vehicle_id": 0,
  "assignee_id": 0,
  "default_image": "string",
  "custom_fields": {},
  "documents_attributes": [
    {
      "name": "string",
      "file_url": "string",
      "file_mime_type": "string",
      "file_name": "string",
      "file_size": 0
    }
  ],
  "images_attributes": [
    {
      "name": "string",
      "file_url": "string",
      "file_mime_type": "string",
      "file_name": "string",
      "file_size": 0
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!

Update Equipment

https://secure.fleetio.com/api/v1/equipment/:id

Request​

Path Parameters

Body

Responses​

Authorization: Authorization

Request

Responses