Update details of a user's heat pump

PUT

api

partners

v2.0

org

{org_id}

users

{user_id}

heat-pumps

{heat_pump_id}

Update details of a user's heat pump

curl --request PUT \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_pause_power_active": false,
  "is_smart_optimization_active": false,
  "is_inverter_forced_mode_enabled": false,
  "actual_steering_state": "unknown",
  "device_model": {
    "device_type": {
      "short_name": "<string>",
      "long_name": "<string>"
    },
    "manufacturer": "<string>",
    "model": "<string>",
    "year": 123,
    "cloud_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ac_rated_power_w": 123
  },
  "deleted_at": "2023-11-07T05:31:56Z",
  "pause_power_until": "2023-11-07T05:31:56Z",
  "optimization_score": 123,
  "comment": "<string>",
  "last_monitoring_executed_at": "2023-11-07T05:31:56Z",
  "indoor_target_temperature_offset": 123,
  "dhw_standard_temperature": 123,
  "is_hot_water_heating_enabled": false,
  "is_space_heating_enabled": false,
  "is_pool_heating_enabled": false,
  "is_space_cooling_enabled": false,
  "heating_policy_name": "<string>",
  "maximum_temperature_limit": 123,
  "minimum_temperature_limit": 123,
  "minimum_dhw_temperature_limit": 123,
  "is_heating_policy_enabled": false,
  "away_mode_start": "2023-11-07T05:31:56Z",
  "away_mode_end": "2023-11-07T05:31:56Z",
  "is_away_mode_enabled": true,
  "away_mode_minimum_temperature_limit": 123,
  "optimization_level": "Mid"
}
'

import requests

url = "https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}"

payload = {
    "is_pause_power_active": False,
    "is_smart_optimization_active": False,
    "is_inverter_forced_mode_enabled": False,
    "actual_steering_state": "unknown",
    "device_model": {
        "device_type": {
            "short_name": "<string>",
            "long_name": "<string>"
        },
        "manufacturer": "<string>",
        "model": "<string>",
        "year": 123,
        "cloud_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "ac_rated_power_w": 123
    },
    "deleted_at": "2023-11-07T05:31:56Z",
    "pause_power_until": "2023-11-07T05:31:56Z",
    "optimization_score": 123,
    "comment": "<string>",
    "last_monitoring_executed_at": "2023-11-07T05:31:56Z",
    "indoor_target_temperature_offset": 123,
    "dhw_standard_temperature": 123,
    "is_hot_water_heating_enabled": False,
    "is_space_heating_enabled": False,
    "is_pool_heating_enabled": False,
    "is_space_cooling_enabled": False,
    "heating_policy_name": "<string>",
    "maximum_temperature_limit": 123,
    "minimum_temperature_limit": 123,
    "minimum_dhw_temperature_limit": 123,
    "is_heating_policy_enabled": False,
    "away_mode_start": "2023-11-07T05:31:56Z",
    "away_mode_end": "2023-11-07T05:31:56Z",
    "is_away_mode_enabled": True,
    "away_mode_minimum_temperature_limit": 123,
    "optimization_level": "Mid"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    is_pause_power_active: false,
    is_smart_optimization_active: false,
    is_inverter_forced_mode_enabled: false,
    actual_steering_state: 'unknown',
    device_model: {
      device_type: {short_name: '<string>', long_name: '<string>'},
      manufacturer: '<string>',
      model: '<string>',
      year: 123,
      cloud_service_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      ac_rated_power_w: 123
    },
    deleted_at: '2023-11-07T05:31:56Z',
    pause_power_until: '2023-11-07T05:31:56Z',
    optimization_score: 123,
    comment: '<string>',
    last_monitoring_executed_at: '2023-11-07T05:31:56Z',
    indoor_target_temperature_offset: 123,
    dhw_standard_temperature: 123,
    is_hot_water_heating_enabled: false,
    is_space_heating_enabled: false,
    is_pool_heating_enabled: false,
    is_space_cooling_enabled: false,
    heating_policy_name: '<string>',
    maximum_temperature_limit: 123,
    minimum_temperature_limit: 123,
    minimum_dhw_temperature_limit: 123,
    is_heating_policy_enabled: false,
    away_mode_start: '2023-11-07T05:31:56Z',
    away_mode_end: '2023-11-07T05:31:56Z',
    is_away_mode_enabled: true,
    away_mode_minimum_temperature_limit: 123,
    optimization_level: 'Mid'
  })
};

fetch('https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'is_pause_power_active' => false,
    'is_smart_optimization_active' => false,
    'is_inverter_forced_mode_enabled' => false,
    'actual_steering_state' => 'unknown',
    'device_model' => [
        'device_type' => [
                'short_name' => '<string>',
                'long_name' => '<string>'
        ],
        'manufacturer' => '<string>',
        'model' => '<string>',
        'year' => 123,
        'cloud_service_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'ac_rated_power_w' => 123
    ],
    'deleted_at' => '2023-11-07T05:31:56Z',
    'pause_power_until' => '2023-11-07T05:31:56Z',
    'optimization_score' => 123,
    'comment' => '<string>',
    'last_monitoring_executed_at' => '2023-11-07T05:31:56Z',
    'indoor_target_temperature_offset' => 123,
    'dhw_standard_temperature' => 123,
    'is_hot_water_heating_enabled' => false,
    'is_space_heating_enabled' => false,
    'is_pool_heating_enabled' => false,
    'is_space_cooling_enabled' => false,
    'heating_policy_name' => '<string>',
    'maximum_temperature_limit' => 123,
    'minimum_temperature_limit' => 123,
    'minimum_dhw_temperature_limit' => 123,
    'is_heating_policy_enabled' => false,
    'away_mode_start' => '2023-11-07T05:31:56Z',
    'away_mode_end' => '2023-11-07T05:31:56Z',
    'is_away_mode_enabled' => true,
    'away_mode_minimum_temperature_limit' => 123,
    'optimization_level' => 'Mid'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}"

	payload := strings.NewReader("{\n  \"is_pause_power_active\": false,\n  \"is_smart_optimization_active\": false,\n  \"is_inverter_forced_mode_enabled\": false,\n  \"actual_steering_state\": \"unknown\",\n  \"device_model\": {\n    \"device_type\": {\n      \"short_name\": \"<string>\",\n      \"long_name\": \"<string>\"\n    },\n    \"manufacturer\": \"<string>\",\n    \"model\": \"<string>\",\n    \"year\": 123,\n    \"cloud_service_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"ac_rated_power_w\": 123\n  },\n  \"deleted_at\": \"2023-11-07T05:31:56Z\",\n  \"pause_power_until\": \"2023-11-07T05:31:56Z\",\n  \"optimization_score\": 123,\n  \"comment\": \"<string>\",\n  \"last_monitoring_executed_at\": \"2023-11-07T05:31:56Z\",\n  \"indoor_target_temperature_offset\": 123,\n  \"dhw_standard_temperature\": 123,\n  \"is_hot_water_heating_enabled\": false,\n  \"is_space_heating_enabled\": false,\n  \"is_pool_heating_enabled\": false,\n  \"is_space_cooling_enabled\": false,\n  \"heating_policy_name\": \"<string>\",\n  \"maximum_temperature_limit\": 123,\n  \"minimum_temperature_limit\": 123,\n  \"minimum_dhw_temperature_limit\": 123,\n  \"is_heating_policy_enabled\": false,\n  \"away_mode_start\": \"2023-11-07T05:31:56Z\",\n  \"away_mode_end\": \"2023-11-07T05:31:56Z\",\n  \"is_away_mode_enabled\": true,\n  \"away_mode_minimum_temperature_limit\": 123,\n  \"optimization_level\": \"Mid\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_pause_power_active\": false,\n  \"is_smart_optimization_active\": false,\n  \"is_inverter_forced_mode_enabled\": false,\n  \"actual_steering_state\": \"unknown\",\n  \"device_model\": {\n    \"device_type\": {\n      \"short_name\": \"<string>\",\n      \"long_name\": \"<string>\"\n    },\n    \"manufacturer\": \"<string>\",\n    \"model\": \"<string>\",\n    \"year\": 123,\n    \"cloud_service_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"ac_rated_power_w\": 123\n  },\n  \"deleted_at\": \"2023-11-07T05:31:56Z\",\n  \"pause_power_until\": \"2023-11-07T05:31:56Z\",\n  \"optimization_score\": 123,\n  \"comment\": \"<string>\",\n  \"last_monitoring_executed_at\": \"2023-11-07T05:31:56Z\",\n  \"indoor_target_temperature_offset\": 123,\n  \"dhw_standard_temperature\": 123,\n  \"is_hot_water_heating_enabled\": false,\n  \"is_space_heating_enabled\": false,\n  \"is_pool_heating_enabled\": false,\n  \"is_space_cooling_enabled\": false,\n  \"heating_policy_name\": \"<string>\",\n  \"maximum_temperature_limit\": 123,\n  \"minimum_temperature_limit\": 123,\n  \"minimum_dhw_temperature_limit\": 123,\n  \"is_heating_policy_enabled\": false,\n  \"away_mode_start\": \"2023-11-07T05:31:56Z\",\n  \"away_mode_end\": \"2023-11-07T05:31:56Z\",\n  \"is_away_mode_enabled\": true,\n  \"away_mode_minimum_temperature_limit\": 123,\n  \"optimization_level\": \"Mid\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_pause_power_active\": false,\n  \"is_smart_optimization_active\": false,\n  \"is_inverter_forced_mode_enabled\": false,\n  \"actual_steering_state\": \"unknown\",\n  \"device_model\": {\n    \"device_type\": {\n      \"short_name\": \"<string>\",\n      \"long_name\": \"<string>\"\n    },\n    \"manufacturer\": \"<string>\",\n    \"model\": \"<string>\",\n    \"year\": 123,\n    \"cloud_service_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"ac_rated_power_w\": 123\n  },\n  \"deleted_at\": \"2023-11-07T05:31:56Z\",\n  \"pause_power_until\": \"2023-11-07T05:31:56Z\",\n  \"optimization_score\": 123,\n  \"comment\": \"<string>\",\n  \"last_monitoring_executed_at\": \"2023-11-07T05:31:56Z\",\n  \"indoor_target_temperature_offset\": 123,\n  \"dhw_standard_temperature\": 123,\n  \"is_hot_water_heating_enabled\": false,\n  \"is_space_heating_enabled\": false,\n  \"is_pool_heating_enabled\": false,\n  \"is_space_cooling_enabled\": false,\n  \"heating_policy_name\": \"<string>\",\n  \"maximum_temperature_limit\": 123,\n  \"minimum_temperature_limit\": 123,\n  \"minimum_dhw_temperature_limit\": 123,\n  \"is_heating_policy_enabled\": false,\n  \"away_mode_start\": \"2023-11-07T05:31:56Z\",\n  \"away_mode_end\": \"2023-11-07T05:31:56Z\",\n  \"is_away_mode_enabled\": true,\n  \"away_mode_minimum_temperature_limit\": 123,\n  \"optimization_level\": \"Mid\"\n}"

response = http.request(request)
puts response.read_body

{
  "connection_status": "ok",
  "monitoring_status": "ok",
  "steering_status": "ok",
  "tone": "good",
  "support": {
    "attention_required": 123,
    "service_degraded": 123,
    "informational": 123
  },
  "health": "unhealthy",
  "device_model": {
    "device_type": {
      "short_name": "<string>",
      "long_name": "<string>"
    },
    "manufacturer": "<string>",
    "model": "<string>",
    "cloud_service_instructions": "<string>",
    "cloud_service_signup_link": "<string>",
    "year": 123,
    "cloud_service": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ac_rated_power_w": 123
  },
  "owner": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "external_id": "<string>"
  },
  "price_zone": "AT",
  "steering_reason": "no_schedule",
  "steering_since": "2023-11-07T05:31:56Z",
  "steering_changes_due": 123,
  "service_health": {
    "evaluated_at": "2023-11-07T05:31:56Z",
    "components": [
      {
        "id": "oem_auth",
        "own": "yes",
        "ready": "yes",
        "attribution": "oem",
        "reason": "steering_disabled",
        "own_reason": "steering_disabled",
        "since": "2023-11-07T05:31:56Z",
        "blocked_by": "oem_auth",
        "provider": "price_data"
      }
    ],
    "origin": "oem_auth"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "action_needed": false,
  "is_authenticated": false,
  "is_smart_optimization_active": false,
  "is_inverter_forced_mode_enabled": false,
  "actual_steering_state": "unknown",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deleted_at": "2023-11-07T05:31:56Z",
  "pause_power_until": "2023-11-07T05:31:56Z",
  "is_pause_power_active": false,
  "external_device_id": "",
  "optimization_score": 123,
  "current_mode": "<string>",
  "comment": "<string>",
  "current_state_last_updated_at": "2023-11-07T05:31:56Z",
  "last_monitoring_executed_at": "2023-11-07T05:31:56Z",
  "is_inverter_forced_mode_active": false,
  "inverter_forced_mode_since": "0001-01-01T00:00:00Z",
  "indoor_target_temperature_offset": 123,
  "dhw_standard_temperature": 123,
  "is_hot_water_heating_enabled": false,
  "is_space_heating_enabled": false,
  "is_pool_heating_enabled": false,
  "is_space_cooling_enabled": false,
  "heating_policy_name": "<string>",
  "maximum_temperature_limit": 123,
  "minimum_temperature_limit": 123,
  "minimum_dhw_temperature_limit": 123,
  "is_heating_policy_enabled": false,
  "heating_policy_last_updated_at": "2023-11-07T05:31:56Z",
  "away_mode_start": "2023-11-07T05:31:56Z",
  "away_mode_end": "2023-11-07T05:31:56Z",
  "is_away_mode_enabled": true,
  "away_mode_minimum_temperature_limit": 123,
  "away_mode_last_updated_at": "2023-11-07T05:31:56Z",
  "min_solar_power_w": 2000,
  "operational_mode": "<string>",
  "current_power_consumption_w": 123,
  "inlet_temperature": 123,
  "outlet_temperature": 123,
  "dhw_temperature": 123,
  "outdoor_temperature": 123,
  "indoor_actual_temperature": 123,
  "indoor_target_temperature": 123,
  "consumption_last_day_kwh": 123,
  "consumption_last_week_kwh": 123,
  "consumption_last_month_kwh": 123,
  "consumption_last_updated_at": "2023-11-07T05:31:56Z",
  "optimization_level": "Mid",
  "temperature_delta_override_for_slight_change": 123,
  "temperature_delta_override_for_significant_change": 123,
  "information_notifications": [
    "<string>"
  ],
  "embeddable_url": "<string>",
  "authorization_url": "<string>"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

org_id

string<uuid>

required

The organization ID of the user's organization

user_id

string<uuid>

required

The user ID of the user whom the heat pump belongs to

heat_pump_id

string<uuid>

required

The ID of the modified heat pump

Body

application/json

is_pause_power_active

boolean

default:false

is_smart_optimization_active

boolean

default:false

is_inverter_forced_mode_enabled

boolean

default:false

actual_steering_state

string

default:unknown

Maximum string length: 20

device_model

DeviceModelInput · object | null

Show child attributes

price_zone

enum<string>

Available options:

AT,

AT_HOURLY,

BE,

CH,

EE,

DE_LU,

HR,

HU,

IE_SEM,

IT_CNOR,

IT_CSUD,

IT_NORD,

IT_PUN,

IT_SARD,

IT_SICI,

IT_SUD,

PT,

RO,

SE_1,

SE_2,

SE_3,

SE_4,

UK

deleted_at

string<date-time> | null

When set, the device is considered deleted.

pause_power_until

string<date-time> | null

optimization_score

number | null

comment

string | null

Maximum string length: 300

last_monitoring_executed_at

string<date-time> | null

indoor_target_temperature_offset

dhw_standard_temperature

is_hot_water_heating_enabled

boolean | null

default:false

is_space_heating_enabled

boolean | null

default:false

is_pool_heating_enabled

boolean | null

default:false

is_space_cooling_enabled

boolean | null

default:false

heating_policy_name

string | null

Maximum string length: 100

maximum_temperature_limit

minimum_temperature_limit

minimum_dhw_temperature_limit

is_heating_policy_enabled

boolean | null

default:false

away_mode_start

string<date-time> | null

away_mode_end

string<date-time> | null

is_away_mode_enabled

boolean | null

default:true

away_mode_minimum_temperature_limit

optimization_level

string | null

default:Mid

Maximum string length: 10

Response

200 - application/json

connection_status

enum<string>

required

Available options:

ok,

warning,

error,

unknown

monitoring_status

enum<string>

required

Available options:

ok,

warning,

error,

unknown

steering_status

enum<string>

required

Available options:

ok,

warning,

error,

unknown

tone

required

The device's console health tone, and the only verdict a client should render: action_required when a partner-resolvable action is pending, else the worst of connection and monitoring, with not_steered for a healthy device nobody optimizes. Do not re-derive it from connection_status/monitoring_status/steering_status — those three are cue-blind and would report a device asking for reauthentication as healthy. The status filter on GET /org/{org_id}/devices and the tone counts on …/devices/summary grade the three statuses only, so a device with a pending action reads action_required here while being counted and filtered under its status tone.

Available options:

good,

warning,

critical,

not_steered

support

SupportCountsOutput · object

required

The device's pending cues per Support category.

Show child attributes

health

enum<string> | null

required

The device's service-health verdict: unhealthy when any component reads no, else healthy when any reads yes, else unknown. As of the last hourly sweep for heat pumps and electric vehicles; unknown until a new device is first swept; null when soft-deleted.

Available options:

unhealthy,

unknown,

healthy

device_model

DeviceModelOutput · object | null

required

Show child attributes

owner

OwnerOutput · object

required

Show child attributes

price_zone

enum<string>

required

Available options:

AT,

AT_HOURLY,

BE,

CH,

EE,

DE_LU,

HR,

HU,

IE_SEM,

IT_CNOR,

IT_CSUD,

IT_NORD,

IT_PUN,

IT_SARD,

IT_SICI,

IT_SUD,

PT,

RO,

SE_1,

SE_2,

SE_3,

SE_4,

UK

steering_reason

enum<string>

required

Why actual_steering_state reads the way it does, from a closed set. unknown covers both a pump with no observation and one whose internal reason is outside the published set; no manufacturer error text is ever carried here.

Available options:

no_schedule,

missing_price_data,

coverage_not_price_backed,

no_commands,

too_few_commands,

retries_in_progress,

no_critical_calls,

commands_failed,

commands_successful,

physical_compliance_degraded,

physical_compliance_low,

physical_compliance_healthy,

steering_permission_not_granted,

subscription_required,

non_steerable,

no_blocker,

steering_disabled,

evaluation_pending,

unknown

steering_since

string<date-time> | null

required

When the current pair of desired and observed steering states started — whichever of the two changed last. Null until at least one of them has been recorded. It is a start time, not a last-checked time: an evaluation that finds nothing changed leaves it where it was.

steering_changes_due

integer

required

How many mode changes this pump's schedule called for over the last 24 hours. Zero means the plan asked for nothing, which is what tells an idle pump apart from one that was asked to act and did not.

service_health

ServiceHealthOutput · object

required

Whether the platform is doing what it should for this pump, component by component, and where the problem starts when it is not. Every cell is a reading of state the evaluators already recorded, so a cell nothing has observed reads not_measured rather than a guess.

Show child attributes

created_at

string<date-time>

required

updated_at

string<date-time>

required

action_needed

boolean

default:false

deprecated

Deprecated — use GET /org/{org_id}/notifications/status for per-device-type counts, or GET /org/{org_id}/notifications/actions?device_id=… for the specifics. True when at least one action is pending against this device and the partner must take that action before the device can resume normal operation.

is_authenticated

boolean | null

default:false

is_smart_optimization_active

boolean

default:false

is_inverter_forced_mode_enabled

boolean

default:false

actual_steering_state

string

default:unknown

Observed steering: active, degraded, inactive, blocked, disabled, or unevaluated. Unknown means no observation.

Maximum string length: 20

string<uuid> | null

deleted_at

string<date-time> | null

When set, the device is considered deleted.

pause_power_until

string<date-time> | null

is_pause_power_active

boolean

default:false

external_device_id

string | null

default:""

Maximum string length: 255

optimization_score

number | null

current_mode

string | null

comment

string | null

Maximum string length: 300

current_state_last_updated_at

string<date-time> | null

last_monitoring_executed_at

string<date-time> | null

is_inverter_forced_mode_active

boolean

default:false

inverter_forced_mode_since

string<date-time> | null

default:0001-01-01T00:00:00Z

indoor_target_temperature_offset

dhw_standard_temperature

is_hot_water_heating_enabled

boolean | null

default:false

is_space_heating_enabled

boolean | null

default:false

is_pool_heating_enabled

boolean | null

default:false

is_space_cooling_enabled

boolean | null

default:false

heating_policy_name

string | null

Maximum string length: 100

maximum_temperature_limit

minimum_temperature_limit

minimum_dhw_temperature_limit

is_heating_policy_enabled

boolean | null

default:false

heating_policy_last_updated_at

string<date-time> | null

away_mode_start

string<date-time> | null

away_mode_end

string<date-time> | null

is_away_mode_enabled

boolean | null

default:true

away_mode_minimum_temperature_limit

away_mode_last_updated_at

string<date-time> | null

min_solar_power_w

integer

default:2000

operational_mode

string | null

Maximum string length: 100

current_power_consumption_w

integer | null

inlet_temperature

outlet_temperature

dhw_temperature

outdoor_temperature

indoor_actual_temperature

indoor_target_temperature

consumption_last_day_kwh

consumption_last_week_kwh

consumption_last_month_kwh

consumption_last_updated_at

string<date-time> | null

optimization_level

string | null

default:Mid

Maximum string length: 10

temperature_delta_override_for_slight_change

integer | null

Overrides the temperature change amount when steering the device for slight changes. For example, from MIN to LOW. Disclaimer: this depends on the integration support for overrides.

temperature_delta_override_for_significant_change

integer | null

Overrides the temperature change amount when steering the device for significant changes. For example, from MIN to MAX. Disclaimer: this depends on the integration support for overrides.

information_notifications

string[] | null

embeddable_url

string | null

URL to embeddable onboarding form

authorization_url

string | null

Base URL for authorizing with the Podero server

Update details of a user's heat pump

curl --request PUT \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_pause_power_active": false,
  "is_smart_optimization_active": false,
  "is_inverter_forced_mode_enabled": false,
  "actual_steering_state": "unknown",
  "device_model": {
    "device_type": {
      "short_name": "<string>",
      "long_name": "<string>"
    },
    "manufacturer": "<string>",
    "model": "<string>",
    "year": 123,
    "cloud_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ac_rated_power_w": 123
  },
  "deleted_at": "2023-11-07T05:31:56Z",
  "pause_power_until": "2023-11-07T05:31:56Z",
  "optimization_score": 123,
  "comment": "<string>",
  "last_monitoring_executed_at": "2023-11-07T05:31:56Z",
  "indoor_target_temperature_offset": 123,
  "dhw_standard_temperature": 123,
  "is_hot_water_heating_enabled": false,
  "is_space_heating_enabled": false,
  "is_pool_heating_enabled": false,
  "is_space_cooling_enabled": false,
  "heating_policy_name": "<string>",
  "maximum_temperature_limit": 123,
  "minimum_temperature_limit": 123,
  "minimum_dhw_temperature_limit": 123,
  "is_heating_policy_enabled": false,
  "away_mode_start": "2023-11-07T05:31:56Z",
  "away_mode_end": "2023-11-07T05:31:56Z",
  "is_away_mode_enabled": true,
  "away_mode_minimum_temperature_limit": 123,
  "optimization_level": "Mid"
}
'

import requests

url = "https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}"

payload = {
    "is_pause_power_active": False,
    "is_smart_optimization_active": False,
    "is_inverter_forced_mode_enabled": False,
    "actual_steering_state": "unknown",
    "device_model": {
        "device_type": {
            "short_name": "<string>",
            "long_name": "<string>"
        },
        "manufacturer": "<string>",
        "model": "<string>",
        "year": 123,
        "cloud_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "ac_rated_power_w": 123
    },
    "deleted_at": "2023-11-07T05:31:56Z",
    "pause_power_until": "2023-11-07T05:31:56Z",
    "optimization_score": 123,
    "comment": "<string>",
    "last_monitoring_executed_at": "2023-11-07T05:31:56Z",
    "indoor_target_temperature_offset": 123,
    "dhw_standard_temperature": 123,
    "is_hot_water_heating_enabled": False,
    "is_space_heating_enabled": False,
    "is_pool_heating_enabled": False,
    "is_space_cooling_enabled": False,
    "heating_policy_name": "<string>",
    "maximum_temperature_limit": 123,
    "minimum_temperature_limit": 123,
    "minimum_dhw_temperature_limit": 123,
    "is_heating_policy_enabled": False,
    "away_mode_start": "2023-11-07T05:31:56Z",
    "away_mode_end": "2023-11-07T05:31:56Z",
    "is_away_mode_enabled": True,
    "away_mode_minimum_temperature_limit": 123,
    "optimization_level": "Mid"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    is_pause_power_active: false,
    is_smart_optimization_active: false,
    is_inverter_forced_mode_enabled: false,
    actual_steering_state: 'unknown',
    device_model: {
      device_type: {short_name: '<string>', long_name: '<string>'},
      manufacturer: '<string>',
      model: '<string>',
      year: 123,
      cloud_service_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      ac_rated_power_w: 123
    },
    deleted_at: '2023-11-07T05:31:56Z',
    pause_power_until: '2023-11-07T05:31:56Z',
    optimization_score: 123,
    comment: '<string>',
    last_monitoring_executed_at: '2023-11-07T05:31:56Z',
    indoor_target_temperature_offset: 123,
    dhw_standard_temperature: 123,
    is_hot_water_heating_enabled: false,
    is_space_heating_enabled: false,
    is_pool_heating_enabled: false,
    is_space_cooling_enabled: false,
    heating_policy_name: '<string>',
    maximum_temperature_limit: 123,
    minimum_temperature_limit: 123,
    minimum_dhw_temperature_limit: 123,
    is_heating_policy_enabled: false,
    away_mode_start: '2023-11-07T05:31:56Z',
    away_mode_end: '2023-11-07T05:31:56Z',
    is_away_mode_enabled: true,
    away_mode_minimum_temperature_limit: 123,
    optimization_level: 'Mid'
  })
};

fetch('https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'is_pause_power_active' => false,
    'is_smart_optimization_active' => false,
    'is_inverter_forced_mode_enabled' => false,
    'actual_steering_state' => 'unknown',
    'device_model' => [
        'device_type' => [
                'short_name' => '<string>',
                'long_name' => '<string>'
        ],
        'manufacturer' => '<string>',
        'model' => '<string>',
        'year' => 123,
        'cloud_service_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'ac_rated_power_w' => 123
    ],
    'deleted_at' => '2023-11-07T05:31:56Z',
    'pause_power_until' => '2023-11-07T05:31:56Z',
    'optimization_score' => 123,
    'comment' => '<string>',
    'last_monitoring_executed_at' => '2023-11-07T05:31:56Z',
    'indoor_target_temperature_offset' => 123,
    'dhw_standard_temperature' => 123,
    'is_hot_water_heating_enabled' => false,
    'is_space_heating_enabled' => false,
    'is_pool_heating_enabled' => false,
    'is_space_cooling_enabled' => false,
    'heating_policy_name' => '<string>',
    'maximum_temperature_limit' => 123,
    'minimum_temperature_limit' => 123,
    'minimum_dhw_temperature_limit' => 123,
    'is_heating_policy_enabled' => false,
    'away_mode_start' => '2023-11-07T05:31:56Z',
    'away_mode_end' => '2023-11-07T05:31:56Z',
    'is_away_mode_enabled' => true,
    'away_mode_minimum_temperature_limit' => 123,
    'optimization_level' => 'Mid'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}"

	payload := strings.NewReader("{\n  \"is_pause_power_active\": false,\n  \"is_smart_optimization_active\": false,\n  \"is_inverter_forced_mode_enabled\": false,\n  \"actual_steering_state\": \"unknown\",\n  \"device_model\": {\n    \"device_type\": {\n      \"short_name\": \"<string>\",\n      \"long_name\": \"<string>\"\n    },\n    \"manufacturer\": \"<string>\",\n    \"model\": \"<string>\",\n    \"year\": 123,\n    \"cloud_service_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"ac_rated_power_w\": 123\n  },\n  \"deleted_at\": \"2023-11-07T05:31:56Z\",\n  \"pause_power_until\": \"2023-11-07T05:31:56Z\",\n  \"optimization_score\": 123,\n  \"comment\": \"<string>\",\n  \"last_monitoring_executed_at\": \"2023-11-07T05:31:56Z\",\n  \"indoor_target_temperature_offset\": 123,\n  \"dhw_standard_temperature\": 123,\n  \"is_hot_water_heating_enabled\": false,\n  \"is_space_heating_enabled\": false,\n  \"is_pool_heating_enabled\": false,\n  \"is_space_cooling_enabled\": false,\n  \"heating_policy_name\": \"<string>\",\n  \"maximum_temperature_limit\": 123,\n  \"minimum_temperature_limit\": 123,\n  \"minimum_dhw_temperature_limit\": 123,\n  \"is_heating_policy_enabled\": false,\n  \"away_mode_start\": \"2023-11-07T05:31:56Z\",\n  \"away_mode_end\": \"2023-11-07T05:31:56Z\",\n  \"is_away_mode_enabled\": true,\n  \"away_mode_minimum_temperature_limit\": 123,\n  \"optimization_level\": \"Mid\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_pause_power_active\": false,\n  \"is_smart_optimization_active\": false,\n  \"is_inverter_forced_mode_enabled\": false,\n  \"actual_steering_state\": \"unknown\",\n  \"device_model\": {\n    \"device_type\": {\n      \"short_name\": \"<string>\",\n      \"long_name\": \"<string>\"\n    },\n    \"manufacturer\": \"<string>\",\n    \"model\": \"<string>\",\n    \"year\": 123,\n    \"cloud_service_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"ac_rated_power_w\": 123\n  },\n  \"deleted_at\": \"2023-11-07T05:31:56Z\",\n  \"pause_power_until\": \"2023-11-07T05:31:56Z\",\n  \"optimization_score\": 123,\n  \"comment\": \"<string>\",\n  \"last_monitoring_executed_at\": \"2023-11-07T05:31:56Z\",\n  \"indoor_target_temperature_offset\": 123,\n  \"dhw_standard_temperature\": 123,\n  \"is_hot_water_heating_enabled\": false,\n  \"is_space_heating_enabled\": false,\n  \"is_pool_heating_enabled\": false,\n  \"is_space_cooling_enabled\": false,\n  \"heating_policy_name\": \"<string>\",\n  \"maximum_temperature_limit\": 123,\n  \"minimum_temperature_limit\": 123,\n  \"minimum_dhw_temperature_limit\": 123,\n  \"is_heating_policy_enabled\": false,\n  \"away_mode_start\": \"2023-11-07T05:31:56Z\",\n  \"away_mode_end\": \"2023-11-07T05:31:56Z\",\n  \"is_away_mode_enabled\": true,\n  \"away_mode_minimum_temperature_limit\": 123,\n  \"optimization_level\": \"Mid\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/heat-pumps/{heat_pump_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_pause_power_active\": false,\n  \"is_smart_optimization_active\": false,\n  \"is_inverter_forced_mode_enabled\": false,\n  \"actual_steering_state\": \"unknown\",\n  \"device_model\": {\n    \"device_type\": {\n      \"short_name\": \"<string>\",\n      \"long_name\": \"<string>\"\n    },\n    \"manufacturer\": \"<string>\",\n    \"model\": \"<string>\",\n    \"year\": 123,\n    \"cloud_service_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"ac_rated_power_w\": 123\n  },\n  \"deleted_at\": \"2023-11-07T05:31:56Z\",\n  \"pause_power_until\": \"2023-11-07T05:31:56Z\",\n  \"optimization_score\": 123,\n  \"comment\": \"<string>\",\n  \"last_monitoring_executed_at\": \"2023-11-07T05:31:56Z\",\n  \"indoor_target_temperature_offset\": 123,\n  \"dhw_standard_temperature\": 123,\n  \"is_hot_water_heating_enabled\": false,\n  \"is_space_heating_enabled\": false,\n  \"is_pool_heating_enabled\": false,\n  \"is_space_cooling_enabled\": false,\n  \"heating_policy_name\": \"<string>\",\n  \"maximum_temperature_limit\": 123,\n  \"minimum_temperature_limit\": 123,\n  \"minimum_dhw_temperature_limit\": 123,\n  \"is_heating_policy_enabled\": false,\n  \"away_mode_start\": \"2023-11-07T05:31:56Z\",\n  \"away_mode_end\": \"2023-11-07T05:31:56Z\",\n  \"is_away_mode_enabled\": true,\n  \"away_mode_minimum_temperature_limit\": 123,\n  \"optimization_level\": \"Mid\"\n}"

response = http.request(request)
puts response.read_body

{
  "connection_status": "ok",
  "monitoring_status": "ok",
  "steering_status": "ok",
  "tone": "good",
  "support": {
    "attention_required": 123,
    "service_degraded": 123,
    "informational": 123
  },
  "health": "unhealthy",
  "device_model": {
    "device_type": {
      "short_name": "<string>",
      "long_name": "<string>"
    },
    "manufacturer": "<string>",
    "model": "<string>",
    "cloud_service_instructions": "<string>",
    "cloud_service_signup_link": "<string>",
    "year": 123,
    "cloud_service": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ac_rated_power_w": 123
  },
  "owner": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "external_id": "<string>"
  },
  "price_zone": "AT",
  "steering_reason": "no_schedule",
  "steering_since": "2023-11-07T05:31:56Z",
  "steering_changes_due": 123,
  "service_health": {
    "evaluated_at": "2023-11-07T05:31:56Z",
    "components": [
      {
        "id": "oem_auth",
        "own": "yes",
        "ready": "yes",
        "attribution": "oem",
        "reason": "steering_disabled",
        "own_reason": "steering_disabled",
        "since": "2023-11-07T05:31:56Z",
        "blocked_by": "oem_auth",
        "provider": "price_data"
      }
    ],
    "origin": "oem_auth"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "action_needed": false,
  "is_authenticated": false,
  "is_smart_optimization_active": false,
  "is_inverter_forced_mode_enabled": false,
  "actual_steering_state": "unknown",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deleted_at": "2023-11-07T05:31:56Z",
  "pause_power_until": "2023-11-07T05:31:56Z",
  "is_pause_power_active": false,
  "external_device_id": "",
  "optimization_score": 123,
  "current_mode": "<string>",
  "comment": "<string>",
  "current_state_last_updated_at": "2023-11-07T05:31:56Z",
  "last_monitoring_executed_at": "2023-11-07T05:31:56Z",
  "is_inverter_forced_mode_active": false,
  "inverter_forced_mode_since": "0001-01-01T00:00:00Z",
  "indoor_target_temperature_offset": 123,
  "dhw_standard_temperature": 123,
  "is_hot_water_heating_enabled": false,
  "is_space_heating_enabled": false,
  "is_pool_heating_enabled": false,
  "is_space_cooling_enabled": false,
  "heating_policy_name": "<string>",
  "maximum_temperature_limit": 123,
  "minimum_temperature_limit": 123,
  "minimum_dhw_temperature_limit": 123,
  "is_heating_policy_enabled": false,
  "heating_policy_last_updated_at": "2023-11-07T05:31:56Z",
  "away_mode_start": "2023-11-07T05:31:56Z",
  "away_mode_end": "2023-11-07T05:31:56Z",
  "is_away_mode_enabled": true,
  "away_mode_minimum_temperature_limit": 123,
  "away_mode_last_updated_at": "2023-11-07T05:31:56Z",
  "min_solar_power_w": 2000,
  "operational_mode": "<string>",
  "current_power_consumption_w": 123,
  "inlet_temperature": 123,
  "outlet_temperature": 123,
  "dhw_temperature": 123,
  "outdoor_temperature": 123,
  "indoor_actual_temperature": 123,
  "indoor_target_temperature": 123,
  "consumption_last_day_kwh": 123,
  "consumption_last_week_kwh": 123,
  "consumption_last_month_kwh": 123,
  "consumption_last_updated_at": "2023-11-07T05:31:56Z",
  "optimization_level": "Mid",
  "temperature_delta_override_for_slight_change": 123,
  "temperature_delta_override_for_significant_change": 123,
  "information_notifications": [
    "<string>"
  ],
  "embeddable_url": "<string>",
  "authorization_url": "<string>"
}

Device Models

Prices

Authentication

Organization Branding

Organization

Organization Configuration

Platform

Users

User Charging Config

User Charging Sessions

User Electric Vehicles

Electric Vehicle Charge Policies

Electric Vehicle Charge Policy Overrides

Electric Vehicle Sessions

User Heat Pumps

User Solar Inverters

User Wallboxes

Wallbox HEMS Sessions

User Devices

User Notifications

Devices

Notifications

Notification Webhooks

Trading

Loadcurves

Loadcurves Confirmation

Device Onboarding Sessions

Cues

Trading Control

Update details of a user's heat pump

Authorizations

Path Parameters

Body

Response