HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

Circuit / Update

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

Update a circuit

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
integer | null

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

string
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.

string
enum
Allowed:
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.

The field is mandatory for Multi-level DLM when the phases value is three_phase.

Allowed:
string
enum

Specifies the active line conductors used in the circuit.

Single phase values (phases = single_phase): L1, L2, L3 - Valid in star electrical configuration

Split phase values (phases = split_phase): L1_L2, L2_L3, L1_L3 - Valid in star electrical configuration

This field is mandatory for Multi-level DLM when the phases value is single_phase or split_phase.

Allowed:
string
enum
Defaults to star

Defines the type of electrical configuration of the circuit. A circuit must have the same electrical configuration as its parent circuit. To maintain safety and compatibility, only charge points with an identical electrical configuration to the circuit can be added. To modify a circuit's electrical configuration, all charge points with a different configuration must first be removed through Actions / Detach Charge Point. The available options are
star - Star/Wye (Y) (default)
delta - Delta (Δ)

Allowed:
string | null
enum
number

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

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.

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.

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.

boolean
deprecated

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

number | null

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

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

Updated 3 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?