Skip to main content

I am trying to void an envelope using the DocuSign REST API. I used the API Explorer provided in the DocuSign Developer Portal.

Here is what I did:

✅ API endpoint:
PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}

✅ Request body I used (in API Explorer):

{ "status": "voided", "voidedReason": "No longer needed" }

✅ The response I get back:

{ "envelopeId": "e811fcff-e313-4234-a755-09d394729536" }

Notice — there is no "status": "voided" returned in the response.

✅ When I run GET /envelopes/{envelopeId} afterwards, the envelope still shows status "sent" (not "voided").
✅ I can still access the signing link and sign the envelope.

What I have tried:

  • Confirmed that I used the correct accountId and envelopeId

  • Using API Explorer, so OAuth and headers are handled

  • Provided valid voidedReason and "status": "voided" in body

  • Tried multiple times — same result

Question:

  • Why is my envelope not being voided even though I am calling the correct endpoint?

  • Is this an issue with API Explorer or something in my envelope state?

@vishnu 

You can only void envelopes that are in sent, delivered, or created status. If the envelope is already completed, declined, or voided, the status won’t change and the request is silently ignored (which is why you don’t see the status updated in the response).

Try the same PUT request using a tool like Postman.


Hi ​@vishnu 
The response of the update envelope call will only return the envelope ID and this is expected by design.
Regarding envelope ID e811fcff-xxxx-09d394729536, indeed it still shows as “Sent” and not as “Voided”. According to our logs, it seems an incorrect entries were typed in the API explorer while trying to Void.

When typing your details in the explorer text fields, make sure the final JSON request body (in the right below the URL) has.

 

{

  "voidedReason": "not needed",

  "status": "Voided"

}

 
 

As mentioned by John Santos, try to use tools like Postman.

 

Regards
Ivan D  


Reply