Skip to navigation

Post Processing Group TransferEnvelope

View as Markdown

The TransferEnvelope method effectively transfers all documents in the specified envelope to the new owner.

Schema

// Request the envelope specified to be transferred to the account specified
DocuSignWeb.TransferEnvelopeStatus status = _apiClient.TransferEnvelope("envelope ID",
"account ID as GUID", "user ID as GUID");
// Confirm that the transfer succeeded
Console.WriteLine("Transfer succeeded? {0}", status.TransferEnvelopeSuccess);

| Name | Schema Type | Description | | --- | --- | --- | | EnvelopeID | DSXId | This is the envelope ID of the envelope, as specified by the request. | | AccountID | DSXId | This specifies the account ID of the person to whom ownership is transferred. | | UserID | DSXId | The user ID of the person to whom the envelope ownership is being transferred. |

Sample Request XML

SOAPAction: "http://www.docusign.net/API/3.0/TransferEnvelope"
<?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>
<TransferEnvelope xmlns="http://www.docusign.net/API/3.0">
<EnvelopeID>string</EnvelopeID>
<AccountID>string</AccountID>
<UserID>string</UserID>
</TransferEnvelope>
</soap:Body>
</soap:Envelope>

TransferEnvelopeStatus

TransferEnvelopeStatus is the response method for TransferEnvelope.

Schema

NameSchema TypeDescription
TransferEnvelopeSuccessBooleanThis element is true if the transfer succeeded.