Circuit / Update

patch

https://{tenantUrl}/public-api/resources/circuits/v2.0/{circuit}

Update a circuit

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

circuit

integer

required

Body Params

operatorId

integer | null

The operator ID for this resource.
Required for global admin tokens.
Optional for operator-scoped tokens (defaults to token's operator).

name

string

parentCircuitId

integer | null

Specify parent circuit in Multi-level DLM. Circuits used in flexibility assets or using load balancing integration can not be used in Multi-level DLM.

phases

string

enum

Allowed:

phaseRotation

string

enum

R stands for L1,

S - for L2

T - for L3

So for example RST = L1, L2, L3, while RTS = L1, L3, L2, etc.

We are deriving the connected phase from this property for single phase if connectedPhase is not provided. Please don't rely on this property anymore as this functionality will be turned of in near future. Pass the correct connectedPhase instead. If you pass both properties (connectedPhase and phaseRotation) only connectedPhase will be taken into consideration for determining the phase.

Allowed:

connectedPhase

string

enum

Specifies the active line conductors used in the circuit.

L1_L2 - Valid when phases = split_phase in electrical configuration star or phases = single_phase in electrical configuration delta
L2_L3 - Valid when phases = split_phase in electrical configuration star or phases = single_phase in electrical configuration delta
L1_L3 - Valid when phases = split_phase in electrical configuration star or phases = single_phase in electrical configuration delta
L1 - Valid when phases = single_phase in electrical configuration star
L2 - Valid when phases = single_phase in electrical configuration star
L3 - Valid when phases = single_phase in electrical configuration star

Allowed:

electricalConfiguration

string

enum

Defaults to star

Defines the type of electrical configuration of the charge point. The available options are
star - Star/Wye (Y) (default)
delta - Delta (Δ)

Allowed:

maxVoltage

string | null

enum

maxCurrent

number

The current (A) limit for the whole circuit. This would usually be the circuit breaker rated current.

minChargePointCurrent

number | null

Defines what is the lowest current (A) allowed per charge point. New sessions cannot start if any of the existing ones has to be lowered to less than the set minimum rate. This is to ensure that a connected car vehicle actually charge because the vehicles have a minimum charging rate below which they would not accept the charge. If left empty, there is no minimum.

applyMinimumCurrentOnSessionStart

boolean

Defaults to false

When enabled, new sessions start at the configured minimum current (minChargePointCurrent). This improves user experience but bypasses initial DLM safety checks. Use with caution: In offline scenarios, the DLM cannot limit the load, creating a high risk of circuit overload. Only enable this option if your site has a stable internet connection and the electrical circuit has significant spare capacity to handle all charge points operating at their minimum current simultaneously.

applyFcfsLoadManagementStrategy

boolean

Defaults to false

When enabled, on charge points with multiple EVSEs, only the first active session receives current. Any other session on the same charge point waits until the first session ends.

setSessionLimitToZeroOnIdle

boolean

deprecated

Sets the limit to 0 when the session enters an idle period.

electricityMeterId

number | null

The ID of the Electricity Meter linked to the circuit (if any).

offlineReservedCurrent

number | null

The current (A) reserved for other loads on the circuit (non-managed loads) when the Electricity Meter is offline.

loadBalancingIntegration

object | null

The selected integration enables the system to receive and apply third-party charging limits to the chargers added in the circuit.

Responses

200Circuit updated successfully

401Access token is missing or invalid

403You do not have permission to perform the action

404The record is not found

422The payload you provided is invalid