Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Simulations

Create a scheduler for a simulation

Create a scheduler associated with a scenario to run simulations automatically.

post/simulations/{simulationReference}/schedules

Path parameters

simulationReferencestring required

Reference ID of the simulation

Query parameters

projectIdstring required

Project identifier

Request body

projectReferencestring required

Project reference (required in body)

enableScheduleboolean
frequency'daily' | 'every three days' | 'weekly' | 'biweekly' | 'monthly' required
timestring date-time required
numberOfRunsinteger
nextScheduledRunstring date-time
emailNotificationsstring[]
scenarioNamestring
runNamestring required
endDatestring date-time

Response

Scheduler created successfully

Example response

{
  "scheduler": {
    "timezone": "Europe/Berlin"
  }
}