DEdefaulr
Documents

Delete a document

Changed on

Deleting a document moves it to the trash. If not restored within 30 days it is permanently deleted.

post/documents.delete

Request

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

permanentboolean

If set to true the document will be destroyed with no way to recover rather than moved to the trash.

reasonstring nullable

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

Example request

{
  "id": "hDYep1TPAM"
}

Response

OK

successboolean

Example response

{
  "success": true
}

Changes