Skip to main content
POST
Link batteries

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 batteries IDs request that should be added to the Energy Hub.

externalBatteries
string[]
required

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

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

Example:

Response

Created

isLinked
boolean
required

Indicates if the battery is linked to the Energy Hub.

vendor
enum<string>
required

The vendor of the battery.

Available options:
FRONIUS,
TESLA,
HUAWEI,
SMA
name
string
required

The display name of the battery.

Example:

"My battery"

externalId
string
required

The ID of the battery in external vendor system.

Example:

"8413731391660801"

id
string<uuid>
required

The ID of the battery.

siteName
string

The site name of the home energy device.

Example:

"My Home"