# archiveListTree (https://developer.godaddy.com/en/docs/references/rest/catalog/list/mutations/archiveListTree)

***

title: archiveListTree
description: "Archive a list tree."
full: true
----------

mutation

Requires `commerce.product:write`.

Archive a list tree.

## Required headers

| Header       | Required | Description                                                                                                                     |
| ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `x-store-id` | Yes      | ID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: `extensions.code: "UNAUTHENTICATED"`. |

Go to [Authentication](https://developer.godaddy.com/docs/api-users/auth) for credential setup.

## Arguments

* `id` `String!` **required**

## Possible returns

* `ListTree` `ListTree` — A List tree holds the hierarchical information of a group of lists.

- `activatedAt` `DateTime` **nullable** — The timestamp of when the list tree was activated.
- `archivedAt` `DateTime` **nullable** — The timestamp of when the list tree was archived.
- `createdAt` `DateTime` **nullable** — The creation date of the list tree.
- `description` `String` **nullable** — The description of the list tree.
- `htmlDescription` `String` **nullable** — HTML description for the List Tree. Will be used to display rich text content to customers.
- `id` `ID` **nullable** — The globally-unique ID of the list tree.
- `label` `String` **nullable** — The display label of the list tree.
- `listTreeNodes` `ListTreeListTreeNodesConnection` **nullable** — List tree node is associated to a single List and a node can be a parent node to provide the hierarchy of list trees.
- `metafields` `ListTreeMetafieldsConnection` **nullable**
- `name` `String` **nullable** — A unique name of the list tree.
- `references` `ListTreeReferencesConnection` **nullable** — A reference to the resource in an external service. This can be useful for integrating the resource to any external service.
- `status` `String` **nullable** — The status of the list tree, one of `ACTIVE`, `ARCHIVED`, `DRAFT`.
- `updatedAt` `DateTime` **nullable** — The last update date of the list tree.
- `HTMLDescription` `String` **nullable** deprecated — HTML description for the List Tree. Will be used to display rich text content to customers. Deprecated: Use htmlDescription instead.
