Skip to navigation

MoveEnvelopes

View as Markdown

MoveEnvelopes is used to move envelopes between folders.

Note: This can be used to delete envelopes by using “RecycleBin” as the FolderType. Placing an in process envelope (envelope status of sent or delivered) in the RecycleBin folder will void the envelope.

Schema

NameSchema TypeDescription
EnvelopeIdsArray of EnvelopesAn array of EnvelopeIds for the envelopes being moved.
AccountIdStringThe account ID associated with the envelopes.
FolderFromFolderTypeInfoThe folder where the envelopes are currently located. Refer to FolderTypeInfo for more information.
FolderToFolderTypeInforThe folder where the envelopes are being moved.

This method returns MoveEnvelopeResponse with the result of the request.

Sample Request XML

SOAPAction: "http://www.docusign.net/API/3.0/MoveEnvelopes"
<?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>
<MoveEnvelopes xmlns="http://www.docusign.net/API/3.0">
<Arg>
<EnvelopeIds>
<EnvelopeId>string</EnvelopeId>
<EnvelopeId>string</EnvelopeId>
</EnvelopeIds>
<AccountId>string</AccountId>
<FolderFrom>
<FolderType>RecycleBin or Draft or Inbox or SentItems or Normal</FolderType>
<FolderName>string</FolderName>
<FolderPath>string</FolderPath>
<FolderId>string</FolderId>
</FolderFrom>
<FolderTo>
<FolderType>RecycleBin or Draft or Inbox or SentItems or Normal</FolderType>
<FolderName>string</FolderName>
<FolderPath>string</FolderPath>
<FolderId>string</FolderId>
</FolderTo>
</Arg>
</MoveEnvelopes>
</soap:Body>
</soap:Envelope>