v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeRecipients

Deletes recipients from an envelope.

Deletes one or more recipients from a draft or sent envelope. List the recipients that you want to delete in the body of the request. This method uses the recipientId as the key for deleting recipients.

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

delete/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients

Path parameters

accountIdstring required

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

envelopeIdstring required

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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 number of recipients in the envelope.

Response

Successful response.