Skip to main content
POST
Create a scheduler for a simulation

Authorizations

Authorization
string
header
required

JWT Bearer Token for authentication

Path Parameters

simulationReference
string
required

Reference ID of the simulation

Query Parameters

projectId
string
required

Project identifier

Body

application/json

Note: timezone is server-derived from project settings.

projectReference
string
required

Project reference (required in body)

runConfig
object
required
frequency
enum<string>
required
Available options:
daily,
every three days,
weekly,
biweekly,
monthly
time
string<date-time>
required
runName
string
required
enableSchedule
boolean
numberOfRuns
integer
nextScheduledRun
string<date-time>
emailNotifications
string[]
scenarioName
string
endDate
string<date-time>

Response

Scheduler created successfully

scheduler
object
Last modified on July 2, 2026