POST
/
v1.0.0
/
link
/
users
/
{userId}
/
vendor-accounts
/
{vendorAccountId}
/
vehicles
[
  {
    "isLinked": true,
    "vendor": "TESLA",
    "name": "My Tesla",
    "externalId": "8413731391660801",
    "vin": "1XKAD29X0KS502460",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Authorizations

X-API-KEY
string
headerrequired

ApiKey used for authorization and authentication

Path Parameters

userId
string
required

User ID

vendorAccountId
string
required

Vendor account ID

Body

application/json

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

externalVehicles
string[]
required

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

Response

200 - application/json
isLinked
boolean
required

Indicates if the vehicle is linked with the Energy Hub Alliance.

vendor
enum<string>
required

The vendor of the vehicle.

Available options:
TESLA,
MERCEDES,
BMW,
MINI,
VW
name
string
required

The display name of the vehicle.

externalId
string
required

ID of the vehicle in external vendor system.

vin
string
required

The vehicle identification number (VIN).

id
string
required

The ID of the vehicle.