Recipients
Delete a recipient
Deletes a recipient from an envelope. This endpoint can be used on both draft and sent envelopes. When used on a draft envelope, the recipient is simply removed prior to sending.
When used on a sent envelope, the recipient is removed from the signing workflow. Any outstanding access for that recipient will be revoked.
If the removed recipient is the final remaining incomplete recipient, and all other recipients have already completed their actions, the envelope will automatically complete.
An envelope must always have at least one recipient. Requests to delete the only remaining recipient will be rejected.
Use this endpoint to dynamically manage recipients — for example, removing incorrect recipients or adjusting workflows after an envelope has been sent.
Note: Deleting a recipient in a recalled envelope is not supported via the API. This must be done through the dashboard.
Parameters
The unique identifier of the recipient to delete.