Skip to content
Get started

Archive a task

tasks.delete(task_id) -> DeleteTaskResponse { archived }
DELETE/api/tasks/{taskId}

Archive a task so it stops appearing in GET /tasks results. Turns and files are retained for audit purposes. Only the worker creator can archive a task.

ParametersExpand Collapse
task_id: String
ReturnsExpand Collapse
class DeleteTaskResponse { archived }
archived: bool

Archive a task

require "handinger"

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

delete_task_response = handinger.tasks.delete("tsk_01HZY31W2SZJ8MJ2FQTR3M1K9D")

puts(delete_task_response)
{
  "archived": true
}
Returns Examples
{
  "archived": true
}