User Wallboxes

Trigger a boost charge or arm boost for the next session

Trigger a “charge now” boost on the wallbox, overriding HEMS surplus control.

Behaviour depends on the wallbox’s current state:

Plugged in + idle (boost_state=available, e.g. HEMS paused at 0 A): immediately holds the box at full rate, bypassing the surplus gates.
Unplugged (boost_state=unavailable): arms boost_for_next_session=True; the next plug-in’s workflow auto-fires boost, then clears the flag.
Already charging / in flight (ongoing or requested): 409 with reason=already_charging.
Fully charged: 409 with reason=fully_charged.

Returns 204 on success (boost triggered or armed). Returns 409 when the request can’t be honoured, with state (current boost_state) and reason (already_charging, fully_charged, or internal_error). The arm path is idempotent. To cancel a live boost or clear an armed flag, use DELETE /boost.

POST

api

partners

v2.0

org

{org_id}

users

{user_id}

wallboxes

{wallbox_id}

boost

Trigger a boost charge or arm boost for the next session

curl --request POST \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/wallboxes/{wallbox_id}/boost \
  --header 'Authorization: Bearer <token>'

{}

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

user_id

string<uuid>

required

The user ID whom the wallbox belongs to

wallbox_id

string<uuid>

required

The EV charger (wallbox) UUID

Response

No Content

Cancel a live boost and disarm a boost armed for the next sessionUndo a boost on the wallbox — unified "stop boosting" affordance. Cancels a live boost (returns the box to normal HEMS surplus control) **and** clears any `boost_for_next_session` arm. Idempotent: 204 whether or not a boost was active or armed.

Trigger a boost charge or arm boost for the next session

curl --request POST \
  --url https://api.example.com/api/partners/v2.0/org/{org_id}/users/{user_id}/wallboxes/{wallbox_id}/boost \
  --header 'Authorization: Bearer <token>'

{}