Sign in
Documents

Delete a document

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

post/documents.delete

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.

Example request

{
  "id": "hDYep1TPAM"
}

Response

OK

successboolean

Example response

{
  "success": true
}

Changes

Changed in 2 of the 6 revisions of this API.13

  • fdf2ec9c9df41See the full diff
    • ○

      added the non-success response with the status 429

      response-non-success-status-added

  • 7b33b538cd7d12See the full diff
    • ○

      added the optional property data to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property data to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property data to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property data to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property message to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 404 status

      response-optional-property-added