HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference
Terms of Use

Circuit / Schedule / Create or Update

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

Create or replace a circuit's schedule configuration

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

Schedule type for time-based current reduction:

  • daily: Same schedule periods apply every day
  • weekly: Different schedule periods can be configured for each day of the week
Allowed:
schedule
required

Schedule configuration for time-based current reduction. The structure depends on scheduleType:

  • When scheduleType is daily: An array of time periods that apply every day.
  • When scheduleType is weekly: An object with day-of-week keys (monday through sunday), each containing an array of time periods.
    Periods within a day must not overlap and cannot span midnight.
string
enum

Unit for interpreting schedule period maxCurrent values, and the upper bound that applies to each period:

  • amps: Per-phase amperes (A); must not exceed the circuit's maxCurrent.
  • kilowatts: Total kilowatts (kW); must not exceed the circuit's derived kW capacity computed from maxCurrent × phases × maxVoltage.
Allowed:
Responses

Updated 2 months ago

Language
Credentials
Bearer
API Token
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago