Update details of a user's wallbox

PUT

api

partners

v2.0

org

{org_id}

users

{user_id}

wallboxes

{wallbox_id}

Update details of a user's wallbox

curl --request PUT \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/wallboxes/{wallbox_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",
  "charge_deadline_at": "<string>",
  "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,
  "charge_target_max": 80,
  "charge_power_max_w": 7000,
  "battery_capacity_kwh": 123,
  "hems_min_export_to_start_w": 1380,
  "hems_max_import_before_stopping_w": 300,
  "is_charge_policy_enabled": false,
  "minimum_charge_limit": 80,
  "is_over_charge_allowed": false,
  "boost_stop_requested_at": "2023-11-07T05:31:56Z",
  "car_suspended_at": "2023-11-07T05:31:56Z",
  "car_suspension_last_updated_at": "2023-11-07T05:31:56Z",
  "information_notifications": [
    "<string>"
  ]
}
'

import requests

url = "https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/wallboxes/{wallbox_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",
    "charge_deadline_at": "<string>",
    "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,
    "charge_target_max": 80,
    "charge_power_max_w": 7000,
    "battery_capacity_kwh": 123,
    "hems_min_export_to_start_w": 1380,
    "hems_max_import_before_stopping_w": 300,
    "is_charge_policy_enabled": False,
    "minimum_charge_limit": 80,
    "is_over_charge_allowed": False,
    "boost_stop_requested_at": "2023-11-07T05:31:56Z",
    "car_suspended_at": "2023-11-07T05:31:56Z",
    "car_suspension_last_updated_at": "2023-11-07T05:31:56Z",
    "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',
    charge_deadline_at: '<string>',
    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,
    charge_target_max: 80,
    charge_power_max_w: 7000,
    battery_capacity_kwh: 123,
    hems_min_export_to_start_w: 1380,
    hems_max_import_before_stopping_w: 300,
    is_charge_policy_enabled: false,
    minimum_charge_limit: 80,
    is_over_charge_allowed: false,
    boost_stop_requested_at: '2023-11-07T05:31:56Z',
    car_suspended_at: '2023-11-07T05:31:56Z',
    car_suspension_last_updated_at: '2023-11-07T05:31:56Z',
    information_notifications: ['<string>']
  })
};

fetch('https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/wallboxes/{wallbox_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}/wallboxes/{wallbox_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',
    'charge_deadline_at' => '<string>',
    '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,
    'charge_target_max' => 80,
    'charge_power_max_w' => 7000,
    'battery_capacity_kwh' => 123,
    'hems_min_export_to_start_w' => 1380,
    'hems_max_import_before_stopping_w' => 300,
    'is_charge_policy_enabled' => false,
    'minimum_charge_limit' => 80,
    'is_over_charge_allowed' => false,
    'boost_stop_requested_at' => '2023-11-07T05:31:56Z',
    'car_suspended_at' => '2023-11-07T05:31:56Z',
    'car_suspension_last_updated_at' => '2023-11-07T05:31:56Z',
    '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}/wallboxes/{wallbox_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  \"charge_deadline_at\": \"<string>\",\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  \"charge_target_max\": 80,\n  \"charge_power_max_w\": 7000,\n  \"battery_capacity_kwh\": 123,\n  \"hems_min_export_to_start_w\": 1380,\n  \"hems_max_import_before_stopping_w\": 300,\n  \"is_charge_policy_enabled\": false,\n  \"minimum_charge_limit\": 80,\n  \"is_over_charge_allowed\": false,\n  \"boost_stop_requested_at\": \"2023-11-07T05:31:56Z\",\n  \"car_suspended_at\": \"2023-11-07T05:31:56Z\",\n  \"car_suspension_last_updated_at\": \"2023-11-07T05:31:56Z\",\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}/wallboxes/{wallbox_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  \"charge_deadline_at\": \"<string>\",\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  \"charge_target_max\": 80,\n  \"charge_power_max_w\": 7000,\n  \"battery_capacity_kwh\": 123,\n  \"hems_min_export_to_start_w\": 1380,\n  \"hems_max_import_before_stopping_w\": 300,\n  \"is_charge_policy_enabled\": false,\n  \"minimum_charge_limit\": 80,\n  \"is_over_charge_allowed\": false,\n  \"boost_stop_requested_at\": \"2023-11-07T05:31:56Z\",\n  \"car_suspended_at\": \"2023-11-07T05:31:56Z\",\n  \"car_suspension_last_updated_at\": \"2023-11-07T05:31:56Z\",\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}/wallboxes/{wallbox_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  \"charge_deadline_at\": \"<string>\",\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  \"charge_target_max\": 80,\n  \"charge_power_max_w\": 7000,\n  \"battery_capacity_kwh\": 123,\n  \"hems_min_export_to_start_w\": 1380,\n  \"hems_max_import_before_stopping_w\": 300,\n  \"is_charge_policy_enabled\": false,\n  \"minimum_charge_limit\": 80,\n  \"is_over_charge_allowed\": false,\n  \"boost_stop_requested_at\": \"2023-11-07T05:31:56Z\",\n  \"car_suspended_at\": \"2023-11-07T05:31:56Z\",\n  \"car_suspension_last_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"information_notifications\": [\n    \"<string>\"\n  ]\n}"

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

{
  "connection_status": "ok",
  "monitoring_status": "ok",
  "steering_status": "ok",
  "tone": "good",
  "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",
  "mode": "READY",
  "connection": "online",
  "action_needed": false,
  "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": 80,
  "charge_power_max_w": 7000,
  "battery_capacity_kwh": 123,
  "supports_current_modulation": false,
  "supports_phase_switching": false,
  "phases": 1,
  "min_amps": 6,
  "max_amps": 16,
  "capabilities_last_refreshed_at": "2023-11-07T05:31:56Z",
  "electricals_source": "installer_default",
  "electricals_updated_at": "2023-11-07T05:31:56Z",
  "hems_min_export_to_start_w": 1380,
  "hems_max_import_before_stopping_w": 300,
  "firmware_version": "<string>",
  "is_ocpp_connected": false,
  "ocpp_connected_last_updated_at": "2023-11-07T05:31:56Z",
  "total_energy_delivered_wh": 123,
  "is_charge_policy_enabled": false,
  "charge_policy_last_updated_at": "2023-11-07T05:31:56Z",
  "minimum_charge_limit": 80,
  "charge_deadline_at": "<string>",
  "is_over_charge_allowed": false,
  "charge_time_remaining": 123,
  "charge_rate_w": 123,
  "is_fully_charged": false,
  "is_plugged_in": false,
  "is_charging": false,
  "boost_stop_requested_at": "2023-11-07T05:31:56Z",
  "boost_for_next_session": false,
  "car_suspended_at": "2023-11-07T05:31:56Z",
  "car_suspension_last_updated_at": "2023-11-07T05:31:56Z",
  "charge_state_last_updated_at": "2023-11-07T05:31:56Z",
  "consumption_last_day_kwh": 123,
  "consumption_last_week_kwh": 123,
  "consumption_last_month_kwh": 123,
  "consumption_last_updated_at": "2023-11-07T05:31:56Z",
  "information_notifications": [
    "<string>"
  ],
  "embeddable_url": "<string>",
  "authorization_url": "<string>",
  "boost_state": "unavailable",
  "boost_feature_enabled": true
}

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 wallbox belongs to

wallbox_id

string<uuid>

required

The ID of the modified wallbox

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,

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

charge_deadline_at

string<time> | null

Recurring daily charge deadline as a local wall-clock time (e.g. 07:00:00) in the wallbox's price zone. It is rolled to its next local occurrence, so it binds on every session. Null uses the fleet default hour. A session-scoped deadline submitted to /session-soc outranks this for the session it was given for.

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

charge_target_max

integer | null

default:80

charge_power_max_w

integer

default:7000

battery_capacity_kwh

hems_min_export_to_start_w

integer

default:1380

hems_max_import_before_stopping_w

integer

default:300

is_charge_policy_enabled

boolean | null

default:false

minimum_charge_limit

integer | null

default:80

is_over_charge_allowed

boolean | null

default:false

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).

car_suspended_at

string<date-time> | null

Timestamp the car itself stopped accepting charge (OCPP SuspendedEV). NULL when not suspended. Drives the not_charging_reason status field.

car_suspension_last_updated_at

string<date-time> | null

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

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

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

mode

enum<string>

required

User-facing wallbox state pill. Derived from is_authenticated, is_plugged_in, and is_charging. See Wallbox.mode for the truth table.

Available options:

READY,

PLUGGED_IN,

CHARGING,

UNAVAILABLE,

UNKNOWN

connection

enum<string>

required

User-facing wallbox WS-presence dot. Derived from is_authenticated + is_ocpp_connected. See Wallbox.connection for the truth table.

Available options:

online,

offline,

never_connected

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.

price_zone

enum<string>

default:AT

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

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

default:80

charge_power_max_w

integer

default:7000

battery_capacity_kwh

supports_current_modulation

boolean

default:false

supports_phase_switching

boolean

default:false

phases

integer

default:1

min_amps

integer

default:6

max_amps

integer

default:16

capabilities_last_refreshed_at

string<date-time> | null

electricals_source

string

default:installer_default

Maximum string length: 20

electricals_updated_at

string<date-time> | null

hems_min_export_to_start_w

integer

default:1380

hems_max_import_before_stopping_w

integer

default:300

firmware_version

string | null

Maximum string length: 32

is_ocpp_connected

boolean

default:false

ocpp_connected_last_updated_at

string<date-time> | null

total_energy_delivered_wh

integer | null

is_charge_policy_enabled

boolean | null

default:false

charge_policy_last_updated_at

string<date-time> | null

minimum_charge_limit

integer | null

default:80

charge_deadline_at

string<time> | null

Local wall-clock time in the wallbox's price zone, applied to every session. Empty falls back to the fleet default hour.

is_over_charge_allowed

boolean | null

default:false

charge_time_remaining

integer | null

charge_rate_w

number | null

is_fully_charged

boolean | null

default:false

is_plugged_in

boolean | null

default:false

is_charging

boolean | null

default:false

boost_stop_requested_at

string<date-time> | null

boost_for_next_session

boolean

default:false

car_suspended_at

string<date-time> | null

Timestamp the car itself stopped accepting charge (OCPP SuspendedEV). NULL when not suspended. Drives the not_charging_reason status field.

car_suspension_last_updated_at

string<date-time> | null

charge_state_last_updated_at

string<date-time> | null

consumption_last_day_kwh

consumption_last_week_kwh

consumption_last_month_kwh

consumption_last_updated_at

string<date-time> | null

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

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

Update details of a user's wallbox

curl --request PUT \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/wallboxes/{wallbox_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",
  "charge_deadline_at": "<string>",
  "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,
  "charge_target_max": 80,
  "charge_power_max_w": 7000,
  "battery_capacity_kwh": 123,
  "hems_min_export_to_start_w": 1380,
  "hems_max_import_before_stopping_w": 300,
  "is_charge_policy_enabled": false,
  "minimum_charge_limit": 80,
  "is_over_charge_allowed": false,
  "boost_stop_requested_at": "2023-11-07T05:31:56Z",
  "car_suspended_at": "2023-11-07T05:31:56Z",
  "car_suspension_last_updated_at": "2023-11-07T05:31:56Z",
  "information_notifications": [
    "<string>"
  ]
}
'

import requests

url = "https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/wallboxes/{wallbox_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",
    "charge_deadline_at": "<string>",
    "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,
    "charge_target_max": 80,
    "charge_power_max_w": 7000,
    "battery_capacity_kwh": 123,
    "hems_min_export_to_start_w": 1380,
    "hems_max_import_before_stopping_w": 300,
    "is_charge_policy_enabled": False,
    "minimum_charge_limit": 80,
    "is_over_charge_allowed": False,
    "boost_stop_requested_at": "2023-11-07T05:31:56Z",
    "car_suspended_at": "2023-11-07T05:31:56Z",
    "car_suspension_last_updated_at": "2023-11-07T05:31:56Z",
    "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',
    charge_deadline_at: '<string>',
    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,
    charge_target_max: 80,
    charge_power_max_w: 7000,
    battery_capacity_kwh: 123,
    hems_min_export_to_start_w: 1380,
    hems_max_import_before_stopping_w: 300,
    is_charge_policy_enabled: false,
    minimum_charge_limit: 80,
    is_over_charge_allowed: false,
    boost_stop_requested_at: '2023-11-07T05:31:56Z',
    car_suspended_at: '2023-11-07T05:31:56Z',
    car_suspension_last_updated_at: '2023-11-07T05:31:56Z',
    information_notifications: ['<string>']
  })
};

fetch('https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/wallboxes/{wallbox_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}/wallboxes/{wallbox_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',
    'charge_deadline_at' => '<string>',
    '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,
    'charge_target_max' => 80,
    'charge_power_max_w' => 7000,
    'battery_capacity_kwh' => 123,
    'hems_min_export_to_start_w' => 1380,
    'hems_max_import_before_stopping_w' => 300,
    'is_charge_policy_enabled' => false,
    'minimum_charge_limit' => 80,
    'is_over_charge_allowed' => false,
    'boost_stop_requested_at' => '2023-11-07T05:31:56Z',
    'car_suspended_at' => '2023-11-07T05:31:56Z',
    'car_suspension_last_updated_at' => '2023-11-07T05:31:56Z',
    '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}/wallboxes/{wallbox_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  \"charge_deadline_at\": \"<string>\",\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  \"charge_target_max\": 80,\n  \"charge_power_max_w\": 7000,\n  \"battery_capacity_kwh\": 123,\n  \"hems_min_export_to_start_w\": 1380,\n  \"hems_max_import_before_stopping_w\": 300,\n  \"is_charge_policy_enabled\": false,\n  \"minimum_charge_limit\": 80,\n  \"is_over_charge_allowed\": false,\n  \"boost_stop_requested_at\": \"2023-11-07T05:31:56Z\",\n  \"car_suspended_at\": \"2023-11-07T05:31:56Z\",\n  \"car_suspension_last_updated_at\": \"2023-11-07T05:31:56Z\",\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}/wallboxes/{wallbox_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  \"charge_deadline_at\": \"<string>\",\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  \"charge_target_max\": 80,\n  \"charge_power_max_w\": 7000,\n  \"battery_capacity_kwh\": 123,\n  \"hems_min_export_to_start_w\": 1380,\n  \"hems_max_import_before_stopping_w\": 300,\n  \"is_charge_policy_enabled\": false,\n  \"minimum_charge_limit\": 80,\n  \"is_over_charge_allowed\": false,\n  \"boost_stop_requested_at\": \"2023-11-07T05:31:56Z\",\n  \"car_suspended_at\": \"2023-11-07T05:31:56Z\",\n  \"car_suspension_last_updated_at\": \"2023-11-07T05:31:56Z\",\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}/wallboxes/{wallbox_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  \"charge_deadline_at\": \"<string>\",\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  \"charge_target_max\": 80,\n  \"charge_power_max_w\": 7000,\n  \"battery_capacity_kwh\": 123,\n  \"hems_min_export_to_start_w\": 1380,\n  \"hems_max_import_before_stopping_w\": 300,\n  \"is_charge_policy_enabled\": false,\n  \"minimum_charge_limit\": 80,\n  \"is_over_charge_allowed\": false,\n  \"boost_stop_requested_at\": \"2023-11-07T05:31:56Z\",\n  \"car_suspended_at\": \"2023-11-07T05:31:56Z\",\n  \"car_suspension_last_updated_at\": \"2023-11-07T05:31:56Z\",\n  \"information_notifications\": [\n    \"<string>\"\n  ]\n}"

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

{
  "connection_status": "ok",
  "monitoring_status": "ok",
  "steering_status": "ok",
  "tone": "good",
  "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",
  "mode": "READY",
  "connection": "online",
  "action_needed": false,
  "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": 80,
  "charge_power_max_w": 7000,
  "battery_capacity_kwh": 123,
  "supports_current_modulation": false,
  "supports_phase_switching": false,
  "phases": 1,
  "min_amps": 6,
  "max_amps": 16,
  "capabilities_last_refreshed_at": "2023-11-07T05:31:56Z",
  "electricals_source": "installer_default",
  "electricals_updated_at": "2023-11-07T05:31:56Z",
  "hems_min_export_to_start_w": 1380,
  "hems_max_import_before_stopping_w": 300,
  "firmware_version": "<string>",
  "is_ocpp_connected": false,
  "ocpp_connected_last_updated_at": "2023-11-07T05:31:56Z",
  "total_energy_delivered_wh": 123,
  "is_charge_policy_enabled": false,
  "charge_policy_last_updated_at": "2023-11-07T05:31:56Z",
  "minimum_charge_limit": 80,
  "charge_deadline_at": "<string>",
  "is_over_charge_allowed": false,
  "charge_time_remaining": 123,
  "charge_rate_w": 123,
  "is_fully_charged": false,
  "is_plugged_in": false,
  "is_charging": false,
  "boost_stop_requested_at": "2023-11-07T05:31:56Z",
  "boost_for_next_session": false,
  "car_suspended_at": "2023-11-07T05:31:56Z",
  "car_suspension_last_updated_at": "2023-11-07T05:31:56Z",
  "charge_state_last_updated_at": "2023-11-07T05:31:56Z",
  "consumption_last_day_kwh": 123,
  "consumption_last_week_kwh": 123,
  "consumption_last_month_kwh": 123,
  "consumption_last_updated_at": "2023-11-07T05:31:56Z",
  "information_notifications": [
    "<string>"
  ],
  "embeddable_url": "<string>",
  "authorization_url": "<string>",
  "boost_state": "unavailable",
  "boost_feature_enabled": true
}

Device Models

Prices

Authentication

Organization

Device Simulator

API Reference

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

Simulator Connections

Trading Control

Authorizations

Path Parameters

Body

Response