docusign.bulk-send.put-bulk-send-batch-action

Use this endpoint to resend, correct, or void all envelopes from a specified bulk send.

Applies a bulk action to all envelopes from a specified bulk send.

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.
bulkaction	string	Yes	—	The action to apply. Valid values: * resend * correct * void
bulksendbatchid	string	Yes	—	The batch ID.
action	string	No	—	The action to apply. Valid values: * Resend * Correct * Void This property is required and case-sensitive. The value must correspond to the bulkAction query parameter.
notification	json	No	—	A complex element that specifies the notification settings for the envelope.
voidreason	string	No	—	A string explaining why the envelope is voided. This value is shown in a message to the recipients. This property is required if action is Void.

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.
bulkaction	string	Yes	—	The action to apply. Valid values: * resend * correct * void
bulksendbatchid	string	Yes	—	The batch ID.
action	string	No	—	The action to apply. Valid values: * Resend * Correct * Void This property is required and case-sensitive. The value must correspond to the bulkAction query parameter.
notification	json	No	—	A complex element that specifies the notification settings for the envelope.
voidreason	string	No	—	A string explaining why the envelope is voided. This value is shown in a message to the recipients. This property is required if action is Void.
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 PUT /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/
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 PUT /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/
* (any state)	fail	failed	Record the failure reason

API Usage

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

{
  "workflow_type": "docusign.bulk-send.put-bulk-send-batch-action",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "bulkaction": "value",
    "bulksendbatchid": "value"
  }
}