Status and Managing Group VoidEnvelope

This section describes the method available to void envelopes. Only incomplete envelopes can be voided. VoidEnvelope method is used to void an envelope.

// Create and send envelope as shown in linked code
DocuSignWeb.EnvelopeStatus status = <create and send envelope>;
// Void the envelope
DocuSignWeb.VoidEnvelopeStatus voidStatus = _apiClient.VoidEnvelope(status.EnvelopeID,
    "voiding reason");
// Confirm that the envelope was voided
Console.WriteLine("Voiding the envelope worked? {0}", voidStatus.VoidSuccess);

Schema

Sample Request XML

SOAPAction: "http://www.docusign.net/API/3.0/VoidEnvelope"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <VoidEnvelope xmlns="http://www.docusign.net/API/3.0">
      <EnvelopeID>string</EnvelopeID>
      <Reason>string</Reason>
    </VoidEnvelope>
  </soap:Body>
</soap:Envelope>

VoidEnvelopeStatus

VoidEnvelopeStatus is the response method for VoidEnvelopes.

Schema

Rules for VoidEnvelope

• The length of any of the EnvelopeID must not exceed 100 characters. Else, the XML validation fails and the processor throws a Validation error.
• The length of reason should not exceed 200 characters and should have a minimum of 1 character.
• EnvelopeID specified in the VoidEnvelope request should exist else an exception is thrown with error message “Envelope_Does_Not_Exist” .
• Only envelopes in the ‘Sent’ or ‘Delivered’ states may be voided. Else “Envelope_Cannot_Void_Invalid_State” exception will be thrown.
• Only the sender of envelope can void the envelope. If a user other than sender tries to void an envelope then exception “User_Not_Envelope_Sender” will be thrown.