Delete a draft document
Deletes a document that has never been sent and queues its stored objects for cleanup.
Drafts only. Once an envelope built from the document has been sent, the document is signing evidence, and a completed one is held for its retention window; both answer 409 with reason set to already_sent or completed rather than deleting anything.
Accepts an Idempotency-Key: a retry with the same key replays the original response. Without one, a retry after the delete has committed finds nothing left and answers 404, never a 500.
Request
- Base URL: https://inkseal.net/api/v1
- URL: https://inkseal.net/api/v1/documents/{documentId}
- Auth: HTTP bearer
Headers
Makes this mutation retry-safe. 1 to 255 printable ASCII characters (0x20 to 0x7e), trimmed before use. The key is scoped to the workspace and the credential that sent it. Reusing it with a different method, path, or payload answers 422 idempotency_key_reuse. A completed attempt replays its stored status and body with an Idempotent-Replay: true response header; 5xx, 429, and non-JSON answers leave the key retryable. A concurrent request holding the 90 second lease answers 409 idempotency_in_progress. Records are retained 24 hours.
Response
The document and its stored objects were deleted.
Example response
{
"data": {
"id": "V1StGXR8_Z5jdHi6B-myT",
"deleted": true
}
}Changes
No recorded changes to this operation across all 1 revision of this API.