Vehicles

Update a vehicle

Changes only the fields in the request. Either all of them are changed or none. See VehicleUpdate for how to clear a field.

patch/v1/locations/{locationId}/vehicles/{vehicleId}

Request

  • Base URL: https://api.cliento.com
  • URL: https://api.cliento.com/v1/locations/{locationId}/vehicles/{vehicleId}
  • Auth: HTTP bearer

Path parameters

locationIdstring required
vehicleIdstring required

Headers

Idempotency-Keystring

A value you make up for this one request, such as a UUID. Send the same value when you retry and the first answer is returned; see Retrying safely.

Request body

descriptionstring nullable

What the vehicle is called in Cliento, such as The red van.

notesstring nullable

Staff-facing notes, at most 1000 characters.

registrationNumberstring nullable

The registration number, one to seven characters.

Example request

{
  "description": "The red van",
  "registrationNumber": "ABC123"
}

Response

OK

colourstring

From the vehicle register.

createdAtstring date-time
descriptionstring

What the vehicle is called in Cliento. A lookup in the vehicle register fills it in with the make, model, colour and year; staff can change it.

externalReferencestring

Your own id for it, as sent when it was created.

idstring required
locationIdstring required
makestring

From the Swedish vehicle register, when staff have looked the vehicle up in Cliento. Not set through the API.

modelstring

From the vehicle register.

modelYearinteger

From the vehicle register.

notesstring

Staff-facing notes, at most 1000 characters.

registrationNumberstring

The registration number, one to seven characters.

updatedAtstring date-time

Example response

{
  "colour": "Red",
  "description": "The red van",
  "externalReference": "crm-88121",
  "id": "veh_3Ks7pQx2Wn9Tb4Vd6HyRcE",
  "locationId": "loc_4fK9xQ2mLr8TzB1vNc7HdW",
  "make": "Volvo",
  "model": "V60",
  "modelYear": 2021,
  "registrationNumber": "ABC123"
}

Changes

No recorded changes to this operation across all 1 revision of this API.