DEdefaulr
Documents

Restore a document

Changed on

If a document has been archived or deleted, it can be restored. Optionally a revision can be passed to restore the document to a previous point in time.

post/documents.restore

Request

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

collectionIdstring uuid

Identifier for the collection to restore the document to.

revisionIdstring uuid

Identifier for the revision to restore to.

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 optional property / to the response with the status