Update details of a user's electric vehicle

PUT

api

partners

v2.0

org

{org_id}

users

{user_id}

electric-vehicles

{electric_vehicle_id}

Update details of a user's electric vehicle

curl --request PUT \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/electric-vehicles/{electric_vehicle_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
  },
  "price_zone": "AT",
  "hems_mode": "balanced",
  "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",
  "charge_target_min": 50,
  "is_charge_policy_enabled": false,
  "minimum_charge_limit": 100,
  "charge_deadline_at": "06:00:00",
  "is_over_charge_allowed": false,
  "expected_max_charge_power": 3600,
  "boost_active_at": "2023-11-07T05:31:56Z",
  "boost_stop_requested_at": "2023-11-07T05:31:56Z",
  "boost_for_next_session": false,
  "latitude": 123,
  "longitude": 123,
  "coordinates_last_updated_at": "2023-11-07T05:31:56Z",
  "geo_fence_distance_m": 100,
  "battery_at_plug_in": 123,
  "steering_block_probed_at": "2023-11-07T05:31:56Z",
  "minimum_solar_coverage": 1,
  "hems_min_export_to_start_w": 2000,
  "hems_max_import_before_stopping_w": 4000,
  "hems_min_production_to_start_w": 3000,
  "hems_min_production_before_stopping_w": 2000,
  "information_notifications": [
    "<string>"
  ]
}
'

import requests

url = "https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/electric-vehicles/{electric_vehicle_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
    },
    "price_zone": "AT",
    "hems_mode": "balanced",
    "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",
    "charge_target_min": 50,
    "is_charge_policy_enabled": False,
    "minimum_charge_limit": 100,
    "charge_deadline_at": "06:00:00",
    "is_over_charge_allowed": False,
    "expected_max_charge_power": 3600,
    "boost_active_at": "2023-11-07T05:31:56Z",
    "boost_stop_requested_at": "2023-11-07T05:31:56Z",
    "boost_for_next_session": False,
    "latitude": 123,
    "longitude": 123,
    "coordinates_last_updated_at": "2023-11-07T05:31:56Z",
    "geo_fence_distance_m": 100,
    "battery_at_plug_in": 123,
    "steering_block_probed_at": "2023-11-07T05:31:56Z",
    "minimum_solar_coverage": 1,
    "hems_min_export_to_start_w": 2000,
    "hems_max_import_before_stopping_w": 4000,
    "hems_min_production_to_start_w": 3000,
    "hems_min_production_before_stopping_w": 2000,
    "information_notifications": ["<string>"]
}
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
    },
    price_zone: 'AT',
    hems_mode: 'balanced',
    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',
    charge_target_min: 50,
    is_charge_policy_enabled: false,
    minimum_charge_limit: 100,
    charge_deadline_at: '06:00:00',
    is_over_charge_allowed: false,
    expected_max_charge_power: 3600,
    boost_active_at: '2023-11-07T05:31:56Z',
    boost_stop_requested_at: '2023-11-07T05:31:56Z',
    boost_for_next_session: false,
    latitude: 123,
    longitude: 123,
    coordinates_last_updated_at: '2023-11-07T05:31:56Z',
    geo_fence_distance_m: 100,
    battery_at_plug_in: 123,
    steering_block_probed_at: '2023-11-07T05:31:56Z',
    minimum_solar_coverage: 1,
    hems_min_export_to_start_w: 2000,
    hems_max_import_before_stopping_w: 4000,
    hems_min_production_to_start_w: 3000,
    hems_min_production_before_stopping_w: 2000,
    information_notifications: ['<string>']
  })
};

fetch('https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/electric-vehicles/{electric_vehicle_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}/electric-vehicles/{electric_vehicle_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
    ],
    'price_zone' => 'AT',
    'hems_mode' => 'balanced',
    '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',
    'charge_target_min' => 50,
    'is_charge_policy_enabled' => false,
    'minimum_charge_limit' => 100,
    'charge_deadline_at' => '06:00:00',
    'is_over_charge_allowed' => false,
    'expected_max_charge_power' => 3600,
    'boost_active_at' => '2023-11-07T05:31:56Z',
    'boost_stop_requested_at' => '2023-11-07T05:31:56Z',
    'boost_for_next_session' => false,
    'latitude' => 123,
    'longitude' => 123,
    'coordinates_last_updated_at' => '2023-11-07T05:31:56Z',
    'geo_fence_distance_m' => 100,
    'battery_at_plug_in' => 123,
    'steering_block_probed_at' => '2023-11-07T05:31:56Z',
    'minimum_solar_coverage' => 1,
    'hems_min_export_to_start_w' => 2000,
    'hems_max_import_before_stopping_w' => 4000,
    'hems_min_production_to_start_w' => 3000,
    'hems_min_production_before_stopping_w' => 2000,
    'information_notifications' => [
        '<string>'
    ]
  ]),
  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}/electric-vehicles/{electric_vehicle_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  \"price_zone\": \"AT\",\n  \"hems_mode\": \"balanced\",\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  \"charge_target_min\": 50,\n  \"is_charge_policy_enabled\": false,\n  \"minimum_charge_limit\": 100,\n  \"charge_deadline_at\": \"06:00:00\",\n  \"is_over_charge_allowed\": false,\n  \"expected_max_charge_power\": 3600,\n  \"boost_active_at\": \"2023-11-07T05:31:56Z\",\n  \"boost_stop_requested_at\": \"2023-11-07T05:31:56Z\",\n  \"boost_for_next_session\": false,\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"coordinates_last_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"geo_fence_distance_m\": 100,\n  \"battery_at_plug_in\": 123,\n  \"steering_block_probed_at\": \"2023-11-07T05:31:56Z\",\n  \"minimum_solar_coverage\": 1,\n  \"hems_min_export_to_start_w\": 2000,\n  \"hems_max_import_before_stopping_w\": 4000,\n  \"hems_min_production_to_start_w\": 3000,\n  \"hems_min_production_before_stopping_w\": 2000,\n  \"information_notifications\": [\n    \"<string>\"\n  ]\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}/electric-vehicles/{electric_vehicle_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  \"price_zone\": \"AT\",\n  \"hems_mode\": \"balanced\",\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  \"charge_target_min\": 50,\n  \"is_charge_policy_enabled\": false,\n  \"minimum_charge_limit\": 100,\n  \"charge_deadline_at\": \"06:00:00\",\n  \"is_over_charge_allowed\": false,\n  \"expected_max_charge_power\": 3600,\n  \"boost_active_at\": \"2023-11-07T05:31:56Z\",\n  \"boost_stop_requested_at\": \"2023-11-07T05:31:56Z\",\n  \"boost_for_next_session\": false,\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"coordinates_last_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"geo_fence_distance_m\": 100,\n  \"battery_at_plug_in\": 123,\n  \"steering_block_probed_at\": \"2023-11-07T05:31:56Z\",\n  \"minimum_solar_coverage\": 1,\n  \"hems_min_export_to_start_w\": 2000,\n  \"hems_max_import_before_stopping_w\": 4000,\n  \"hems_min_production_to_start_w\": 3000,\n  \"hems_min_production_before_stopping_w\": 2000,\n  \"information_notifications\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/electric-vehicles/{electric_vehicle_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  \"price_zone\": \"AT\",\n  \"hems_mode\": \"balanced\",\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  \"charge_target_min\": 50,\n  \"is_charge_policy_enabled\": false,\n  \"minimum_charge_limit\": 100,\n  \"charge_deadline_at\": \"06:00:00\",\n  \"is_over_charge_allowed\": false,\n  \"expected_max_charge_power\": 3600,\n  \"boost_active_at\": \"2023-11-07T05:31:56Z\",\n  \"boost_stop_requested_at\": \"2023-11-07T05:31:56Z\",\n  \"boost_for_next_session\": false,\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"coordinates_last_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"geo_fence_distance_m\": 100,\n  \"battery_at_plug_in\": 123,\n  \"steering_block_probed_at\": \"2023-11-07T05:31:56Z\",\n  \"minimum_solar_coverage\": 1,\n  \"hems_min_export_to_start_w\": 2000,\n  \"hems_max_import_before_stopping_w\": 4000,\n  \"hems_min_production_to_start_w\": 3000,\n  \"hems_min_production_before_stopping_w\": 2000,\n  \"information_notifications\": [\n    \"<string>\"\n  ]\n}"

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

{
  "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>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "price_zone": "AT",
  "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",
  "charge_target_min": 50,
  "charge_target_max": 123,
  "is_charge_policy_enabled": false,
  "charge_policy_last_updated_at": "2023-11-07T05:31:56Z",
  "minimum_charge_limit": 100,
  "charge_deadline_at": "06:00:00",
  "is_over_charge_allowed": false,
  "expected_max_charge_power": 3600,
  "charge_time_remaining": 123,
  "charge_rate_w": 123,
  "is_fully_charged": false,
  "is_plugged_in": false,
  "is_charging": false,
  "battery_level": 123,
  "driving_range": 123,
  "battery_capacity_kwh": "0",
  "charge_state_last_updated_at": "2023-11-07T05:31:56Z",
  "boost_stop_requested_at": "2023-11-07T05:31:56Z",
  "boost_for_next_session": false,
  "latitude": 123,
  "longitude": 123,
  "coordinates_last_updated_at": "2023-11-07T05:31:56Z",
  "geo_fence_distance_m": 100,
  "consumption_last_day_kwh": 123,
  "consumption_last_week_kwh": 123,
  "consumption_last_month_kwh": 123,
  "consumption_last_updated_at": "2023-11-07T05:31:56Z",
  "battery_at_plug_in": 123,
  "steering_block_probed_at": "2023-11-07T05:31:56Z",
  "minimum_solar_coverage": 1,
  "hems_mode": "balanced",
  "hems_min_export_to_start_w": 2000,
  "hems_max_import_before_stopping_w": 4000,
  "hems_min_production_to_start_w": 3000,
  "hems_min_production_before_stopping_w": 2000,
  "information_notifications": [
    "<string>"
  ],
  "embeddable_url": "<string>",
  "authorization_url": "<string>",
  "action_needed": false,
  "has_notification": false,
  "boost_state": "unavailable",
  "boost_feature_enabled": true,
  "last_boost_triggered_at": "2023-11-07T05:31:56Z",
  "last_boost_ended_at": "2023-11-07T05:31:56Z",
  "last_boost_end_reason": "<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 electric vehicle belongs to

electric_vehicle_id

string<uuid>

required

The ID of the modified electric vehicle

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>

default:AT

Available options:

AT,

AT_HOURLY,

BE,

CH,

EE,

DE_LU,

HR,

HU,

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

hems_mode

enum<string>

default:balanced

How an EV's HEMS start/stop thresholds are determined (SC-137).

The preset modes derive the surplus start/stop band at session start from the household PV size (kWp) and the actuation floor — see core_app.services.smart_charging.thresholds.derive_preset_thresholds. The stored raw threshold columns on ElectricVehicle are read only in CUSTOM mode (or as fallback when no usable kWp is known).

EAGER - start on a small surplus fraction of kWp; tolerate more import. BALANCED - the default middle ground. CONSERVATIVE - start only on a large surplus; stop early on import. CUSTOM - the user/operator set the raw threshold columns explicitly.

Available options:

eager,

balanced,

conservative,

custom

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

charge_target_min

integer | null

default:50

is_charge_policy_enabled

boolean | null

default:false

minimum_charge_limit

integer | null

default:100

charge_deadline_at

string<time> | null

default:06:00:00

is_over_charge_allowed

boolean | null

default:false

expected_max_charge_power

integer

default:3600

boost_active_at

string<date-time> | null

Timestamp boost was activated by the workflow. NULL when no boost is active. Retained for the whole boost (REQUESTED before is_charging=true, ONGOING once charging); cleared only when the boost ends.

boost_stop_requested_at

string<date-time> | null

Timestamp the API signalled a boost cancel (owned by the API, not the workflow). Drives BoostState.STOPPING until the workflow ends the boost and clears boost_active_at. Cleared by the API on an un-cancel (re-tap).

boost_for_next_session

boolean

default:false

User tapped boost while unplugged. Workflow consumes on next session start (fires signal_boost on the schedule child) and auto-resets. Means 'don't optimize next session, charge ASAP'.

latitude

number | null

longitude

number | null

coordinates_last_updated_at

string<date-time> | null

geo_fence_distance_m

number

default:100

battery_at_plug_in

number | null

Battery level at latest plug-in event

steering_block_probed_at

string<date-time> | null

Last steering-block recovery probe attempt. NULL = never probed.

minimum_solar_coverage

number

default:1

hems_min_export_to_start_w

integer

default:2000

hems_max_import_before_stopping_w

integer

default:4000

hems_min_production_to_start_w

integer

default:3000

hems_min_production_before_stopping_w

integer

default:2000

information_notifications

string[] | null

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

device_model

DeviceModelOutput · object | null

required

Show child attributes

owner

OwnerOutput · object

required

Show child attributes

created_at

string<date-time>

required

updated_at

string<date-time>

required

price_zone

enum<string>

default:AT

Available options:

AT,

AT_HOURLY,

BE,

CH,

EE,

DE_LU,

HR,

HU,

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

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

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

charge_target_min

integer | null

default:50

charge_target_max

integer | null

Detected OEM-app charge cap (percent). NULL = unknown / no cap detected.

is_charge_policy_enabled

boolean | null

default:false

charge_policy_last_updated_at

string<date-time> | null

minimum_charge_limit

integer | null

default:100

charge_deadline_at

string<time> | null

default:06:00:00

is_over_charge_allowed

boolean | null

default:false

expected_max_charge_power

integer

default:3600

charge_time_remaining

integer | null

charge_rate_w

integer | null

is_fully_charged

boolean | null

default:false

is_plugged_in

boolean | null

default:false

is_charging

boolean | null

default:false

battery_level

integer | null

driving_range

integer | null

battery_capacity_kwh

default:0

charge_state_last_updated_at

string<date-time> | null

boost_stop_requested_at

string<date-time> | null

boost_for_next_session

boolean

default:false

latitude

number | null

longitude

number | null

coordinates_last_updated_at

string<date-time> | null

geo_fence_distance_m

number

default:100

consumption_last_day_kwh

consumption_last_week_kwh

consumption_last_month_kwh

consumption_last_updated_at

string<date-time> | null

battery_at_plug_in

number | null

Battery level at latest plug-in event

steering_block_probed_at

string<date-time> | null

Last steering-block recovery probe attempt. NULL = never probed.

minimum_solar_coverage

number

default:1

hems_mode

string

default:balanced

Maximum string length: 16

hems_min_export_to_start_w

integer

default:2000

hems_max_import_before_stopping_w

integer

default:4000

hems_min_production_to_start_w

integer

default:3000

hems_min_production_before_stopping_w

integer

default:2000

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

action_needed

boolean

default:false

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. The actions field on the detail response carries the specifics.

has_notification

boolean

default:false

True when the device has at least one unread information notification for the owner.

boost_state

enum<string>

default:unavailable

Pure boost lifecycle, shared by EVs and wallboxes (SC-154). Describes only the boost, not whether the device is charging — normal optimizer-driven charging is AVAILABLE (boostable), not ONGOING.

Available options:

available,

requested,

unavailable,

ongoing,

stopping

boost_feature_enabled

boolean

default:true

last_boost_triggered_at

string<date-time> | null

last_boost_ended_at

string<date-time> | null

last_boost_end_reason

string | null

Update details of a user's electric vehicle

curl --request PUT \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/electric-vehicles/{electric_vehicle_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
  },
  "price_zone": "AT",
  "hems_mode": "balanced",
  "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",
  "charge_target_min": 50,
  "is_charge_policy_enabled": false,
  "minimum_charge_limit": 100,
  "charge_deadline_at": "06:00:00",
  "is_over_charge_allowed": false,
  "expected_max_charge_power": 3600,
  "boost_active_at": "2023-11-07T05:31:56Z",
  "boost_stop_requested_at": "2023-11-07T05:31:56Z",
  "boost_for_next_session": false,
  "latitude": 123,
  "longitude": 123,
  "coordinates_last_updated_at": "2023-11-07T05:31:56Z",
  "geo_fence_distance_m": 100,
  "battery_at_plug_in": 123,
  "steering_block_probed_at": "2023-11-07T05:31:56Z",
  "minimum_solar_coverage": 1,
  "hems_min_export_to_start_w": 2000,
  "hems_max_import_before_stopping_w": 4000,
  "hems_min_production_to_start_w": 3000,
  "hems_min_production_before_stopping_w": 2000,
  "information_notifications": [
    "<string>"
  ]
}
'

import requests

url = "https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/electric-vehicles/{electric_vehicle_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
    },
    "price_zone": "AT",
    "hems_mode": "balanced",
    "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",
    "charge_target_min": 50,
    "is_charge_policy_enabled": False,
    "minimum_charge_limit": 100,
    "charge_deadline_at": "06:00:00",
    "is_over_charge_allowed": False,
    "expected_max_charge_power": 3600,
    "boost_active_at": "2023-11-07T05:31:56Z",
    "boost_stop_requested_at": "2023-11-07T05:31:56Z",
    "boost_for_next_session": False,
    "latitude": 123,
    "longitude": 123,
    "coordinates_last_updated_at": "2023-11-07T05:31:56Z",
    "geo_fence_distance_m": 100,
    "battery_at_plug_in": 123,
    "steering_block_probed_at": "2023-11-07T05:31:56Z",
    "minimum_solar_coverage": 1,
    "hems_min_export_to_start_w": 2000,
    "hems_max_import_before_stopping_w": 4000,
    "hems_min_production_to_start_w": 3000,
    "hems_min_production_before_stopping_w": 2000,
    "information_notifications": ["<string>"]
}
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
    },
    price_zone: 'AT',
    hems_mode: 'balanced',
    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',
    charge_target_min: 50,
    is_charge_policy_enabled: false,
    minimum_charge_limit: 100,
    charge_deadline_at: '06:00:00',
    is_over_charge_allowed: false,
    expected_max_charge_power: 3600,
    boost_active_at: '2023-11-07T05:31:56Z',
    boost_stop_requested_at: '2023-11-07T05:31:56Z',
    boost_for_next_session: false,
    latitude: 123,
    longitude: 123,
    coordinates_last_updated_at: '2023-11-07T05:31:56Z',
    geo_fence_distance_m: 100,
    battery_at_plug_in: 123,
    steering_block_probed_at: '2023-11-07T05:31:56Z',
    minimum_solar_coverage: 1,
    hems_min_export_to_start_w: 2000,
    hems_max_import_before_stopping_w: 4000,
    hems_min_production_to_start_w: 3000,
    hems_min_production_before_stopping_w: 2000,
    information_notifications: ['<string>']
  })
};

fetch('https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/electric-vehicles/{electric_vehicle_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}/electric-vehicles/{electric_vehicle_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
    ],
    'price_zone' => 'AT',
    'hems_mode' => 'balanced',
    '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',
    'charge_target_min' => 50,
    'is_charge_policy_enabled' => false,
    'minimum_charge_limit' => 100,
    'charge_deadline_at' => '06:00:00',
    'is_over_charge_allowed' => false,
    'expected_max_charge_power' => 3600,
    'boost_active_at' => '2023-11-07T05:31:56Z',
    'boost_stop_requested_at' => '2023-11-07T05:31:56Z',
    'boost_for_next_session' => false,
    'latitude' => 123,
    'longitude' => 123,
    'coordinates_last_updated_at' => '2023-11-07T05:31:56Z',
    'geo_fence_distance_m' => 100,
    'battery_at_plug_in' => 123,
    'steering_block_probed_at' => '2023-11-07T05:31:56Z',
    'minimum_solar_coverage' => 1,
    'hems_min_export_to_start_w' => 2000,
    'hems_max_import_before_stopping_w' => 4000,
    'hems_min_production_to_start_w' => 3000,
    'hems_min_production_before_stopping_w' => 2000,
    'information_notifications' => [
        '<string>'
    ]
  ]),
  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}/electric-vehicles/{electric_vehicle_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  \"price_zone\": \"AT\",\n  \"hems_mode\": \"balanced\",\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  \"charge_target_min\": 50,\n  \"is_charge_policy_enabled\": false,\n  \"minimum_charge_limit\": 100,\n  \"charge_deadline_at\": \"06:00:00\",\n  \"is_over_charge_allowed\": false,\n  \"expected_max_charge_power\": 3600,\n  \"boost_active_at\": \"2023-11-07T05:31:56Z\",\n  \"boost_stop_requested_at\": \"2023-11-07T05:31:56Z\",\n  \"boost_for_next_session\": false,\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"coordinates_last_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"geo_fence_distance_m\": 100,\n  \"battery_at_plug_in\": 123,\n  \"steering_block_probed_at\": \"2023-11-07T05:31:56Z\",\n  \"minimum_solar_coverage\": 1,\n  \"hems_min_export_to_start_w\": 2000,\n  \"hems_max_import_before_stopping_w\": 4000,\n  \"hems_min_production_to_start_w\": 3000,\n  \"hems_min_production_before_stopping_w\": 2000,\n  \"information_notifications\": [\n    \"<string>\"\n  ]\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}/electric-vehicles/{electric_vehicle_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  \"price_zone\": \"AT\",\n  \"hems_mode\": \"balanced\",\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  \"charge_target_min\": 50,\n  \"is_charge_policy_enabled\": false,\n  \"minimum_charge_limit\": 100,\n  \"charge_deadline_at\": \"06:00:00\",\n  \"is_over_charge_allowed\": false,\n  \"expected_max_charge_power\": 3600,\n  \"boost_active_at\": \"2023-11-07T05:31:56Z\",\n  \"boost_stop_requested_at\": \"2023-11-07T05:31:56Z\",\n  \"boost_for_next_session\": false,\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"coordinates_last_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"geo_fence_distance_m\": 100,\n  \"battery_at_plug_in\": 123,\n  \"steering_block_probed_at\": \"2023-11-07T05:31:56Z\",\n  \"minimum_solar_coverage\": 1,\n  \"hems_min_export_to_start_w\": 2000,\n  \"hems_max_import_before_stopping_w\": 4000,\n  \"hems_min_production_to_start_w\": 3000,\n  \"hems_min_production_before_stopping_w\": 2000,\n  \"information_notifications\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/electric-vehicles/{electric_vehicle_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  \"price_zone\": \"AT\",\n  \"hems_mode\": \"balanced\",\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  \"charge_target_min\": 50,\n  \"is_charge_policy_enabled\": false,\n  \"minimum_charge_limit\": 100,\n  \"charge_deadline_at\": \"06:00:00\",\n  \"is_over_charge_allowed\": false,\n  \"expected_max_charge_power\": 3600,\n  \"boost_active_at\": \"2023-11-07T05:31:56Z\",\n  \"boost_stop_requested_at\": \"2023-11-07T05:31:56Z\",\n  \"boost_for_next_session\": false,\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"coordinates_last_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"geo_fence_distance_m\": 100,\n  \"battery_at_plug_in\": 123,\n  \"steering_block_probed_at\": \"2023-11-07T05:31:56Z\",\n  \"minimum_solar_coverage\": 1,\n  \"hems_min_export_to_start_w\": 2000,\n  \"hems_max_import_before_stopping_w\": 4000,\n  \"hems_min_production_to_start_w\": 3000,\n  \"hems_min_production_before_stopping_w\": 2000,\n  \"information_notifications\": [\n    \"<string>\"\n  ]\n}"

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

{
  "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>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "price_zone": "AT",
  "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",
  "charge_target_min": 50,
  "charge_target_max": 123,
  "is_charge_policy_enabled": false,
  "charge_policy_last_updated_at": "2023-11-07T05:31:56Z",
  "minimum_charge_limit": 100,
  "charge_deadline_at": "06:00:00",
  "is_over_charge_allowed": false,
  "expected_max_charge_power": 3600,
  "charge_time_remaining": 123,
  "charge_rate_w": 123,
  "is_fully_charged": false,
  "is_plugged_in": false,
  "is_charging": false,
  "battery_level": 123,
  "driving_range": 123,
  "battery_capacity_kwh": "0",
  "charge_state_last_updated_at": "2023-11-07T05:31:56Z",
  "boost_stop_requested_at": "2023-11-07T05:31:56Z",
  "boost_for_next_session": false,
  "latitude": 123,
  "longitude": 123,
  "coordinates_last_updated_at": "2023-11-07T05:31:56Z",
  "geo_fence_distance_m": 100,
  "consumption_last_day_kwh": 123,
  "consumption_last_week_kwh": 123,
  "consumption_last_month_kwh": 123,
  "consumption_last_updated_at": "2023-11-07T05:31:56Z",
  "battery_at_plug_in": 123,
  "steering_block_probed_at": "2023-11-07T05:31:56Z",
  "minimum_solar_coverage": 1,
  "hems_mode": "balanced",
  "hems_min_export_to_start_w": 2000,
  "hems_max_import_before_stopping_w": 4000,
  "hems_min_production_to_start_w": 3000,
  "hems_min_production_before_stopping_w": 2000,
  "information_notifications": [
    "<string>"
  ],
  "embeddable_url": "<string>",
  "authorization_url": "<string>",
  "action_needed": false,
  "has_notification": false,
  "boost_state": "unavailable",
  "boost_feature_enabled": true,
  "last_boost_triggered_at": "2023-11-07T05:31:56Z",
  "last_boost_ended_at": "2023-11-07T05:31:56Z",
  "last_boost_end_reason": "<string>"
}

Device Models

Prices

Authentication

Organization

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

Devices

Notification Webhooks

Trading

Loadcurves

Loadcurves Confirmation

Device Onboarding Sessions

Cues

Update details of a user's electric vehicle

Authorizations

Path Parameters

Body

Response