Update schedule

updateSchedule(projectReference: String!, scheduleId: ID!, input: UpdateScheduleInput!): Schedule!

Requires project.runs.write.

Arguments

ArgumentTypeRequired
projectReferenceString!Yes
scheduleIdID!Yes
inputUpdateScheduleInput!Yes

Input fields

input

UpdateScheduleInput

FieldTypeRequired
nameStringNo
targetScheduleTargetInputNo
scheduleStringNo
timezoneStringNo
statusScheduleUpdateStatusNo
runtimeTargetKindRuntimeTargetKindNo
runtimeTargetEnvironmentIdIDNo
runtimeTargetBranchIdIDNo
configJSONNo
timeoutSecondsIntNo
backoffLimitIntNo
concurrencyPolicyScheduleConcurrencyPolicyNo
maxRunsIntNo

Response

Returns Schedule!. Open the type for its fields and nested types.

FieldTypeDescription
idID!
projectIdID!
nameString!
statusScheduleStatus!
targetScheduleTarget!
scheduleString!The cron expression.
timezoneString!
runtimeTargetKindRuntimeTargetKind!

All fields of Schedule.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation UpdateSchedule($projectReference: String!, $scheduleId: ID!, $input: UpdateScheduleInput!) {
  updateSchedule(projectReference: $projectReference, scheduleId: $scheduleId, input: $input) {
    id
    projectId
    name
    status
    createdAt
  }
}
json
{
  "projectReference": "example-project",
  "scheduleId": "00000000-0000-4000-8000-000000000001",
  "input": {
    "status": "paused"
  }
}