Simulations
Update a scheduler by reference
Update fields of an existing scheduler configuration by its reference.
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"
}
'import requests
url = "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules/{schedulerReference}"
payload = {
"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"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules/{schedulerReference}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules/{schedulerReference}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules/{schedulerReference}"
payload := strings.NewReader("{\n \"runConfig\": {\n \"flowReferenceId\": \"<string>\",\n \"localeReferenceId\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"largeLanguageModelReferenceId\": \"<string>\",\n \"userId\": \"<string>\",\n \"finalPing\": 123,\n \"data\": {},\n \"enableMocking\": true\n },\n \"enableSchedule\": true,\n \"time\": \"2023-11-07T05:31:56Z\",\n \"numberOfRuns\": 123,\n \"nextScheduledRun\": \"2023-11-07T05:31:56Z\",\n \"emailNotifications\": [\n \"<string>\"\n ],\n \"scenarioName\": \"<string>\",\n \"runName\": \"<string>\",\n \"simulationReference\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules/{schedulerReference}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"runConfig\": {\n \"flowReferenceId\": \"<string>\",\n \"localeReferenceId\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"largeLanguageModelReferenceId\": \"<string>\",\n \"userId\": \"<string>\",\n \"finalPing\": 123,\n \"data\": {},\n \"enableMocking\": true\n },\n \"enableSchedule\": true,\n \"time\": \"2023-11-07T05:31:56Z\",\n \"numberOfRuns\": 123,\n \"nextScheduledRun\": \"2023-11-07T05:31:56Z\",\n \"emailNotifications\": [\n \"<string>\"\n ],\n \"scenarioName\": \"<string>\",\n \"runName\": \"<string>\",\n \"simulationReference\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules/{schedulerReference}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"runConfig\": {\n \"flowReferenceId\": \"<string>\",\n \"localeReferenceId\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"largeLanguageModelReferenceId\": \"<string>\",\n \"userId\": \"<string>\",\n \"finalPing\": 123,\n \"data\": {},\n \"enableMocking\": true\n },\n \"enableSchedule\": true,\n \"time\": \"2023-11-07T05:31:56Z\",\n \"numberOfRuns\": 123,\n \"nextScheduledRun\": \"2023-11-07T05:31:56Z\",\n \"emailNotifications\": [\n \"<string>\"\n ],\n \"scenarioName\": \"<string>\",\n \"runName\": \"<string>\",\n \"simulationReference\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}{
"error": "<string>",
"field": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}Authorizations
bearerAuthapiKeyAuth
JWT Bearer Token for authentication
Path Parameters
Reference ID of the simulation (unused for update but part of path)
Reference ID of the scheduler to update
Query Parameters
Project identifier
Body
application/json
Any subset of fields to update
Show child attributes
Show child attributes
Available options:
daily, every three days, weekly, biweekly, monthly Response
Scheduler updated successfully
Show child attributes
Show child attributes
Last modified on July 2, 2026
Previous
Get simulation runs by simulationRetrieve all simulation runs for a specific simulation.
Next
⌘I
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"
}
'import requests
url = "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules/{schedulerReference}"
payload = {
"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"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules/{schedulerReference}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules/{schedulerReference}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules/{schedulerReference}"
payload := strings.NewReader("{\n \"runConfig\": {\n \"flowReferenceId\": \"<string>\",\n \"localeReferenceId\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"largeLanguageModelReferenceId\": \"<string>\",\n \"userId\": \"<string>\",\n \"finalPing\": 123,\n \"data\": {},\n \"enableMocking\": true\n },\n \"enableSchedule\": true,\n \"time\": \"2023-11-07T05:31:56Z\",\n \"numberOfRuns\": 123,\n \"nextScheduledRun\": \"2023-11-07T05:31:56Z\",\n \"emailNotifications\": [\n \"<string>\"\n ],\n \"scenarioName\": \"<string>\",\n \"runName\": \"<string>\",\n \"simulationReference\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules/{schedulerReference}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"runConfig\": {\n \"flowReferenceId\": \"<string>\",\n \"localeReferenceId\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"largeLanguageModelReferenceId\": \"<string>\",\n \"userId\": \"<string>\",\n \"finalPing\": 123,\n \"data\": {},\n \"enableMocking\": true\n },\n \"enableSchedule\": true,\n \"time\": \"2023-11-07T05:31:56Z\",\n \"numberOfRuns\": 123,\n \"nextScheduledRun\": \"2023-11-07T05:31:56Z\",\n \"emailNotifications\": [\n \"<string>\"\n ],\n \"scenarioName\": \"<string>\",\n \"runName\": \"<string>\",\n \"simulationReference\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/schedules/{schedulerReference}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"runConfig\": {\n \"flowReferenceId\": \"<string>\",\n \"localeReferenceId\": \"<string>\",\n \"entrypoint\": \"<string>\",\n \"largeLanguageModelReferenceId\": \"<string>\",\n \"userId\": \"<string>\",\n \"finalPing\": 123,\n \"data\": {},\n \"enableMocking\": true\n },\n \"enableSchedule\": true,\n \"time\": \"2023-11-07T05:31:56Z\",\n \"numberOfRuns\": 123,\n \"nextScheduledRun\": \"2023-11-07T05:31:56Z\",\n \"emailNotifications\": [\n \"<string>\"\n ],\n \"scenarioName\": \"<string>\",\n \"runName\": \"<string>\",\n \"simulationReference\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}{
"error": "<string>",
"field": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}