Skip to main content
PATCH
/
simulations
/
{simulationReference}
/
schedules
/
{schedulerReference}
Update a scheduler by reference
curl --request PATCH \
  --url https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules/{schedulerReference} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "runConfig": {
    "flowReferenceId": "<string>",
    "localeReferenceId": "<string>",
    "entrypoint": "<string>",
    "largeLanguageModelReferenceId": "<string>",
    "userId": "<string>",
    "finalPing": 123,
    "data": {},
    "enableMocking": true
  },
  "enableSchedule": true,
  "time": "2023-11-07T05:31:56Z",
  "numberOfRuns": 123,
  "nextScheduledRun": "2023-11-07T05:31:56Z",
  "emailNotifications": [
    "<string>"
  ],
  "scenarioName": "<string>",
  "runName": "<string>",
  "simulationReference": "<string>",
  "endDate": "2023-11-07T05:31:56Z"
}
'
{
  "scheduler": {
    "id": "<string>",
    "simulationReference": "<string>",
    "projectReference": "<string>",
    "organisationReference": "<string>",
    "runConfig": {
      "flowReferenceId": "<string>",
      "localeReferenceId": "<string>",
      "entrypoint": "<string>",
      "largeLanguageModelReferenceId": "<string>",
      "userId": "<string>",
      "finalPing": 123,
      "data": {},
      "enableMocking": true
    },
    "enableSchedule": true,
    "time": "2023-11-07T05:31:56Z",
    "numberOfRuns": 123,
    "nextScheduledRun": "2023-11-07T05:31:56Z",
    "emailNotifications": [
      "<string>"
    ],
    "scenarioName": "<string>",
    "runName": "<string>",
    "endDate": "2023-11-07T05:31:56Z",
    "createdAt": 123,
    "lastChanged": 123,
    "createdBy": "<string>",
    "lastChangedBy": "<string>",
    "cronScheduler": "<string>",
    "timezone": "Europe/Berlin"
  }
}

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
enableSchedule
boolean
frequency
enum<string>
Available options:
daily,
every three days,
weekly,
biweekly,
monthly
time
string<date-time>
numberOfRuns
integer
nextScheduledRun
string<date-time>
emailNotifications
string[]
scenarioName
string
runName
string
simulationReference
string
endDate
string<date-time>

Response

Scheduler updated successfully

scheduler
object
Last modified on July 2, 2026