Delete a document body
DELETEhttps://
Permanently discards a document body, leaving the drive item itself in place and bodyless; a new one can be created for it with POST /api/v2/drive-documents.
Access
- Token scope
- api:
destroy: orapi:project_drive destroy: orapi:customer_drive destroy: orapi:organization_drive destroy: user_drive Without it:
403 insufficient-token-scope. - Permission
- project_drive::
create Without it:
403 insufficient-permission. - Rate cost
- 1 unit, write bucket.
- Also
- Accepts
If-Match. Never cached:private, no-store. Unknown query parameters are refused, never ignored.
Both are checked, scope first. A token never does more than its user. How access is checked
This resource is hard-delete: there is no restore action, no force parameter and no trashed parameter. Archiving a document is a different operation and belongs to the item: DELETE /api/v2/drive-items/{drive_item}, which is reversible. Deleting an already-deleted body answers 404. The todos derived from the body are removed afterwards. The declared permission is project_drive::create (the same permission as editing); the other three drive prefixes apply by the owning item's owner type, and the record rule is edit access on that item.
Path parameters
Request headers
A correlation id of your own. It is recorded in our logs next to the server's request id but never returned: the response header always carries the server's id. A value that does not match the pattern is discarded silently, never rejected.
Response 204
Returns no content.
Headers
RateLimit- The IETF
httpapi-ratelimit-headersform of your remaining allowance on the tightest bucket this request touched. RateLimit-Policy- The ceiling and window of that bucket, as
<limit>;w=<seconds>. X-Request-Id- The server-generated ULID correlating this response with our logs.
Every response also carries Cache-Control, Vary, X-Content-Type-Options, X-Plnnrly-Api-Version, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Headers and versioning
Errors
412 Precondition failed.
7 errors every operation can return: 400, 401, 404, 406, 429, 500, 503
400 Bad request.
idempotency-key-requiredinvalid-cursorinvalid-query-parametermalformed-requestunsupported-parameter
401 Unauthenticated.
404 Not found.
406 Not acceptable.
429 Too many requests.
500 Server error.
503 Service unavailable.
This path allows GET, PATCH, DELETE. Anything else answers 405.
Something wrong or missing on this page? Tell us