Skip to main content
POST
curl

Authorizations

x-api-key
string
header
required

Path Parameters

deviceId
string
required

The unique identifier for the EV Charger device.

Example:

"device_abc123"

Body

application/json

Sparse map of writable settings. At least one field is required. Each value uses the canonical { value, unit } shape; unit must match the canonical setting.

Sparse map of writable settings. At least one field is required. Unknown or read-only keys are rejected with UNSUPPORTED_SETTING. Some settings cannot share a request because they set the same thing on the device — max_charge_rate and max_charge_current are one rate ceiling expressed in kilowatts and in amperes, and a charger that holds a single rate register refuses the pair with UNSUPPORTED_SETTING_COMBINATION rather than choosing between them. Which settings collide is a property of the device, so send one of a colliding pair and read details.conflictingSettings if a request is refused.

max_charge_rate
Quantity · object

Maximum charging power the charger will draw. (unit: kw, min: 0, max: 50)

max_charge_current
Quantity · object

Maximum charging current the charger will draw. (unit: amps, min: 0, max: 32)

cable_lock
object

Whether the charging cable is locked to the charger.

smart_charging
object

Whether the charger's own smart-charging schedule is active. When off, the charger does not start charges on its own, so a stop holds until you command a charge.

Response

Settings written. Response lists the canonical setting keys that changed.

success
boolean
required

Always true for success responses.

data
Ev Charger Settings Update · object
required

Acknowledgement of a settings write. updated lists the canonical setting keys that changed; OEMs that fire-and-forget will still echo the keys. A device holds only the values its own hardware steps to, so a written value can land on the nearest step it can deliver. Read the settings back to see what it holds. A value the device cannot deliver at all is refused rather than quietly adjusted.

meta
Response Meta · object
required

Metadata attached to every response: the request identifier, the serving environment, the build timestamp, and the server-side latency.