Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Simulations

Update a scheduler by reference

Update fields of an existing scheduler configuration by its reference.

patch/simulations/{simulationReference}/schedules/{schedulerReference}

Path parameters

simulationReferencestring required

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

schedulerReferencestring required

Reference ID of the scheduler to update

Query parameters

projectIdstring required

Project identifier

Request body

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

Response

Scheduler updated successfully

Example response

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