Skip to main content
POST
Apply a schedule to every location in a cluster

Authorizations

Authorization
string
header
required

OAuth 2.0 access token obtained via POST /oauth/token with client_credentials grant. Tenant and scopes are embedded in the JWT. No additional headers needed.

Path Parameters

clusterId
string
required

The cluster's unique identifier, returned when the cluster was created.

Body

application/json
startTime
string<date-time>
required

ISO-8601 UTC timestamp. Required.

Example:

"2026-06-12T08:00:00Z"

endTime
string<date-time>
required

ISO-8601 UTC timestamp. Must be after startTime and in the future. Required.

Example:

"2026-06-12T18:00:00Z"

limitKw
number<float>
required

Power limit in kW. Must be greater than 0. Required.

Example:

50

priority
integer
default:0

OCPP-stack-style priority level, 0 (lowest) to 10 (highest). Submitting a profile at a priority that already exists for this target replaces it.

Required range: 0 <= x <= 10
Example:

5

Response

Schedule applied to at least one location

clusterId
string
Example:

"clst_20260612_a1b2c3d4"

applied
object[]
errors
object[]
totalLocations
integer
Example:

2