Skip to main content
PATCH
Update a scheduler by reference

Authorizations

Authorization
string
header
required

JWT Bearer Token for authentication

Path Parameters

simulationReference
string
required

Reference ID of the simulation (unused for update but part of path)

schedulerReference
string
required

Reference ID of the scheduler to update

Query Parameters

projectId
string
required

Project identifier

Body

application/json

Any subset of fields to update

runConfig
object

Replaces the stored runConfig wholesale, so it must be complete.

enableSchedule
boolean
frequency
enum<string>
Available options:
daily,
every three days,
weekly,
biweekly,
monthly
time
string

Wall-clock 'HH:mm' in the project's current timezone, which the schedule then adopts. A UTC date-time is also accepted. Omit it to keep the trigger time unchanged.

numberOfRuns
integer
nextScheduledRun
string<date-time>
deprecated

Ignored. The next run is always computed by the server from the schedule.

emailNotifications
string[]
scenarioName
string
runName
string
simulationReference
string
endDate
string<date-time>

Response

Scheduler updated successfully

scheduler
object