Services / API / Methods / rtm.lists.archive

Description

Archives a list.

Authentication

This method requires authentication with write permissions.

Timeline

This method requires a timeline.

Revertable

The effects of this method can be undone.

Arguments

api_key (Required)

Your API application key. See here for more details.

timeline (Required)

The timeline within which to run a method. See here for more details.

list_id (Required)

The id of the list to perform an action on.

Example Response

<list id="987654321" name="New List"
      deleted="0" locked="0" archived="1" position="0" smart="0"/>

Error Codes

98: Login failed / Invalid auth token

The login details or auth token passed were invalid.

100: Invalid API Key

The API key passed was not valid or has expired.

105: Service currently unavailable

The requested service is temporarily unavailable.

111: Format "xxx" not found

The requested response format was not found.

112: Method "xxx" not found

The requested method was not found.

114: Invalid SOAP envelope

The SOAP envelope sent in the request could not be parsed.

115: Invalid XML-RPC Method Call

The XML-RPC request document could not be parsed.

300: Timeline invalid or not provided

No timeline provided / Timeline invalid.

320: list_id invalid or not provided

No list_id provided / list_id invalid.