Void Envelope
Voids an envelope, canceling it permanently. A voided envelope cannot be sent, signed, or used again.
Overview
- Purpose: Cancel an envelope and prevent any further action on it.
- Use Cases: Correcting mistakes, canceling outdated requests, stopping incorrect envelopes.
- API Method: PUT /envelopes/void
[!CAUTION] Voiding is permanent and cannot be undone.
Required Input Fields
Envelope ID: The unique identifier of the envelope to void.
Voided Reason: Required explanation for why the envelope is being voided. This is visible to all recipients.
Voiding Restrictions
- Sent Envelopes: Can be voided if not yet completed.
- Completed Envelopes: Cannot be voided after all signatures are obtained.
- Draft Envelopes: Can be voided, though deletion might be more appropriate.
- Already Voided: Cannot void an envelope that’s already voided.
Output
- Envelope ID: The envelope’s unique identifier.
- Status: Updated to ‘voided’.
- Email Subject: Original email subject.
- Created DateTime: Original creation timestamp.
- Sent DateTime: Original sent timestamp (if applicable).
- Status Changed DateTime: Updated to current timestamp when voided.
Recipient Notification
- Email Notification: Recipients receive an email notification that the envelope was voided.
- Voided Reason: The reason you provide is included in the notification email.
- Access Revoked: Recipients can no longer access or sign the voided envelope.
- Audit Trail: Voiding is recorded in the envelope’s audit trail.
Tips
[!TIP] Provide clear, professional voided reasons as recipients will see them
[!TIP] Void envelopes promptly if you discover errors to prevent confusion
[!CAUTION] Cannot undo voiding - create a new envelope if needed
[!TIP] Use descriptive reasons like ‘Incorrect recipient’ or ‘Updated document available’
[!TIP] Voiding does not delete the envelope - it remains in the account as voided
[!TIP] Consider voiding vs. deleting draft envelopes based on audit requirements