Skip to main content
PUT
/
v1
/
vehicles
Upload Vehicle
curl --request PUT \
  --url https://api.volteras.com/v1/vehicles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vin": "<string>",
  "make": "BMW",
  "region": "NORTH_AMERICA",
  "registrationPlate": "<string>",
  "model": "<string>",
  "modelYear": 123,
  "batteryCapacity": 123,
  "horsepower": 123,
  "generation": "<string>",
  "wltpRange": 123,
  "countryCode": "<string>",
  "tags": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}
'
{
  "vehicleInputId": "<string>",
  "status": "CONNECTED",
  "message": "<string>",
  "vehicleId": "<string>",
  "errors": [],
  "canRetry": true,
  "vin": "<string>",
  "make": "<string>",
  "model": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Request model to connect a single VIN

​
vin
string
required

Vehicle identification number. Unique identifier for the vehicle.

​
make
enum<string>
required

Manufacturer of the vehicle

Available options:
BMW,
MINI,
HYUNDAI,
KIA,
TESLA,
AUDI,
SEAT,
SKODA,
VOLKSWAGEN,
CUPRA,
VOLVO,
ENPHASE,
MERCEDES,
TESLA ENERGY,
ABARTH,
ALFA ROMEO,
CHRYSLER,
CITROEN,
DODGE,
DS AUTOMOBILES,
FIAT,
JEEP,
LANCIA,
MASERATI,
OPEL,
PEUGEOT,
RAM,
VAUXHALL,
STELLANTIS,
FORD,
NISSAN,
POLESTAR
​
region
enum<string>
required

Defines the geographic region for the vehicle, directly influencing which OEM-specific API endpoint will be used for the connection. For OEMs with distinct APIs across regions, this setting ensures the correct regional API is utilized.

Available options:
NORTH_AMERICA,
EUROPE
​
registrationPlate
string | null

Vehicle registration plate

​
model
string | null

Vehicle model

​
modelYear
integer | null

Vehicle model year (the year the model was released, not the year of manufacture)

​
batteryCapacity
number | null

Nominal (IE when manufactured) battery capacity in kWh of the vehicle

​
horsepower
integer | null

Vehicle horsepower

​
generation
string | null

Vehicle generation

​
wltpRange
number | null

WLTP range of the vehicle in km

​
countryCode
string | null

ISO two-character country code of the vehicle, used for retrieving vehicle specifications data for the vehicle. If not populated, will use the default setting (if set).

​
tags
Tag · object[] | null

Tags to associate with the vehicle, for example IDs you want to associate with it, that will then be returned when you fetch the vehicle and can be used to filter vehicles in the list vehicle endpoint.

Response

200 - application/json

Successful Response

​
vehicleInputId
string
required

ID of the vehicle input (IE this specific attempt for the VIN upload).

​
status
enum<string>
required

Status of the vehicle upload.

Available options:
CONNECTED,
PENDING,
CONNECTION_REQUIRED,
INCOMPATIBLE,
ERROR
​
message
string
required

Message for the response.

​
vehicleId
string | null

Vehicle ID of the connected vehicle. This will only be set if the vehicle was connected successfully

​
errors
VehicleInputResponseError · object[]

Errors for the response, if any were raised

​
canRetry
boolean | null

Whether the client can retry the upload on error.

​
vin
string | null

The VIN

​
make
string | null

The vehicle make

​
model
string | null

The vehicle model