POST
/
v1.0.0
/
link
/
users
/
{userId}
/
vendor-accounts
/
{vendorAccountId}
/
hvac
[
  {
    "isLinked": true,
    "vendor": "VIESSMANN",
    "name": "Viessmann Vitotronic 200",
    "externalId": "8413731391660801",
    "model": "Vitotronic 200",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "AC"
  }
]

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

externalHvacs
string[]
required

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

Response

200 - application/json
isLinked
boolean
required

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

vendor
enum<string>
required

The vendor of the HVAC.

Available options:
VIESSMANN,
DAIKIN
name
string
required

The name of the HVAC in human-readable format.

externalId
string
required

ID of the device in external vendor system.

model
string
required

The model of the HVAC.

id
string

The ID of the HVAC.

type
enum<string>
required

The type of the HVAC.

Available options:
AC,
HEATPUMP,
DHW,
THERMOSTAT
List HVACs from vendorHVAC data