docusign.envelope-recipients.delete-recipients

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.

Deletes recipients from an envelope.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
envelopeid	string	Yes	—	The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
agents	list	No	—	A list of agent recipients assigned to the documents.
authorizedsignatories	list	No	—	—
carboncopies	list	No	—	A list of carbon copy recipients assigned to the documents.
certifieddeliveries	list	No	—	A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.
currentroutingorder	string	No	—	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.
editors	list	No	—	A list of users who can edit the envelope.
errordetails	json	No	—	This object describes errors that occur. It is only valid for responses and ignored in requests.
inpersonsigners	list	No	—	Specifies a signer that is in the same physical location as a Docusign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.
intermediaries	list	No	—	Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).
notaries	list	No	—	A list of notary recipients on the envelope.
notarywitnesses	list	No	—	—
participants	list	No	—	—
recipientcount	string	No	—	The number of recipients in the envelope.
seals	list	No	—	A list of electronic seals to apply to documents.
signers	list	No	—	A list of signers on the envelope.
witnesses	list	No	—	A list of signers who act as witnesses on the envelope.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
envelopeid	string	Yes	—	The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
agents	list	No	—	A list of agent recipients assigned to the documents.
authorizedsignatories	list	No	—	—
carboncopies	list	No	—	A list of carbon copy recipients assigned to the documents.
certifieddeliveries	list	No	—	A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.
currentroutingorder	string	No	—	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.
editors	list	No	—	A list of users who can edit the envelope.
errordetails	json	No	—	This object describes errors that occur. It is only valid for responses and ignored in requests.
inpersonsigners	list	No	—	Specifies a signer that is in the same physical location as a Docusign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.
intermediaries	list	No	—	Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).
notaries	list	No	—	A list of notary recipients on the envelope.
notarywitnesses	list	No	—	—
participants	list	No	—	—
recipientcount	string	No	—	The number of recipients in the envelope.
seals	list	No	—	A list of electronic seals to apply to documents.
signers	list	No	—	A list of signers on the envelope.
witnesses	list	No	—	A list of signers who act as witnesses on the envelope.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.envelope-recipients.delete-recipients",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "envelopeid": "value"
  }
}