Update a saved schedule

Updates a saved schedule's configuration, recurrence, or activation status. {id} is
the run-configuration ID, not a scheduler ID.

This request is not a merge patch. Omitted configuration fields can be reset; include
the values that you want to retain. Include visualTestingConfiguration with a
configuration update. Omitting schedule leaves the recurrence unchanged. Send
schedule to replace the recurrence. If activeStatus is sent without schedule, it
updates scheduler status without changing recurrence. Omitting almAutoPushConfiguration
keeps its current value; null clears it; an object replaces it.

Requires the TestRun:Update permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Saved-schedule run-configuration ID.

Body Params
string
int64 | null
int64 | null
int64 | null
string | null
string
required
int64 | null
configurations
array of objects
configurations
visualTestingConfiguration
object | null
testSuiteRunConfigurations
array of objects
testSuiteRunConfigurations
adoConfiguration
object | null
schedule
object

Recurrence values for a saved schedule.

uuid | null
string | null
string | null
runConfigurationEntries
array of objects
runConfigurationEntries
boolean
privateLocalTestingConfiguration
object | null
boolean
int64 | null
customizableFields
array of objects
customizableFields
int64 | null
parallelConfiguration
object | null
string | null
int64 | null
string | null
string | null
emailReportConfiguration
object | null
almAutoPushConfiguration
object | null

For schedule updates, omission keeps the current value, null clears it, and an object
replaces it.

boolean | null
Headers
uuid

Account UUID. Optional; send it to select the account explicitly.

int64

Organization ID. Optional; send it to select the organization explicitly.

int64
required

Project ID. Required on every request; without it the request returns 400.

Responses
204

Schedule updated; no body.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Choose an example:
application/json