POST
/
v1.0.0
/
link
/
users
/
{userId}
/
vendor-accounts
/
{vendorAccountId}
/
batteries
[
  {
    "isLinked": true,
    "vendor": "FRONIUS",
    "name": "My battery",
    "externalId": "8413731391660801",
    "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 batteries IDs request that should be added to the Energy Hub Alliance.

externalBatteries
string[]
required

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

Response

200 - application/json
isLinked
boolean
required

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

vendor
enum<string>
required

The vendor of the battery.

Available options:
FRONIUS,
TESLA,
SMA
name
string
required

The display name of the battery.

externalId
string
required

ID of the battery in external vendor system.

id
string
required

The ID of the battery.

Link PV invertersLink meters