Skip to main content
PUT
Update Group
Updates an existing load balancing group or subgroup. All fields are optional; only provided fields will be updated.
site
string
required
The UUID of the location.
siteGroup
integer
required
The ID of the group or subgroup.
total_amps
integer
The total available amperage for the group. Minimum value is 1.
net_type
string
The electrical network type. One of TN, TT, or IT.
method
string
The load balancing method. One of boost or solar.
meter_uuid
string
The UUID of a meter to attach to the group.
remove_meter
boolean
Set to true to remove the currently attached meter.
solar_additional_amps
integer
Additional amperage from solar. Minimum value is 0.
solar_always_charge
boolean
Whether to always allow charging when solar is available.
solar_always_charge_amps
integer
The minimum amperage to allocate when solar always charge is enabled. Minimum value is 0.
smart_charging_charge_on_solar_export
boolean
Whether to enable charging when solar export is detected.
peak_shaving_enabled
boolean
Whether peak shaving is enabled for this group.
peak_shaving_threshold
integer
The peak shaving threshold in amps. Minimum value is 0.

Response

Returns the updated group object.
id
integer
The numeric ID of the group.
site_id
integer
The numeric ID of the location this group belongs to.
group_id
integer
The ID of the parent group, or null if this is a root group.
meter_id
integer
The ID of the attached meter, or null.
total_amps
integer
The total available amperage for the group.
net_type
string
The electrical network type. One of TN, TT, or IT. May be null.
method
string
The load balancing method. One of boost or solar.
solar_additional_amps
integer
Additional amperage from solar.
solar_always_charge
boolean
Whether to always allow charging when solar is available.
solar_always_charge_amps
integer
Minimum amperage when solar always charge is enabled.
smart_charging_charge_on_solar_export
boolean
Whether to charge on solar export.
peak_shaving_enabled
boolean
Whether peak shaving is enabled for this group.
peak_shaving_threshold
integer
The peak shaving threshold in amps.
created_at
string
ISO 8601 timestamp of when the group was created.
updated_at
string
ISO 8601 timestamp of when the group was last updated.