archive_task_list

archive_task_list

Archive a task list.

Archived lists no longer appear in list_task_lists or in the web sidebar, but their tasks remain accessible via the task tools. The authenticated user must be a member of the list.

Idempotent — archiving an already-archived list returns success.

Connected web clients receive a realtime tasklists refetch event so the list disappears from their sidebar.

Input

Field	Type	Required	Description
listId	number	yes	Numeric ID of the list to archive.

Example call

{
  "listId": 27
}

Output

A single text content block containing a JSON object describing the archived list.

Field	Type	Description
id	number	Numeric ID of the list.
name	string	Display name of the list.
color	string	Color tag of the list.
isArchived	boolean	Always true.

Example output

{
  "id": 27,
  "name": "Q3 launch",
  "color": "Blue",
  "isArchived": true
}

Errors

The tool returns isError: true with an explanatory text block when the list ID doesn’t exist or the authenticated user is not a member of the list.