DeleteSchedule

Use the workflowAutomationDeleteSchedule mutation to delete the schedule of a workflow definition. This mutation doesn't stop any currently executing workflow run (use the StopWorkflowRun mutation).

Input parameters

Parameter	Data type	Description
`accountId`	Number	(Required) Your account ID.
`schedule.id`	String	(Required) The unique identifier of the schedule to delete. Obtained from `CreateSchedule` or `GetSchedules` APIs.

Sample request

Use the Query Builder to create and edit a workflow. See NerdGraph API explorer.

mutation {
  workflowAutomationDeleteSchedule(
    accountId: 12345678
    schedule: { id: "1a71d299-82c2-4b4d-9803-b14523e3a9e7" }
  ) {
    scheduleId
  }
}

Sample response

If the schedule.id is not found, the following structure is returned:

{
    "data": {
        "workflowAutomationDeleteSchedule": null
    },
    "errors": [{
        "message": "Could not find schedule with ID MTE2NDk5MDB8TkdFUHxXT1JLRkxPV19TQ0hFRFVMRXwwMTk5MGUzYi04NzAyLTc2M2QtOWUzMy01ZTU1ZThmZTYzYjkl",
        "path": ["workflowAutomationDeleteSchedule"]
    }]
}

Get schedules

Find the schedule ID before deleting

Stop workflow run

Stop running workflow instances triggered by this schedule

Delete workflow definition

Remove the workflow definition after deleting its schedules