curl --request DELETE \
--url https://app.vumasign.com/api/v1/envelopes/{envelopeId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.vumasign.com/api/v1/envelopes/{envelopeId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.vumasign.com/api/v1/envelopes/{envelopeId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.vumasign.com/api/v1/envelopes/{envelopeId}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}Discard a draft envelope. ⚠️ Drafts only, and it cannot be undone.
DELETES A DRAFT: an envelope created with "send": false (or saved as a draft in the dashboard) that has not been sent. Its recipients, its placed fields and the values filled in go with it. It is the same rule as the dashboard’s Discard button, and there is no list of discarded drafts to restore one from.
⚠️ ONLY A DRAFT. An envelope that has gone out is refused with envelope_not_draft and left exactly as it was. To withdraw a sent or partially_signed envelope, use POST /api/v1/envelopes/{envelopeId}/void, which keeps the envelope and its evidence and records why. A completed, declined, voided or expired envelope is finished and stays as it is.
Why a delete rather than a void: a draft has asked nobody to do anything, so there is nothing to withdraw and no history worth keeping. Voiding one would leave a permanent record of a document that was never sent.
204, with no body. The envelope is gone, so there is nothing true to return.
⚠️ A SECOND DELETE IS 404, NOT 204, as for webhooks. The act is idempotent — the end state is identical — so it takes no Idempotency-Key and a retry after a timeout is safe; but a 404 is the only answer that tells “I removed it” apart from “there was never one there”. If you retried after a timeout and got 404, the first attempt deleted it. Another organisation’s envelope, and an id that is not a uuid, are the same 404.
NO WEBHOOK FIRES: a draft produces no events, and neither does its deletion. A POST /api/v1/envelopes retried with the Idempotency-Key that created the draft makes a new draft after this, rather than replaying the deleted one.
⚠️ A vsk_test_ KEY MAY DISCARD ONLY A DRAFT A TEST KEY CREATED. Any envelope made in the dashboard or with a live key, draft or not, is refused with test_key_cannot_discard before its status is considered.
curl --request DELETE \
--url https://app.vumasign.com/api/v1/envelopes/{envelopeId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.vumasign.com/api/v1/envelopes/{envelopeId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.vumasign.com/api/v1/envelopes/{envelopeId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.vumasign.com/api/v1/envelopes/{envelopeId}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}{
"error": {
"code": "unauthenticated",
"message": "<string>"
}
}Authorizations
Authorization: Bearer vsk_live_…. Chosen over a bespoke X-API-KEY header because every client, proxy and log-redaction rule already knows this one. What a key may DO is its scopes — see x-scopes at the root of this document and x-required-scope on each operation. The scope list is not written here because OpenAPI reserves a requirement’s scope array for oauth2 and openIdConnect and requires it to be empty for an http scheme.
Path Parameters
Response
Deleted. No body: the draft is gone, so there is nothing true to describe.