The DeleteEnvelope operation is used to permanently delete one or more AssureSign envelopes.
Note that this method can only be called if the "Allow Users to Delete Documents?" setting is enabled.
This operation requires knowledge of the following:
- the AssureSign account ContextIdentifier the user belongs to (this is exposed in the AssureSign administrative application account settings). The ContextIdentifier is in the form of a global unique identifier (GUID).
- the EnvelopeID and AuthToken returned from an envelope creation call or the DocumentID and AuthToken returned from a document submission operation. Note that if an envelope contains more than one document, the EnvelopeID and corresponding AuthToken must be provided as opposed to the DocumentID and AuthToken.
<?xml version="1.0" encoding="utf-8"?> <DeleteEnvelope xmlns="https://www.assuresign.net/Services/DocumentNOW/Envelopes"> <Requests> <DeleteEnvelopeRequest ContextIdentifier="6c17c44a-458d-455b-b240-fc6dbb8cf1da" EnvelopeId="1099f007-e207-43ca-805a-841ae8fa972c" EnvelopeAuthToken="a4309be5-fd95-417f-a55b-83171a14d0a4" /> </Requests> </DeleteEnvelope>
The SOAP Action header is
Each DeleteEnvelopeResult should be checked for the presence of an Exceptions element, which may contain multiple EnvelopeException items.
Sample XML response is presented here:
<?xml version="1.0" encoding="utf-8"?> <DeleteEnvelopeResponse xmlns="https://www.assuresign.net/Services/DocumentNOW/Envelopes"> <DeleteEnvelopeResults> <DeleteEnvelopeResult EnvelopeId="1099f007-e207-43ca-805a-841ae8fa972c" /> </DeleteEnvelopeResults> </DeleteEnvelopeResponse>