Trigger a boost charge or arm boost for the next session
Trigger a “charge now” boost on the wallbox, overriding whatever optimization it is under — solar-surplus control, price windows, or both.
Behaviour depends on the wallbox’s current state:
- EV-managed (the owner has a connected EV): 409 with
reason=ev_managed— the EV workflow steers this wallbox; use the EV boost endpoint instead. - Not steered for charging (no optimization mode the boost could override —
e.g. nothing enabled, unauthenticated, no current modulation): 409 with
reason=not_eligible. These two checks run before the state checks below. Boost works in all three wallbox-only modes (solar, spot, solar+spot), with two mode-specific limits:- a spot-optimized box boosts only while its price-optimization run is
actively steering. Plugged with no such run — no session open yet, or the
session’s charging plan already ran to completion — boost requests 409
not_eligiblerather than accepting a boost that would not take effect. While unplugged it arms normally; - a box eligible for nothing but boost (solar mode without an inverter)
is live-fire only: while unplugged it 409s
not_eligibleinstead of armingboost_for_next_session, because nothing would read the flag.
- a spot-optimized box boosts only while its price-optimization run is
actively steering. Plugged with no such run — no session open yet, or the
session’s charging plan already ran to completion — boost requests 409
- Plugged, boostable (
boost_state=available— paused at 0 A OR charging on surplus or a price window): immediately holds the box at full rate. - Unplugged (
boost_state=unavailable): armsboost_for_next_session=True; the next plug-in’s workflow auto-fires boost, then clears the flag. - A boost already running (
ongoingorrequested): 409already_charging. - Cancel in flight (
stopping): un-cancels the live boost, returning toongoing.
Returns 204 on success (boost triggered, un-cancelled, or armed). Returns 409 when
the request can’t be honoured, with state (current boost_state) and reason
(ev_managed, not_eligible, already_charging, or internal_error). The arm
path is idempotent. To cancel a live boost or clear an armed flag, use DELETE /boost.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
- Token URL
- /oauth2/token/
- Token URL
- /api/partners/v2.0/auth/token
Path Parameters
The organization ID
The user ID whom the wallbox belongs to
The EV charger (wallbox) UUID
Response
No Content
