User Electric Vehicles

Trigger a boost charge or arm boost for the next session

Trigger boost on the EV.

Behaviour depends on the EV’s current state:

Plugged in + idle (boost_state=available): immediately signals the running schedule workflow to start charging now, bypassing optimization.
Unplugged (boost_state=unavailable due to not plugged in): arms boost_for_next_session=True. The next plug-in’s session workflow will automatically fire boost on its schedule child, then auto-reset the flag.
Already charging or in flight (boost_state is 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 fields:

state: the EV’s current boost_state.
reason: already_charging, fully_charged, no_active_session, or internal_error.

The arm path is idempotent: re-tapping while already armed returns 204 with no change. To clear an armed flag, use DELETE /boost.

POST

api

partners

v2.0

org

{org_id}

users

{user_id}

electric-vehicles

{electric_vehicle_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}/electric-vehicles/{electric_vehicle_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

electric_vehicle_id

string<uuid>

required

The electric vehicle ID

Response

No Content

Disarm a previously-armed boost for the next sessionClear ``boost_for_next_session`` on the EV. Idempotent: 204 whether the flag was set or already clear. Use this when a user taps a button that's currently in the "armed" state to reverse their pre-plug arming. Has no effect on a live boost in progress — those end via the natural end-conditions (full / unplug / OEM stop). To stop a live boost, the user must unplug the vehicle.

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}/electric-vehicles/{electric_vehicle_id}/boost \
  --header 'Authorization: Bearer <token>'

{}