Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
TemplateRecipients

Deletes the specified recipient file from a template.

Deletes the specified recipient file from the specified template.

delete/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}

Path parameters

accountIdstring required

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

recipientIdstring required

A local reference used to map recipients to other objects, such as specific document tabs.

A recipientId must be either an integer or a GUID, and the recipientId must be unique within an envelope.

For example, many envelopes assign the first recipient a recipientId of 1.

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.