Lists and items
Set list archived
SetListArchived puts a List out of the sidebar, or brings it back. Only its owner may: archiving a shared List takes it out of everybody's sidebar. Archiving is not deleting — what is archived keeps its Items and can be restored.
Path Parameters
listUid*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/v1/lists/string/archived" \ -H "Content-Type: application/json" \ -d '{}'{ "list": { "uid": "string", "name": "string", "sharing": "SHARING_UNSPECIFIED", "canEdit": true, "isOwner": true, "isPinned": true, "openCount": 0, "doneCount": 0, "createdAt": "string", "updatedAt": "string", "archivedAt": "string", "archivedByName": "string" }}