TemplateRecipients

Updates recipients in a template.

Updates recipients in a template.

You can edit the following properties: email, userName, routingOrder, faxNumber, deliveryMethod, accessCode, and requireIdLookup.

put/v2.1/accounts/{accountId}/templates/{templateId}/recipients

Request

  • Base URL
    https://www.docusign.net/restapi
  • URL
    https://www.docusign.net/restapi/v2.1/accounts/{accountId}/templates/{templateId}/recipients
  • Auth
    none declared

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

templateIdstring required

The ID of the template.

Query parameters

resend_envelopestring

When true, resends the envelope to the recipients that you specify in the request body. Use this parameter to resend the envelope to a recipient who deleted the original email notification.

Note: Correcting an envelope is a different process. Docusign always resends an envelope when you correct it, regardless of the value that you enter here.

Request body

currentRoutingOrderstring

The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.

recipientCountstring

The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with:

  • recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.
  • includeDocuments - When true, the envelope time zone information is included in the message.

Response

Successful response.

Changes

No recorded changes to this operation across all 39 revisions of this API.