Deletes the specified document.

DELETE

https://api.awork.com/api/v1/documents/:documentId

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.

Required Permissions

The user must have at least manage permission for the specified document.

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>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

documentIdstringRequiredformat: "uuid"

The id of the document to delete.

Query parameters

alsoDeleteChildrenbooleanOptionalDefaults to true

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

Errors

401

Unauthorized Error

404

Not Found Error