Skip to main content
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>"
}
'
{
  "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,
    "billing_type": "PREPAID",
    "onboarding_stage": "INITIAL",
    "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

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

A unique integer value identifying this vehicle.

Body

plate_number
string
Maximum string length: 15
plate_state
string
Maximum string length: 2
vehicle_number
string
Maximum string length: 20
active
boolean
vehicle_make
string | null
Maximum string length: 50
vehicle_model
string | null
Maximum string length: 50
year
string | null
Maximum string length: 5
lessee_renter
string | null
Maximum string length: 255
vehicle_type_code
string | null
Maximum string length: 15

Response

200 - application/json
id
integer
required
custom_fields
string
required
added_date
string<date-time>
required
fleet
object
required
plate_number
string
Maximum string length: 15
plate_state
string
Maximum string length: 2
vehicle_number
string
Maximum string length: 20
active
boolean
vehicle_make
string | null
Maximum string length: 50
vehicle_model
string | null
Maximum string length: 50
year
string | null
Maximum string length: 5
lessee_renter
string | null
Maximum string length: 255
vehicle_type_code
string | null
Maximum string length: 15