cURL
curl --request PATCH \
--url https://api.example.com/v2/vehicles/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"plate_number": "<string>",
"plate_state": "<string>",
"vehicle_number": "<string>",
"active": true,
"vehicle_make": "<string>",
"vehicle_model": "<string>",
"year": "<string>",
"lessee_renter": "<string>",
"vehicle_type_code": "<string>"
}
'import requests
url = "https://api.example.com/v2/vehicles/{id}/"
payload = {
"plate_number": "<string>",
"plate_state": "<string>",
"vehicle_number": "<string>",
"active": True,
"vehicle_make": "<string>",
"vehicle_model": "<string>",
"year": "<string>",
"lessee_renter": "<string>",
"vehicle_type_code": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
plate_number: '<string>',
plate_state: '<string>',
vehicle_number: '<string>',
active: true,
vehicle_make: '<string>',
vehicle_model: '<string>',
year: '<string>',
lessee_renter: '<string>',
vehicle_type_code: '<string>'
})
};
fetch('https://api.example.com/v2/vehicles/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v2/vehicles/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'plate_number' => '<string>',
'plate_state' => '<string>',
'vehicle_number' => '<string>',
'active' => true,
'vehicle_make' => '<string>',
'vehicle_model' => '<string>',
'year' => '<string>',
'lessee_renter' => '<string>',
'vehicle_type_code' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v2/vehicles/{id}/"
payload := strings.NewReader("{\n \"plate_number\": \"<string>\",\n \"plate_state\": \"<string>\",\n \"vehicle_number\": \"<string>\",\n \"active\": true,\n \"vehicle_make\": \"<string>\",\n \"vehicle_model\": \"<string>\",\n \"year\": \"<string>\",\n \"lessee_renter\": \"<string>\",\n \"vehicle_type_code\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/v2/vehicles/{id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"plate_number\": \"<string>\",\n \"plate_state\": \"<string>\",\n \"vehicle_number\": \"<string>\",\n \"active\": true,\n \"vehicle_make\": \"<string>\",\n \"vehicle_model\": \"<string>\",\n \"year\": \"<string>\",\n \"lessee_renter\": \"<string>\",\n \"vehicle_type_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/vehicles/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"plate_number\": \"<string>\",\n \"plate_state\": \"<string>\",\n \"vehicle_number\": \"<string>\",\n \"active\": true,\n \"vehicle_make\": \"<string>\",\n \"vehicle_model\": \"<string>\",\n \"year\": \"<string>\",\n \"lessee_renter\": \"<string>\",\n \"vehicle_type_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"custom_fields": "<string>",
"added_date": "2023-11-07T05:31:56Z",
"fleet": {
"id": 123,
"region_details": [
{
"id": 123,
"title": "<string>"
}
],
"title": "<string>",
"is_active": true,
"warning_threshold_per_vehicle": "<string>",
"deactivation_threshold_per_vehicle": "<string>",
"client": "<string>",
"onboarding_vehicle_order": 123
},
"plate_number": "<string>",
"plate_state": "<string>",
"vehicle_number": "<string>",
"active": true,
"vehicle_make": "<string>",
"vehicle_model": "<string>",
"year": "<string>",
"lessee_renter": "<string>",
"vehicle_type_code": "<string>"
}Vehicles
Update
Update a vehicle by ID.
PATCH
/
v2
/
vehicles
/
{id}
/
cURL
curl --request PATCH \
--url https://api.example.com/v2/vehicles/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"plate_number": "<string>",
"plate_state": "<string>",
"vehicle_number": "<string>",
"active": true,
"vehicle_make": "<string>",
"vehicle_model": "<string>",
"year": "<string>",
"lessee_renter": "<string>",
"vehicle_type_code": "<string>"
}
'import requests
url = "https://api.example.com/v2/vehicles/{id}/"
payload = {
"plate_number": "<string>",
"plate_state": "<string>",
"vehicle_number": "<string>",
"active": True,
"vehicle_make": "<string>",
"vehicle_model": "<string>",
"year": "<string>",
"lessee_renter": "<string>",
"vehicle_type_code": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
plate_number: '<string>',
plate_state: '<string>',
vehicle_number: '<string>',
active: true,
vehicle_make: '<string>',
vehicle_model: '<string>',
year: '<string>',
lessee_renter: '<string>',
vehicle_type_code: '<string>'
})
};
fetch('https://api.example.com/v2/vehicles/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v2/vehicles/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'plate_number' => '<string>',
'plate_state' => '<string>',
'vehicle_number' => '<string>',
'active' => true,
'vehicle_make' => '<string>',
'vehicle_model' => '<string>',
'year' => '<string>',
'lessee_renter' => '<string>',
'vehicle_type_code' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v2/vehicles/{id}/"
payload := strings.NewReader("{\n \"plate_number\": \"<string>\",\n \"plate_state\": \"<string>\",\n \"vehicle_number\": \"<string>\",\n \"active\": true,\n \"vehicle_make\": \"<string>\",\n \"vehicle_model\": \"<string>\",\n \"year\": \"<string>\",\n \"lessee_renter\": \"<string>\",\n \"vehicle_type_code\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/v2/vehicles/{id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"plate_number\": \"<string>\",\n \"plate_state\": \"<string>\",\n \"vehicle_number\": \"<string>\",\n \"active\": true,\n \"vehicle_make\": \"<string>\",\n \"vehicle_model\": \"<string>\",\n \"year\": \"<string>\",\n \"lessee_renter\": \"<string>\",\n \"vehicle_type_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/vehicles/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"plate_number\": \"<string>\",\n \"plate_state\": \"<string>\",\n \"vehicle_number\": \"<string>\",\n \"active\": true,\n \"vehicle_make\": \"<string>\",\n \"vehicle_model\": \"<string>\",\n \"year\": \"<string>\",\n \"lessee_renter\": \"<string>\",\n \"vehicle_type_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"custom_fields": "<string>",
"added_date": "2023-11-07T05:31:56Z",
"fleet": {
"id": 123,
"region_details": [
{
"id": 123,
"title": "<string>"
}
],
"title": "<string>",
"is_active": true,
"warning_threshold_per_vehicle": "<string>",
"deactivation_threshold_per_vehicle": "<string>",
"client": "<string>",
"onboarding_vehicle_order": 123
},
"plate_number": "<string>",
"plate_state": "<string>",
"vehicle_number": "<string>",
"active": true,
"vehicle_make": "<string>",
"vehicle_model": "<string>",
"year": "<string>",
"lessee_renter": "<string>",
"vehicle_type_code": "<string>"
}Plate number and plate state cannot be updated after vehicle creation.
Custom fields are set at the fleet level by FleetIT. You can update the values of existing custom fields, but you cannot create new custom field names or modify the field structure.
Authorizations
JWTAPIKey
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
A unique integer value identifying this vehicle.
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Maximum string length:
15Maximum string length:
2Maximum string length:
20Maximum string length:
50Maximum string length:
50Maximum string length:
5Maximum string length:
255Maximum string length:
15Response
200 - application/json
Show child attributes
Show child attributes
Maximum string length:
15Maximum string length:
2Maximum string length:
20Maximum string length:
50Maximum string length:
50Maximum string length:
5Maximum string length:
255Maximum string length:
15Was this page helpful?
⌘I

