Void a DocuSign envelope
POST/esignature/docusign/:documentId/envelopes/:envelopeId/void
Cancels an in-progress DocuSign envelope; available as an Add-On Module. Requires write access to the selected document or artifact and a matching stored envelope ID. Calls DocuSign's envelope update API, PUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}, with status set to voided and the supplied voidedReason. DocuSign notifies recipients that the envelope was voided, including the supplied reason. Only sent or delivered envelopes can be voided. If the envelope is already voided, returns its current state without another update or changing its original reason. Voiding cannot be undone. The existing envelope-voided callback updates the stored FormKiQ status. After a timeout, the outcome is unknown; check the existing GET envelope status endpoint before attempting the operation again.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 502
- 504
DocuSign envelope voided successfully
Response Headers
Invalid parameters, missing, blank, or overlong voidedReason, missing DocuSign configuration, or an envelope that is not eligible to be voided.
Authentication required
Write access to the selected document or artifact is denied
Document, artifact, or associated DocuSign envelope not found
DocuSign rate limit exceeded
DocuSign authentication failure, upstream error, or invalid response
DocuSign request timed out; the void operation outcome is unknown