Skip to main content
POST
Link vehicles

Authorizations

X-API-KEY
string
header
required

API key used for authorization and authentication.

Path Parameters

userId
string
required

User ID

vendorAccountId
string<uuid>
required

Vendor account ID

Body

application/json

Object for vehicle IDs request that should be added to the Energy Hub.

externalVehicles
string[]
required

List of external IDs of vehicles to be linked to the Energy Hub.

List of external IDs of vehicles to be linked to the Energy Hub.

Example:

Response

Created

isLinked
boolean
required

Indicates if the vehicle is linked to the Energy Hub.

vendor
enum<string>
required

The vendor of the vehicle.

Available options:
TESLA,
MERCEDES,
BMW,
MINI,
VW,
AUDI,
SKODA,
VOLVO,
CUPRA
name
string
required

The display name of the vehicle.

Example:

"My Tesla"

externalId
string
required

ID of the vehicle in external vendor system.

Example:

"8413731391660801"

vin
string
required

The vehicle identification number (VIN).

Example:

"1XKAD29X0KS502460"

id
string<uuid>
required

The ID of the vehicle.