archive_task
DestructiveIdempotent
Archive a task in Kanban Tool by task ID. Returns updated task with is_archived=True, idempotent for already-archived tasks.
Instructions
Archive a task. Returns the updated Task (caller can confirm
is_archived=True).
Idempotent: re-archiving an already-archived task succeeds. There is no
unarchive_task yet — archiving is currently one-way from this surface.
Failure modes: KanbanToolHTTPError(404) when the task id is unknown
(verify via get_task(task_id) first if you're unsure);
KanbanToolPermissionError(403) when the authenticated user lacks
write access to the task's board.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| task_id | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| name | Yes | ||
| description | No | ||
| board_id | No | ||
| workflow_stage_id | No | ||
| swimlane_id | No | ||
| position | No | ||
| priority | No | ||
| color | No | ||
| due_date | No | ||
| start_date | No | ||
| tags | No | ||
| assigned_user_id | No | ||
| archived_at | No | ||
| block_reason | No | ||
| subtasks_count | No | ||
| subtasks | No | ||
| comments_count | No | ||
| timers_total | No | ||
| time_trackers | No | ||
| created_at | No | ||
| updated_at | No | ||
| size_estimate | No | ||
| size_estimate_description | No | ||
| time_estimate | No | ||
| search_tags | No | ||
| card_color | No | ||
| card_color_in_rgb | No | ||
| card_color_invert | No | ||
| card_type_id | No | ||
| recurring_schedule | No | ||
| reminders_schedule | No | ||
| linked_tasks | No | ||
| linked_tasks_status | No | ||
| task_dependencies | No | ||
| collaborators | No | ||
| attachments | No | ||
| attachments_count | No | ||
| created_by_id | No | ||
| moved_at | No | ||
| postponed_until | No | ||
| subtasks_completed_count | No | ||
| external_id | No | ||
| external_link | No | ||
| custom_fields | No | ||
| is_archived | Yes | True iff the task has an archival timestamp. | |
| is_blocked | Yes | True iff the task has a non-empty block reason. |