Delete schedule

deleteSchedule(projectReference: String!, scheduleId: ID!): ScheduleDeletionResult!

Requires project.runs.write; API keys also need delete scope.

Arguments

ArgumentTypeRequired
projectReferenceString!Yes
scheduleIdID!Yes

Response

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

FieldTypeDescription
okBoolean!Always true: the deletion was accepted. A failed deletion is a GraphQL error.

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

Example

graphql
mutation DeleteSchedule($projectReference: String!, $scheduleId: ID!) {
  deleteSchedule(projectReference: $projectReference, scheduleId: $scheduleId) {
    ok
  }
}
json
{
  "projectReference": "example",
  "scheduleId": "00000000-0000-4000-8000-000000000001"
}