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

Add Recipients to an Envelope

This is used to add one or more recipients to an envelope.

Note: For “In Process” envelopes (one that has been sent and is not completed or voided), an email will be sent to a new recipient when they are reached in the routing order. If the new recipient’s routing order is before or the same as the envelope’s next recipient, an email is only sent if the optional “resend_envelope” query string is set to true.

 

URL:

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

Optional query string: resend_envelope={true or false}

Note that if automatic reminders are enabled for the envelope, then resending the envelope resets the automatic reminder date and the resend date is used for determining when to send reminder messages.

 

Formats:

XML, JSON

 

HTTP Method:

POST

 

Parameters:

The parameters used to add recipients are the same as those used in an envelope. See the Recipient Types and Parameters for more information.

 

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 POST 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.