docusign.bulk-send.get-bulk-send-batches

Returns a summary of bulk send batches. Use the batch_ids query parameter to narrow the list of batches. You must specify exactly one of the following query parameters to get back a list of batch summaries: | Parameter | Description | | :---------------- | :------------------------------------------------------------------------------- | | from_date | A valid UTC DateTime: 2016-01-01 | | batch_ids | A comma-separated list of batch IDs to query. | If neither query parameter is provided, a high-level, account-wide, overall bulk send status report is returned.

Returns a list of bulk send batch summaries.

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.
batch_ids	string	No	—	A comma-separated list of batch IDs to query.
count	string	No	—	The maximum number of results to return. Use start_position to specify the number of results to skip. Valid values: 1 to 100<br> Default: 100
from_date	string	No	—	The start date for a date range in UTC DateTime format.
search_text	string	No	—	Use this parameter to search for specific text.
start_position	string	No	—	The zero-based index of the result from which to start returning results. Use with count to limit the number of results. The default value is 0.
status	string	No	—	The kind of results to collect. Must be one of: - all - failed - sent - queued
to_date	string	No	—	The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. Note: If this property is null, the value defaults to the current date.
user_id	string	No	—	—

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.
batch_ids	string	No	—	A comma-separated list of batch IDs to query.
count	string	No	—	The maximum number of results to return. Use start_position to specify the number of results to skip. Valid values: 1 to 100<br> Default: 100
from_date	string	No	—	The start date for a date range in UTC DateTime format.
search_text	string	No	—	Use this parameter to search for specific text.
start_position	string	No	—	The zero-based index of the result from which to start returning results. Use with count to limit the number of results. The default value is 0.
status	string	No	—	The kind of results to collect. Must be one of: - all - failed - sent - queued
to_date	string	No	—	The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. Note: If this property is null, the value defaults to the current date.
user_id	string	No	—	—
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 GET /v2.1/accounts/{accountId}/bulk_send_batch
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 GET /v2.1/accounts/{accountId}/bulk_send_batch
* (any state)	fail	failed	Record the failure reason

API Usage

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

{
  "workflow_type": "docusign.bulk-send.get-bulk-send-batches",
  "initial_data": {
    "base_url": "value",
    "accountid": "value"
  }
}