documents

Deletes the specified document.

Changed on

Moves the specified document to the trash. The document is moved synchronously; child documents and related entities are moved asynchronously. Set alsoDeleteChildren to control whether child documents are included. <Check title="Required Permissions" icon="key">The user must have at least manage permission for the specified document.</Check>

delete/documents/{documentId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/documents/{documentId}
  • Auth: HTTP bearer

Path parameters

documentIdstring uuid required

The id of the document to delete.

Query parameters

alsoDeleteChildrenboolean

Whether to also delete children documents. If false, the children's parent references are updated to point to the deleted document's parent.

Response

No Content

object required

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id DeleteDocumentById removed and replaced with documents_DeleteDocumentById