v6

latestOpenAPI 3.0.0raw.githubusercontent.com2024-10-187525179.6 KB

Documents

Archive a document

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 body

idstring required

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

Example request

{
  "id": "hDYep1TPAM"
}

Response

Example response

{
  "data": {
    "title": "🎉 Welcome to Acme Inc",
    "emoji": "🎉",
    "text": "…",
    "urlId": "hDYep1TPAM",
    "collaborators": [
      {
        "name": "Jane Doe"
      }
    ],
    "createdBy": {
      "name": "Jane Doe"
    },
    "updatedBy": {
      "name": "Jane Doe"
    }
  }
}