{"_id":"54f8de4f4339bb1900c8c008","editedParams":true,"parentDoc":null,"user":"54cba76f6d1eee0d00c33dee","category":{"_id":"54f8de4e4339bb1900c8bffd","project":"54c0e51215af820d001a38a6","pages":["54f8de4f4339bb1900c8c006","54f8de4f4339bb1900c8c007","54f8de4f4339bb1900c8c008","54f8de4f4339bb1900c8c009","54f8de4f4339bb1900c8c00a","558c6c4aee884b19006b2634","558c6c599651c22300361487"],"version":"54f8de4e4339bb1900c8bffb","__v":3,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-01-30T16:06:34.071Z","from_sync":false,"order":4,"slug":"vehicles","title":"Vehicles"},"__v":12,"editedParams2":true,"project":"54c0e51215af820d001a38a6","version":{"_id":"54f8de4e4339bb1900c8bffb","project":"54c0e51215af820d001a38a6","forked_from":"54f8de14c6cabe23005c02a2","__v":32,"createdAt":"2015-03-05T22:53:02.044Z","releaseDate":"2015-03-05T22:53:02.044Z","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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-02T15:20:25.620Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[{"code":"{\n  \"errors\": {\n    \"name\": [\n      \"can't be blank\"\n    ],\n    \"meter_unit\": [\n      \"can't be blank\",\n      \"is not a valid value. Please specify one of the predefined values for this field.\"\n    ],\n    \"fuel_volume_units\": [\n      \"can't be blank\",\n      \"is not a valid value. Please specify one of the predefined values for this field.\"\n    ],\n    \"vehicle_type\": [\n      \"can't be blank\"\n    ],\n    \"vehicle_status\": [\n      \"can't be blank\"\n    ],\n    \"secondary_meter_unit\": [\n      \"is not a valid value. Please specify one of the predefined values for this field.\"\n    ]\n  }\n}","language":"json","status":"4XX"}]},"settings":"","auth":"required","params":[{"_id":"54cfa4b34acee20d001e5471","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"color"},{"_id":"54cfa6c6d209303900f5a6ec","ref":"","in":"body","required":false,"desc":"","default":"","type":"object","name":"custom_fields"},{"_id":"54cfa6c6d209303900f5a6eb","ref":"","in":"body","required":false,"desc":"","default":"","type":"int","name":"fuel_type_id"},{"_id":"54cfb25b5ff7e617002bbd6d","ref":"","in":"body","required":true,"desc":"us_gallons, uk_gallons, liters","default":"","type":"string","name":"fuel_volume_units"},{"_id":"54cfb25b5ff7e617002bbd6c","ref":"","in":"body","required":false,"desc":"","default":"","type":"int","name":"group_id"},{"_id":"54cfb25b5ff7e617002bbd6b","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"license_plate"},{"_id":"54cfb25b5ff7e617002bbd6a","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"loan_account_number"},{"_id":"54cfb25b5ff7e617002bbd69","ref":"","in":"body","required":false,"desc":"","default":"","type":"yyyy-mm-dd","name":"loan_ended_at"},{"_id":"54cfb25b5ff7e617002bbd68","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"loan_interest_rate"},{"_id":"54cfb25b5ff7e617002bbd67","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"loan_notes"},{"_id":"54cfb25b5ff7e617002bbd66","ref":"","in":"body","required":false,"desc":"","default":"","type":"yyyy-mm-dd","name":"loan_started_at"},{"_id":"54cfb25b5ff7e617002bbd65","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"make"},{"_id":"54cfb25b5ff7e617002bbd64","ref":"","in":"body","required":true,"desc":"mi, km, hr","default":"","type":"string","name":"meter_unit"},{"_id":"54cfb25b5ff7e617002bbd63","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"model"},{"_id":"54cfb25b5ff7e617002bbd62","ref":"","in":"body","required":true,"desc":"*Must be unique","default":"","type":"string","name":"name"},{"_id":"5600672497f69f1700f219c9","ref":"","in":"body","required":true,"desc":"owned, leased, rented, customer","default":"owned","type":"string","name":"ownership"},{"_id":"54cfb25b5ff7e617002bbd61","ref":"","in":"body","required":false,"desc":"","default":"","type":"int","name":"registration_expiration_month"},{"_id":"54cfb25b5ff7e617002bbd60","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"registration_state"},{"_id":"54cfb25b5ff7e617002bbd5f","ref":"","in":"body","required":false,"desc":"","default":"","type":"boolean","name":"secondary_meter"},{"_id":"54cfb25b5ff7e617002bbd5e","ref":"","in":"body","required":false,"desc":"mi, km, hr","default":"","type":"string","name":"secondary_meter_unit"},{"_id":"5600681e8c0c9d0d00dcae62","ref":"","in":"body","required":true,"desc":"imperial, metric","default":"","type":"string","name":"system_of_measurement"},{"_id":"54cfb25b5ff7e617002bbd5d","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"trim"},{"_id":"54cfb25b5ff7e617002bbd5c","ref":"","in":"body","required":true,"desc":"","default":"","type":"int","name":"vehicle_status_id"},{"_id":"54cfb25b5ff7e617002bbd5b","ref":"","in":"body","required":true,"desc":"","default":"","type":"int","name":"vehicle_type_id"},{"_id":"54cfb25b5ff7e617002bbd5a","ref":"","in":"body","required":false,"desc":"*Must be unique","default":"","type":"string","name":"vin"},{"_id":"54cfb25b5ff7e617002bbd59","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"year"},{"_id":"54cfb25b5ff7e617002bbd56","ref":"","in":"body","required":false,"desc":"","default":"","type":"double","name":"residual_value"},{"_id":"581109c208d8050f00948df0","ref":"","in":"body","required":false,"desc":"","default":"","type":"array_int","name":"linked_vehicle_ids"},{"_id":"54cfb25b5ff7e617002bbd58","ref":"","in":"body","required":false,"desc":"","default":"","type":"double","name":"loan_amount"},{"_id":"54cfb25b5ff7e617002bbd57","ref":"","in":"body","required":false,"desc":"","default":"","type":"double","name":"loan_payment"},{"_id":"561d23dc92a0cc350018b260","ref":"","in":"body","required":false,"desc":"","default":"","type":"int","name":"loan_vendor_id"},{"_id":"561d23dc92a0cc350018b25f","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"purchase_detail_attributes[comment]"},{"_id":"561d23dc92a0cc350018b25e","ref":"","in":"body","required":false,"desc":"","default":"","type":"yyyy-mm-dd","name":"purchase_detail_attributes[date]"},{"_id":"561d23dc92a0cc350018b25d","ref":"","in":"body","required":false,"desc":"","default":"","type":"double","name":"purchase_detail_attributes[price]"},{"_id":"561d23dc92a0cc350018b25c","ref":"","in":"body","required":false,"desc":"","default":"","type":"int","name":"purchase_detail_attributes[vendor_id]"},{"_id":"561d23dc92a0cc350018b25b","ref":"","in":"body","required":false,"desc":"","default":"","type":"yyyy-mm-dd","name":"purchase_detail_attributes[warranty_expiration_date]"},{"_id":"561d23dc92a0cc350018b25a","ref":"","in":"body","required":false,"desc":"","default":"","type":"double","name":"purchase_detail_attributes[warranty_expiration_meter_value]"},{"_id":"561d23dc92a0cc350018b259","ref":"","in":"body","required":false,"desc":"","default":"","type":"double","name":"purchase_detail_attributes[meter_entry_attributes[value]]"},{"_id":"561d23dc92a0cc350018b258","ref":"","in":"body","required":false,"desc":"","default":"","type":"boolean","name":"purchase_detail_attributes[meter_entry_attributes[void]]"},{"_id":"5a6a44dc8be43d0069468590","ref":"","in":"body","required":false,"desc":"","default":"","type":"object","name":"external_ids"}],"url":"/vehicles"},"isReference":true,"order":1,"body":"","excerpt":"Create a new vehicle","slug":"vehicles-2","type":"endpoint","title":"/vehicles"}

post/vehicles

Create a new vehicle

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

color:
string
custom_fields:
object
fuel_type_id:
integer
fuel_volume_units:
required
string
us_gallons, uk_gallons, liters
group_id:
integer
license_plate:
string
loan_account_number:
string
loan_ended_at:
yyyy-mm-dd
loan_interest_rate:
string
loan_notes:
string
loan_started_at:
yyyy-mm-dd
make:
string
meter_unit:
required
string
mi, km, hr
model:
string
name:
required
string
*Must be unique
ownership:
required
stringowned
owned, leased, rented, customer
registration_expiration_month:
integer
registration_state:
string
secondary_meter:
boolean
secondary_meter_unit:
string
mi, km, hr
system_of_measurement:
required
string
imperial, metric
trim:
string
vehicle_status_id:
required
integer
vehicle_type_id:
required
integer
vin:
string
*Must be unique
year:
string
residual_value:
double
linked_vehicle_ids:
array of integers
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

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