Important: DocuSign is transitioning to a new REST API Reference Guide. This version will be retired soon, please refer to the new guide

Delete Recipients from an Envelope

This is used to delete one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the recipientId being used as the key for deleting recipients.

If the envelope is “In Process” (has been sent and is not completed or voided), recipients that have completed their actions cannot be deleted.

 

URL:

/accounts/{accountId}/envelopes/{envelopeId}/recipients

 

Formats:

XML, JSON

 

HTTP Method:

DELETE

 

Parameters:

The only required parameter is recipientId.

 

Example Request Body

 

Response

The response returns if the API execution is successful (200 – OK) or failed. The response contains a recipient structure similar to that input. If an error occurred during the DELETE operation for any of the recipients, that recipient will contain an error node with an errorCode and message.

The following example shows the response json body.

 

Example Response Body

 

 

Copyright © 2003-2016 DocuSign, Inc. All rights reserved. Various trademarks held by their respective owners.