Save a vehicle

Saves an unsaved vehicle of the application's organization — a license plate cameras read with high confidence in the last 7 days — and returns it.

Input. vehicleId in the path, the id of an unsaved vehicle from List vehicles (saved=false). The JSON body is optional. owner is up to 100 characters. make and color default to the make and color the cameras detected; pass a value to override it or null for none. licensePlate saves the vehicle under a corrected license plate instead of the detected one.

Response. 200 with the saved vehicle. Without licensePlate it keeps its vehicleId; with a different license plate it gets the id of that license plate.

Notes. A vehicle that is already saved answers 409 with code: VEHICLE_ALREADY_SAVED. A licensePlate that is already saved answers 409 with code: VEHICLE_EXISTS and details.vehicleId. An id that is not an unsaved vehicle of the last 7 days answers 404.

Side effects. The vehicle becomes a saved vehicle of the organization. Undo with Delete a vehicle.

Request examples

POST /v3/vehicle-api/vehicles/1093527491036451/save

{}

POST /v3/vehicle-api/vehicles/1093527491036451/save

{ "owner": "Jane Doe", "licensePlate": "AB-123-CD", "color": "WHITE" }

Required scope: write:vehicles

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
number
required
1 to 9007199254740991

The numeric id of the vehicle, from List vehicles.

Body Params

Optional values to save the vehicle with.

string | null

The owner of the vehicle, up to 100 characters. null clears it.

string
length ≤ 20

Optional corrected license plate to save the vehicle under instead of the detected one. The vehicle then gets the id of this license plate.

string | null

A make from List vehicle makes. Defaults to the detected make; null saves the vehicle without a make.

string | null
enum

A color from List vehicle colors. Defaults to the detected color; null saves the vehicle without a color.

Responses

400

vehicleId is not a positive integer, or the body is invalid: a licensePlate without 2 to 15 letters (of any alphabet) or digits, an owner over 100 characters, or an unknown make or color.

404

Unsaved vehicle not found in this organization.

429

Too many requests. Try again later.

500

Internal server error.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*