Create Bulk Send Request
AutomatR.DocuSign.Activities.CreateBulkSendRequest
The "Create Bulk Send Request" activity in AutomatR is part of the DocuSign activities package, designed to create a new BulkSendRequest for initiating bulk document sending in DocuSign. This activity streamlines the process of sending bulk envelopes using specified templates or envelope IDs, enhancing the efficiency of automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Bulk Send List ID | The bulk send list ID. This property is created after you post a new bulk send list. String variables containing the bulk send list ID. |
| Envelope Or TemplateID | The envelope or template ID to use for the bulk send. String variables containing the envelope or template ID. |
| Batch Name | The batch name for the bulk send. String variables containing the batch name. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Create Bulk Send Request" activity. This can be useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Response | Returns the bulk send response with data type BulkSendResponse. |
Validation:
- The
Envelope Or TemplateIDproperty is required. If not provided, a validation error will occur.
How to use:
- Drag and drop the "Create Bulk Send Request" activity onto the workflow.
- Configure the properties by specifying the bulk send list ID, envelope or template ID, and batch name.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to create a new bulk send request in DocuSign, initiating the bulk send process.
Example: Consider an example where the "Create Bulk Send Request" activity is used to create a bulk send request for a bulk send list with ID "1234-5678-ABCD-EFGH" using a template with ID "9876-5432-WXYZ" and batch name "ContractBatch":
Create Bulk Send Request:
Display Name: "Create Contract Bulk Send Request"
Bulk Send List ID: "1234-5678-ABCD-EFGH"
Envelope Or TemplateID: "9876-5432-WXYZ"
Batch Name: "ContractBatch"
Response: bulkSendResponse
In this example, the activity creates a bulk send request for the specified bulk send list using the provided template ID and batch name. The response from the activity, including the bulk send response, is stored for further handling in the workflow.