DEdefaulr
Documents

Archive a document

Changed on

Archiving a document allows outdated information to be moved out of sight whilst retaining the ability to optionally search and restore it later.

post/documents.archive

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/documents.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 required

Unique identifier for the document. Either the UUID or the urlId is acceptable.

reasonstring nullable

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

Example request

{
  "id": "hDYep1TPAM"
}

Response

OK

Example response

{
  "data": {
    "title": "Welcome to Acme Inc",
    "icon": "🎉",
    "text": "…",
    "urlId": "hDYep1TPAM",
    "createdBy": {
      "name": "Jane Doe"
    },
    "updatedBy": {
      "name": "Jane Doe"
    },
    "deletedBy": {
      "name": "Jane Doe"
    }
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes

  • 5ddf01ffba84Revision changes
    • info

      added the optional property / to the response with the status

    • info

      response property data/url deprecated

  • a75820943fbbRevision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status