Skip to main content
POST
Link HVACs

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

externalHvacs
string[]
required

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

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

Example:

Response

Created

isLinked
boolean
required

Indicates if the HVAC is linked to the Energy Hub.

vendor
enum<string>
required

The vendor of the HVAC.

Available options:
VIESSMANN,
DAIKIN,
VAILLANT
name
string
required

The name of the HVAC in human-readable format.

Example:

"Viessmann Vitotronic 200"

externalId
string
required

ID of the device in external vendor system.

Example:

"8413731391660801"

model
string
required

The model of the HVAC.

Example:

"Vitotronic 200"

type
enum<string>
required

The type of the HVAC.

Available options:
AC,
HEATING_CIRCUIT,
DHW,
THERMOSTAT
id
string<uuid>

The ID of the HVAC.