TemplateRecipients

Deletes recipients from a template.

Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the recipientId being used as the key for deleting recipients.

delete/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.

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.