{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/vehicles/:id","auth":"required","examples":{"codes":[]},"method":"patch","params":[{"name":"id","type":"int","default":"","desc":"","required":false,"in":"path","ref":"","_id":"54cfc3a23995cf0d0006f708"},{"name":"color","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874255"},{"name":"custom_fields","type":"object","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874254"},{"name":"fuel_type_id","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874253"},{"name":"fuel_volume_units","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874252"},{"name":"group_id","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874251"},{"name":"license_plate","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874250"},{"name":"loan_account_number","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a0230087424f"},{"name":"loan_ended_at","type":"yyyy-mm-dd","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a0230087424e"},{"name":"loan_interest_rate","type":"double","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a0230087424d"},{"name":"loan_notes","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a0230087424c"},{"name":"loan_started_at","type":"yyyy-mm-dd","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a0230087424b"},{"name":"make","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a0230087424a"},{"name":"meter_unit","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874249"},{"name":"model","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874248"},{"name":"name","type":"string","default":"","desc":"*Must be unique","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874247"},{"name":"registration_expiration_month","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874246"},{"name":"registration_state","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874245"},{"name":"secondary_meter","type":"boolean","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874244"},{"name":"secondary_meter_unit","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874243"},{"name":"trim","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874242"},{"name":"vehicle_status_id","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874241"},{"name":"vehicle_type_id","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a02300874240"},{"name":"vin","type":"string","default":"","desc":"*Must be unique","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a0230087423f"},{"name":"year","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a0230087423e"},{"name":"residual_value","type":"double","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a0230087423d"},{"name":"linked_vehicle_ids","type":"array_int","default":"","desc":"New values will completely replace previous values. Be sure to always send array of all linked vehicle ids","required":false,"in":"body","ref":"","_id":"581109ad8a4aed0f00d675dc"},{"name":"loan_amount","type":"double","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a0230087423c"},{"name":"loan_payment","type":"double","default":"","desc":"","required":false,"in":"body","ref":"","_id":"54cfe5fbbba1a0230087423b"},{"name":"loan_vendor_id","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"561d2439bf51fc0d00381043"},{"name":"purchase_detail_attributes.comment","type":"string","default":"","desc":"","required":false,"in":"body","ref":"","_id":"561d2439bf51fc0d00381042"},{"name":"purchase_detail_attributes.date","type":"yyyy-mm-dd","default":"","desc":"","required":false,"in":"body","ref":"","_id":"561d2439bf51fc0d00381041"},{"name":"purchase_detail_attributes.price","type":"double","default":"","desc":"","required":false,"in":"body","ref":"","_id":"561d2439bf51fc0d00381040"},{"name":"purchase_detail_attributes.vendor_id","type":"int","default":"","desc":"","required":false,"in":"body","ref":"","_id":"561d2439bf51fc0d0038103f"},{"name":"purchase_detail_attributes.warranty_expiration_date","type":"yyyy-mm-dd","default":"","desc":"","required":false,"in":"body","ref":"","_id":"561d2439bf51fc0d0038103e"},{"name":"purchase_detail_attributes.warranty_expiration_meter_value","type":"double","default":"","desc":"","required":false,"in":"body","ref":"","_id":"561d2439bf51fc0d0038103d"},{"name":"purchase_detail_attributes.meter_entry_attributes.value","type":"double","default":"","desc":"","required":false,"in":"body","ref":"","_id":"561d2439bf51fc0d0038103c"},{"name":"purchase_detail_attributes.meter_entry_attributes.void","type":"boolean","default":"","desc":"","required":false,"in":"body","ref":"","_id":"561d2439bf51fc0d0038103b"},{"name":"external_ids","type":"object","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5a6a44ee8be43d0069468591"}],"results":{"codes":[{"status":"4XX","language":"json","code":"{\n    \"errors\": {\n        \"meter_unit\": [\n            \"can't be blank\"\n        ]\n    }\n}","name":""}]},"settings":""},"next":{"description":"","pages":[]},"title":"/vehicles/:id","type":"endpoint","slug":"update-vehicle","excerpt":"Updates an existing vehicle.","body":"","updates":[],"order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"54f8de4f4339bb1900c8c009","user":"54cba76f6d1eee0d00c33dee","__v":9,"category":{"sync":{"isSync":false,"url":""},"pages":["54f8de4f4339bb1900c8c006","54f8de4f4339bb1900c8c007","54f8de4f4339bb1900c8c008","54f8de4f4339bb1900c8c009","54f8de4f4339bb1900c8c00a","558c6c4aee884b19006b2634","558c6c599651c22300361487"],"title":"Vehicles","slug":"vehicles","order":31,"from_sync":false,"reference":true,"_id":"54f8de4e4339bb1900c8bffd","project":"54c0e51215af820d001a38a6","createdAt":"2015-01-30T16:06:34.071Z","version":"54f8de4e4339bb1900c8bffb","__v":3},"parentDoc":null,"version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54f8de4e4339bb1900c8bffc","54f8de4e4339bb1900c8bffd","54f8de4e4339bb1900c8bffe","54f8de4e4339bb1900c8bfff","54f8de4e4339bb1900c8c000","54ff6057563d7419002d666e","55007b6ecfeeea17004717dc","5501d779f2ef1e0d003116eb","55116ef89f7c7619005f853b","554bb366f245703100ddd39f","554d226b374fec0d007e64db","555e09f18ab3180d001ac605","555e0b2b4f5e5a0d00836d77","561d1f8b92a0cc350018b24f","562a956c96b5f40d0026eb60","5654c3378a26202b00c17cb8","5697a94b0b09a41900b24546","5739d89e37b52e3200a3a3cc","57ac94252c0b220e00a94570","57ac97a1ad44fc0e003be066","57ac9a3a8f312d0e00e96c75","57ac9c187ae5c60e004ba3a3","58178bee62e4500f009404f6","581a39711a63870f008b621d","581a3b4f0c65b20f00247fcb","5926e0606c729e0f00595f95","5954033ea5bbca002d27ae91","596ce53e0aeafe00157eb1ba","596ce87a8b79f4001a8f6139","598cad2e96193400190d879a","598cbcd3dc20c6000fdfb9c3","598cbd8496193400190d8955","59fcc7c9591add0026c91457","5a020b7856ea82001c8c9342","5a09bc64a91882001c56c2ed","5a71fa2de9aa84007a8bccdb","5b3a768a8a21dd0003ca080d","5c7030f099eeb6003116a106","5c9553a7b6957d005006fc09","5c955c3d04233b0063c9f450","5cfe73f7823bba005de7e1ed","5d07eb760568e70040d6ae21","5deec6550e90370067139979","5ec5a01754009700689296af"],"_id":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","releaseDate":"2015-03-05T22:53:02.044Z","createdAt":"2015-03-05T22:53:02.044Z","forked_from":"54f8de14c6cabe23005c02a2","__v":40},"editedParams2":true,"githubsync":"","createdAt":"2015-02-02T18:36:18.118Z","editedParams":true,"project":"54c0e51215af820d001a38a6"}

patch/vehicles/:id

Updates an existing vehicle.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
integer

Body Params

color:
string
custom_fields:
object
fuel_type_id:
integer
fuel_volume_units:
string
group_id:
integer
license_plate:
string
loan_account_number:
string
loan_ended_at:
yyyy-mm-dd
loan_interest_rate:
double
loan_notes:
string
loan_started_at:
yyyy-mm-dd
make:
string
meter_unit:
string
model:
string
name:
string
*Must be unique
registration_expiration_month:
integer
registration_state:
string
secondary_meter:
boolean
secondary_meter_unit:
string
trim:
string
vehicle_status_id:
integer
vehicle_type_id:
integer
vin:
string
*Must be unique
year:
integer
residual_value:
double
linked_vehicle_ids:
array of integers
New values will completely replace previous values. Be sure to always send array of all linked vehicle ids
loan_amount:
double
loan_payment:
double
loan_vendor_id:
integer
purchase_detail_attributes.comment:
string
purchase_detail_attributes.date:
yyyy-mm-dd
purchase_detail_attributes.price:
double
purchase_detail_attributes.vendor_id:
integer
purchase_detail_attributes.warranty_expiration_date:
yyyy-mm-dd
purchase_detail_attributes.warranty_expiration_meter_value:
double
purchase_detail_attributes.meter_entry_attributes.value:
double
purchase_detail_attributes.meter_entry_attributes.void:
boolean
external_ids:
object

Result Format


User Information

Try It Out

patch
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}