Skip to content
Get started

Archive a task

tasks.delete(strtask_id) -> DeleteTaskResponse
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: str
ReturnsExpand Collapse
class DeleteTaskResponse:
archived: bool

Archive a task

import os
from handinger import Handinger

client = Handinger(
    api_key=os.environ.get("HANDINGER_API_KEY"),  # This is the default and can be omitted
)
delete_task_response = client.tasks.delete(
    "tsk_01HZY31W2SZJ8MJ2FQTR3M1K9D",
)
print(delete_task_response.archived)
{
  "archived": true
}
Returns Examples
{
  "archived": true
}