v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeRecipients

Deletes a recipient from an envelope.

Deletes a recipient from a draft or sent envelope.

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

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

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

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.

Response

Successful response.