Skip to content
Get started

Cancel a worker schedule

workers.schedules.cancel(schedule_id, **kwargs) -> ScheduleCancelResponse { cancelled }
DELETE/api/workers/{workerId}/schedules/{scheduleId}

Cancel a scheduled task for a worker.

ParametersExpand Collapse
worker_id: String
schedule_id: String
ReturnsExpand Collapse
class ScheduleCancelResponse { cancelled }
cancelled: bool

Cancel a worker schedule

require "handinger"

handinger = Handinger::Client.new(api_key: "My API Key")

response = handinger.workers.schedules.cancel(
  "sch_01HZY31W2SZJ8MJ2FQTR3M1K9D",
  worker_id: "t_org_123_w_01HZY2ZJQ8G7K42W2D7WF6V4GM"
)

puts(response)
{
  "cancelled": true
}
Returns Examples
{
  "cancelled": true
}