Skip to main content
POST
/
v1.0.0
/
link
/
users
/
{userId}
/
vendor-accounts
/
{vendorAccountId}
/
vehicles
Link vehicles
curl --request POST \
  --url https://api.energy-hub.io/v1.0.0/link/users/{userId}/vendor-accounts/{vendorAccountId}/vehicles \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "externalVehicles": [
    "8413731391660801"
  ]
}
'
[
  {
    "isLinked": true,
    "vendor": "TESLA",
    "name": "My Tesla",
    "externalId": "8413731391660801",
    "vin": "1XKAD29X0KS502460",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

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:
["8413731391660801"]

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.