Update Vehicle
Update a Vehicle. If you need to update many Vehicles at once, use the Bulk API to avoid Rate Limiting errors.
Path Parameters
- id string 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.
- application/json
Request Body
- color string
Possible values:
<= 255 characters
The color of this Vehicle.
- fuel_type_id integer
The ID of the
Fuel Type
associated with this Vehicle. - fuel_volume_units VolumeUnit
Possible values: [
us_gallons
,uk_gallons
,liters
] - group_id integer
Possible values:
>= 1
- group_hierarchy string
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_ids integer[]
Possible values:
>= 1
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_plate string
Possible values:
<= 255 characters
The license plate number of this Vehicle.
- make string
Possible values:
<= 255 characters
The name of this Vehicle's manufacturer.
- meter_unit MeterUnit
Possible values: [
km
,hr
,mi
]The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.
- model string
Possible values:
<= 255 characters
The name of the model of this Vehicle.
- name string
Possible values:
<= 255 characters
A name to assign to this Vehicle. Must be unique.
- ownership VehicleOwnership
Possible values: [
owned
,leased
,rented
,customer
] - registration_expiration_month integer
Possible values:
<= 12
The month in which this Vehicle's registration expires.
- registration_state string
Possible values:
<= 255 characters
The state, province, or territory in which this Vehicle is registered.
- secondary_meter boolean
Indicates whether or not this Vehicle has a secondary meter.
- secondary_meter_unit MeterUnit
Possible values: [
km
,hr
,mi
]The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.
- system_of_measurement MeasurementSystem
Possible values: [
imperial
,metric
] - trim string
Possible values:
<= 255 characters
The trim level of this Vehicle.
- vehicle_status_id integer
Possible values:
>= 1
- vehicle_type_id integer
Possible values:
>= 1
- vin string
Possible values:
<= 17 characters
The Vehicle Identification Number of this Vehicle. Must be unique.
- year integer
This Vehicle's model year.
- linked_vehicle_ids integer[]
Possible values:
>= 1
The
vehicle_id
(s) of any Vehicles to link to this Vehicle. purchase_detail_attributes object
comment stringA comment about this Vehicle's purchase.
date date-timeThe date and time at which this Vehicle was purchased. We recommend using ISO-8601 formatted dates to avoid ambiguity.
price floatThe price of this Vehicle at the time of purchase.
vendor_id integerPossible values:
>= 1
warranty_expiration_date date-timeThe date and time at which this Vehicle's warranty expires. We recommend using ISO-8601 formatted dates to avoid ambiguity.
warranty_expiration_meter_value floatThe meter value at which this Vehicle's warranty expires. We recommend using ISO-8601 formatted dates to avoid ambiguity.
meter_entry_attributes.value floatThe meter value at the time of purchase.
meter_entry_attributes.void booleanIndicates whether the
Meter Entry
created by passingmeter_entry_attributes.value
should be considered void. Voiding Meter Entries- external_ids object
Any External IDs associated with this Vehicle.
- vehicle_status_name string
Possible values:
<= 255 characters
The name of the
Vehicle Status
associated with this Vehicle. - vehicle_type_name string
Possible values:
<= 255 characters
The name of the
Vehicle Type
associated with this Vehicle. - in_service_date date-time
The date on which this Vehicle was put into service. We recommend using ISO-8601 formatted dates to avoid ambiguity.
- in_service_meter float
The meter value at which this Vehicle was put into service.
- estimated_service_months integer
The estimated number of months this Vehicle will be in service.
- estimated_replacement_mileage float
The estimated number of miles before which this Vehicle will be replaced.
- estimated_resale_price float
The estimated resale price of this Vehicle.
- out_of_service_date 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_meter float
The meter value at which this Vehicle was or will be retired.
specs_attributes object
base_towing_capacity floatThe base towing capacity of the Vehicle.
bed_length floatThe length of the Vehicle's bed.
body_subtype stringThe subtype of the Vehicle body.
body_type stringThe body type of the Vehicle.
brake_system stringPossible values:
<= 255 characters
The brake system used in the Vehicle.
cargo_volume floatCargo volume of the Vehicle.
curb_weight floatThe curb weight of the Vehicle.
drive_type stringPossible values:
<= 255 characters
The drive type of the Vehicle.
engine_aspiration stringPossible values:
<= 255 characters
Aspiration type of the engine.
engine_block_type stringPossible values:
<= 255 characters
Block type of the engine.
engine_bore floatBore size of the engine.
engine_brand stringPossible values:
<= 255 characters
Brand of the Vehicle's engine.
engine_cam_type stringPossible values:
<= 255 characters
Camshaft type of the engine.
engine_compression floatCompression ratio of the engine.
engine_cylinders integerNumber of engine cylinders.
engine_description stringDescription of the Vehicle's engine.
engine_displacement floatThe displacement of the Vehicle's engine.
engine_stroke floatStroke length of the engine.
engine_valves integerNumber of engine valves.
epa_city floatThe EPA city fuel economy rating.
epa_combined floatThe combined EPA fuel economy rating.
epa_highway floatThe EPA highway fuel economy rating.
front_tire_psi floatThe recommended PSI for front tires.
front_tire_type stringPossible values:
<= 255 characters
The type of front tires used in the Vehicle.
front_track_width floatThe front track width of the Vehicle.
front_wheel_diameter stringPossible values:
<= 255 characters
The diameter of the front wheels.
fuel_induction stringPossible values:
<= 255 characters
Fuel induction method.
fuel_quality stringPossible values:
<= 255 characters
Fuel quality required for the engine.
fuel_tank_capacity floatThe fuel tank capacity of the Vehicle.
fuel_tank_2_capacity floatThe capacity of a second fuel tank, if applicable.
gross_vehicle_weight_rating floatThe Gross Vehicle Weight Rating (GVWR).
ground_clearance floatThe ground clearance of the Vehicle.
height floatThe height of the Vehicle.
interior_volume floatInterior volume of the Vehicle.
length floatThe length of the Vehicle.
max_hp integerMaximum horsepower produced by the engine.
max_payload floatThe maximum payload capacity of the Vehicle.
max_torque integerMaximum torque produced by the engine.
msrp floatManufacturer's Suggested Retail Price (MSRP).
oil_capacity floatOil capacity of the engine.
passenger_volume stringPossible values:
<= 255 characters
Passenger volume of the Vehicle.
rear_axle_type stringPossible values:
<= 255 characters
The type of rear axle used in the Vehicle.
rear_tire_psi floatThe recommended PSI for rear tires.
rear_tire_type stringPossible values:
<= 255 characters
The type of rear tires used in the Vehicle.
rear_track_width floatThe rear track width of the Vehicle.
rear_wheel_diameter stringPossible values:
<= 255 characters
The diameter of the rear wheels.
redline_rpm stringPossible values:
<= 255 characters
Redline RPM of the engine.
transmission_brand stringPossible values:
<= 255 characters
Brand of the Vehicle's transmission.
transmission_description stringPossible values:
<= 255 characters
Description of the Vehicle's transmission.
transmission_gears integerNumber of gears in the transmission.
transmission_type stringPossible values:
<= 255 characters
Type of transmission.
wheelbase floatThe wheelbase of the Vehicle.
width floatThe width of the Vehicle.
- custom_fields object
*Full details on working with Custom Fields here.
- 200
- 401
- 403
- 404
- 422
- 500
OK
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
- id integer
- account_id integer
- archived_at date-time
The iso8601 date and time at which the vehicle was archived, for an archived vehicle.
- fuel_type_id integer
- fuel_type_name string
The name of the
Fuel Type
associated with this vehicle. - fuel_volume_units VolumeUnit
Possible values: [
us_gallons
,uk_gallons
,liters
] - group_id integer
- group_name string
The name of the
Group
associated with this vehicle, for vehicles associated with a group. - name string
This vehicle's name.
- ownership VehicleOwnershipResponse
Possible values: [
Owned
,Leased
,Rented
,Customer
] - current_location_entry_id integer
- system_of_measurement MeasurementSystem
Possible values: [
imperial
,metric
] - vehicle_type_id integer
This vehicles
Vehicle Type
id. - vehicle_type_name string
The name of the
Vehicle Type
associated with this Vehicle. - is_sample boolean
Indicates whether this Vehicle record is Sample Data.
- vehicle_status_id integer
The id of the
Vehicle Status
of this vehicle. - vehicle_status_name string
The name of the
Vehicle Status
associated with this Vehicle. - vehicle_status_color string
The hex color code of the
Vehicle Status
associated with this Vehicle. - primary_meter_unit MeterUnit
Possible values: [
km
,hr
,mi
]The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.
- primary_meter_value string
The current value of the primary meter for this Vehicle.
- primary_meter_date date-time
The date and time at which the primary meter was last updated.
- primary_meter_usage_per_day string
The average number of units of the primary meter used per day.
- secondary_meter_unit MeterUnit
Possible values: [
km
,hr
,mi
]The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.
- secondary_meter_value string
The current value of the secondary meter for this Vehicle.
- secondary_meter_date date-time
The date and time at which the secondary meter was last updated.
- secondary_meter_usage_per_day string
The average number of units of the secondary meter used per day.
- in_service_meter_value string
The meter value at which this Vehicle was put into service.
- in_service_date date-time
The date on which this Vehicle was put into service.
- out_of_service_meter_value string
The meter value at which this Vehicle was or will be retired.
- out_of_service_date date-time
The date on which this Vehicle was or will be retired.
- estimated_service_months integer
The estimated number of months this Vehicle will be in service.
- estimated_replacement_mileage string
The estimated number of miles before which this Vehicle will be replaced.
- estimated_resale_price_cents integer
The estimated resale price of this Vehicle in cents.
- fuel_entries_count integer
The number of
Fuel Entries
associated with this Vehicle. - service_entries_count integer
The number of
Service Entries
associated with this Vehicle. - service_reminders_count integer
The number of
Service Reminders
associated with this Vehicle. - vehicle_renewal_reminders_count integer
The number of
Vehicle Renewal Reminders
associated with this Vehicle. - comments_count integer
The number of
Comments
associated with this Vehicle. - documents_count integer
The number of documents attached to this Vehicle.
- images_count integer
The number of images attached to this Vehicle.
- issues_count integer
The number of
Issues
this Vehicle is associated with. - work_orders_count integer
The number of
Work Orders
this Vehicle is associated with. labels object[]
id integerPossible values:
>= 1
name string- group_ancestry string
The ancestry of the Group associated with this Vehicle.
- color string
The color of this Vehicle.
- license_plate string
The license plate number of this Vehicle.
- vin string
The Vehicle Identification Number of this Vehicle.
- year string
This Vehicle's model year.
- make string
The name of this Vehicle's manufacturer.
- model string
The name of the model of this Vehicle.
- trim string
The trim level of this Vehicle.
- registration_expiration_month integer
Possible values:
<= 12
The month in which this Vehicle's registration expires.
- registration_state string
The state, province, or territory in which this Vehicle is registered.
- default_image_url_small string
The URL of a small-sized version of the default image for this Vehicle.
- external_ids object
Any External IDs associated with this Vehicle.
- ai_enabled boolean
Whether this Vehicle has Auto Integrate enabled for it.
- assetable_type string
Possible values: [
Vehicle
]Assetable type for Vehicle is always
Vehicle
for vehicles. - custom_fields object
*Full details on working with Custom Fields here.
- axle_config_id integer
The id of the
Axle Configuration
of this vehicle. - meter_name string
The name of the primary meter for this Vehicle.
- secondary_meter_name string
The name of the secondary meter for this Vehicle.
- loan_account_number string
The account number for this Vehicle's loan, if applicable.
- loan_ended_at date-time
The date and time at which this Vehicle's loan ends.
- loan_interest_rate float
The interest rate for this Vehicle's loan.
- loan_notes string
Notes about this Vehicle's loan.
- loan_started_at date-time
The date and time at which this Vehicle's loan began. Formatted according to ISO-8601 in
User
's local time. - loan_vendor_id NullableId
Possible values:
>= 1
- loan_vendor_name string
The name of the
Vendor
for this Vehicle's loan. - inspection_schedules_count integer
The number of inspection schedules this Vehicle is associated with.
- default_image_url string
The URL of the default image for this Vehicle.
- default_image_url_medium string
The URL of a medium-sized version of the default image for this Vehicle.
- default_image_url_large string
The URL of a large-sized version of the default image for this Vehicle.
specs object
id integerPossible values:
>= 1
vehicle_id integerThe
Vehicle
ID these specs belong to.account_id integerbody_type stringThe body type of the Vehicle, if available.
body_subtype stringThe subtype of the Vehicle body, if available.
drive_type stringThe drive type of the Vehicle, if available.
brake_system stringThe brake system used in the Vehicle, if available.
msrp_cents integerThe Manufacturer's Suggested Retail Price (MSRP) in cents, if available.
fuel_tank_capacity floatThe fuel tank capacity of the Vehicle, if available.
fuel_tank_2_capacity floatThe capacity of a second fuel tank, if available.
front_track_width floatThe front track width of the Vehicle, if available.
ground_clearance floatThe ground clearance of the Vehicle, if available.
height floatThe height of the Vehicle, if available.
length floatThe length of the Vehicle, if available.
rear_track_width floatThe rear track width of the Vehicle, if available.
width floatThe width of the Vehicle, if available.
wheelbase floatThe wheelbase of the Vehicle, if available.
front_tire_psi stringThe recommended PSI for front tires, if available.
rear_tire_psi stringThe recommended PSI for rear tires, if available.
base_towing_capacity stringThe base towing capacity of the Vehicle, if available.
curb_weight floatThe curb weight of the Vehicle, if available.
gross_vehicle_weight_rating floatThe Gross Vehicle Weight Rating (GVWR), if available.
bed_length stringThe length of the Vehicle's bed, if available.
max_payload stringThe maximum payload capacity of the Vehicle, if available.
rear_axle_type stringThe type of rear axle used in the Vehicle.
front_tire_type stringThe type of front tires used in the Vehicle.
front_wheel_diameter stringThe diameter of the front wheels.
rear_tire_type stringThe type of rear tires used in the Vehicle.
rear_wheel_diameter stringThe diameter of the rear wheels.
epa_city floatThe EPA city fuel economy rating, if available.
epa_highway floatThe EPA highway fuel economy rating, if available.
epa_combined floatThe combined EPA fuel economy rating, if available.
engine_description stringDescription of the Vehicle's engine.
engine_brand stringBrand of the Vehicle's engine.
engine_aspiration stringAspiration type of the engine, if available.
engine_block_type stringBlock type of the engine, if available.
engine_bore stringBore size of the engine, if available.
engine_cam_type stringCamshaft type of the engine, if available.
engine_compression stringCompression ratio of the engine, if available.
engine_cylinders integerNumber of engine cylinders, if available.
engine_displacement stringEngine displacement, if available.
fuel_induction stringFuel induction method, if available.
fuel_quality stringFuel quality required for the engine.
max_hp stringMaximum horsepower produced by the engine, if available.
max_torque stringMaximum torque produced by the engine, if available.
oil_capacity stringOil capacity of the engine, if available.
redline_rpm stringRedline RPM of the engine.
engine_stroke stringStroke length of the engine, if available.
engine_valves integerNumber of engine valves, if available.
transmission_description stringDescription of the Vehicle's transmission.
transmission_brand stringBrand of the Vehicle's transmission.
transmission_type stringType of transmission, if available.
transmission_gears integerNumber of gears in the transmission, if available.
cargo_volume floatCargo volume of the Vehicle, if available.
interior_volume floatInterior volume of the Vehicle, if available.
passenger_volume stringPassenger volume of the Vehicle.
created_at date-timeThe date and time when the specs were created.
updated_at date-timeThe date and time when the specs were last updated.
duty_type stringType of duty the Vehicle is designed for, if available.
weight_class stringWeight class of the Vehicle, if available.
engine_bore_with_units stringBore size of the engine with units, if available.
wheelbase_with_units stringWheelbase of the Vehicle with units, if available.
msrp stringManufacturer's Suggested Retail Price (MSRP).
driver object
id NullableIdPossible values:
>= 1
first_name stringThe first name of the
Contact
(driver) associated with this Vehicle.last_name stringThe last name of the
Contact
(driver) associated with this Vehicle.full_name stringThe full name of the
Contact
(driver) associated with this Vehicle.default_image_url stringThe URL of the default image of the
Contact
(driver) associated with this Vehicle.current_location_entry object
The current location of the associated object.
id integerThe unique identifier for the current Location Entry.
locatable_type stringThe type of object that this Location Entry is associated with.
locatable_id integerThe unique identifier of the object that this Location Entry is associated with.
date date-timeThe date and time when this Location Entry was recorded.
created_at date-timeThe date and time when this Location Entry was created.
updated_at date-timeThe date and time when this Location Entry was last updated.
contact_id integerThe unique identifier of the associated Contact.
address stringThe address associated with this Location Entry.
is_current booleanIndicates whether this Location Entry is the current location.
item_type stringThe type of item associated with this Location Entry.
item_id integerThe unique identifier of the item associated with this Location Entry.
location stringThe geographical location in the format "POINT (longitude latitude)".
address_components object
street_number stringThe street number in the address.
street stringThe street name in the address.
city stringThe city in the address.
region stringThe region, state or province in the address.
region_short stringThe abbreviated region, state or province code.
country stringThe country in the address.
country_short stringThe abbreviated country code.
postal_code stringThe postal code, ZIP, or equivalent in the address.
geolocation object
latitude floatThe latitude coordinate of the location.
longitude floatThe longitude coordinate of the location.
{
"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-11-21",
"updated_at": "2024-11-21",
"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-11-21",
"created_at": "2024-11-21",
"updated_at": "2024-11-21",
"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 (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
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 (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
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 (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
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 (from schema)
- Example
Schema
errors object
typeitems string
{
"errors": {}
}
{
"errors": {
"field1": [
"error1",
"error2"
],
"field2": [
"error3"
]
}
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
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"
}