DEdefaulr
Collections

Archive a collection

Changed on

Archiving a collection hides it, and all of the documents within it, from the sidebar and search results. Archived collections can be restored at a later date.

post/collections.archive

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/collections.archive
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

idstring uuid required

Unique identifier for the collection.

reasonstring nullable

An optional reason for archiving the collection. This is stored and returned as deprecatedReason.

Response

OK

Example response

{
  "data": {
    "urlId": "hDYep1TPAM",
    "name": "Human Resources",
    "index": "P",
    "color": "#123123",
    "archivedBy": {
      "name": "Jane Doe"
    }
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes

  • c09b7940e788Revision changes
    • info

      added the optional property / to the response with the status

  • a75820943fbbRevision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status