--- title: "Update a vehicle" method: PATCH path: "/v1/vehicles/{vehicleId}" tags: ["Vehicles"] --- # Update a vehicle `PATCH /v1/vehicles/{vehicleId}` Update the details of a single vehicle (required scope vehicles:write) ## Path parameters - `vehicleId` integer, required ## Headers - `Customer-Id` integer, required ## Request body - UpdateVehicleModel — Model representing the data needed to update a vehicle - `groupId` integer — The unique identifier of the group that the vehicle belongs to

Optional: Omit to retain current value - `vehicleType` 'motorcycle' | 'car' | 'trailer' | 'bus' | 'emergency' | 'goodsLess7_5T' | 'goodsMore7_5T' | 'busLess12' — Enumeration representing different types of vehicles

Possible values:

- `fixedResourceId` integer, nullable — The unique identifier of the resource who this vehicle is assigned to

Optional: Omit to retain current value or provide null to unset - `reference` string, nullable — The internal reference of the vehicle - should usually be unique

Optional: Omit to retain current value or provide null to unset - `registration` string — The registration number of the vehicle

Optional: Omit to retain current value - `make` string, nullable — The manufacturer of the vehicle

Optional: Omit to retain current value or provide null to unset - `model` string, nullable — The model of the vehicle

Optional: Omit to retain current value or provide null to unset - `registrationYear` integer, nullable — The year that the vehicle was first registered as new

Optional: Omit to retain current value or provide null to unset - `isSchedulable` boolean — Indicates whether this vehicle can be scheduled jobs

Optional: Omit to retain current value - `idlingFuelConsumptionRate` number, double, nullable — The litre fuel consumption of the vehicle used when idling per minute

Optional: Omit to retain current value or provide null to unset - `costPerKm` number, double, nullable — The running cost of the vehicle per kilometre, expressed in `costPerKmCurrencyCode`

Optional: Omit to retain current value or provide null to unset - `costPerDay` number, double, nullable — The running cost of the vehicle per day, expressed in `costPerDayCurrencyCode`

Optional: Omit to retain current value or provide null to unset - `costPerKmCurrencyCode` 'EUR' | 'AUD' | 'GBP' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'LVL' | 'LTL' | 'MXN' | 'NZD' | 'NOK' | 'PLN' | 'RON' | 'RUB' | 'ZAR' | 'SEK' | 'CHF' | 'AED' | 'USD' — CurrencyCode definitions enum, matches currencies available in the BigChange Client Site

Possible values:

- `costPerDayCurrencyCode` 'EUR' | 'AUD' | 'GBP' | 'BGN' | 'CAD' | 'CZK' | 'DKK' | 'HUF' | 'ILS' | 'LVL' | 'LTL' | 'MXN' | 'NZD' | 'NOK' | 'PLN' | 'RON' | 'RUB' | 'ZAR' | 'SEK' | 'CHF' | 'AED' | 'USD' — CurrencyCode definitions enum, matches currencies available in the BigChange Client Site

Possible values:

- `odometerUnit` 'miles' | 'kilometres' — The unit of measure for distance presented by the vehicles odometer

Possible values:

- `odometer` integer — The latest reading from the vehicles odometer. If provided with a value, the new odometer reading will be recorded even if the value hasn't changed

Optional: Omit to retain current value - `roadSafetyExpiresAt` string, date, nullable — The date of when the vehicles road safety test expires (eg. UK MOT test)

Optional: Omit to retain current value or provide null to unset - `roadTaxExpiresAt` string, date, nullable — The date of when the vehicles road tax expires

Optional: Omit to retain current value or provide null to unset - `serviceDueAt` string, date, nullable — The date of when the vehicles next service is due

Optional: Omit to retain current value or provide null to unset - `insuranceDueAt` string, date, nullable — The date of when the vehicles insurance is due for renewal

Optional: Omit to retain current value or provide null to unset - `co2EmissionsGramsPerKm` integer, nullable — The vehicle co2 emission rate as (grams per km). Mutually exclusive with Co2EmissionsKilogramsPerLitre. Setting this property with a non-null value will nullify the Co2EmissionsKilogramsPerLitre property, if previously set. To retain the current value, omit both Co2EmissionsGramsPerKm and Co2EmissionsKilogramsPerLitre

Optional: Omit to retain current value or provide null to unset - `co2EmissionsKilogramsPerLitre` number, double, nullable — The vehicle co2 emission rate as (kilograms per litre). Mutually exclusive with Co2EmissionsGramsPerKm. Setting this property with a non-null value will nullify the Co2EmissionsGramsPerKm property, if previously set. To retain the current value, omit both Co2EmissionsGramsPerKm and Co2EmissionsKilogramsPerLitre

Optional: Omit to retain current value or provide null to unset - `customFields` CustomFieldWriteModel[] — Custom fields associated with the vehicle. Omit or use an empty list to retain current values

Optional: Omit to retain current value - `definitionId` integer, required — The unique identifier of the associated custom field definition - `value` string, nullable — The value of this custom field. If set to null, any existing value will be unset ## Response `204` No Content ## Other responses - `400` — Bad Request - `403` — Forbidden - `404` — Not Found - `422` — Unprocessable Content - `500` — Internal Server Error --- [API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)