Skip to content
Get started

Cancel a worker schedule

$ handinger workers:schedules cancel
DELETE/api/workers/{workerId}/schedules/{scheduleId}

Cancel a scheduled task for a worker.

ParametersExpand Collapse
--worker-id: string

Worker id returned by the create worker endpoint.

--schedule-id: string

Scheduled task id returned by the create schedule endpoint.

ReturnsExpand Collapse
WorkerScheduleCancelResponse: object { cancelled }
cancelled: boolean

Cancel a worker schedule

handinger workers:schedules cancel \
  --api-key 'My API Key' \
  --worker-id t_org_123_w_01HZY2ZJQ8G7K42W2D7WF6V4GM \
  --schedule-id sch_01HZY31W2SZJ8MJ2FQTR3M1K9D
{
  "cancelled": true
}
Returns Examples
{
  "cancelled": true
}