BulkSendService

global with sharing class BulkSendService

Description

Operations related to sending DocuSign envelopes in bulk. Bulk send lists may be created, updated, and deleted. These may be reused with multiple draft envelopes. Only one SIGNER recipient per envelope copy is currently supported.

To use automatic anchor tags for the bulk envelope recipient, set the placeholder recipient role to dfsle.RecipientService.getDefaultRoles()[0], assuming it exists.

A typical flow is as follows:

\n // Construct bulk list from a group\n dfsle.BulkList myList = new dfsle.BulkList(\n  null, // Salesforce list ID. Assigned upon creation.\n  null, // DocuSign list ID. Assigned upon creation.\n  new List<dfsle.Envelope> { ... }, // Envelope copies.\n  new dfsle.Entity(mySalesforceGroupId));\n // Create the bulk send list.\n myList = dfsle.BulkSendService.createLists(new List<BulkList> { myBulkList })[0];\n // Create a draft envelope with at least one dummy recipient.\n dfsle.Envelope myEnvelope = dfsle.BulkSendService.getDraftEnvelope(\n   new List<dfsle.Document> { ... }, // Documents\n   new dfsle.Entity(mySalesforceSourceId)); // Salesforce source entity\n // Send the envelope to your bulk send list.\n dfsle.BulkList.Result myResult = dfsle.BulkSendService.sendEnvelope(myList.id, myEnvelope);\n // Check for and resolve any errors in the result.\n if (myResult.success) {\n   // Get batch job status (will only call DocuSign API at most once per minute)\n   dfsle.BulkList.Status myStatus = dfsle.BulkSendService.getStatus(new Set<Id> { myResult.bulkStatusId });\n }\n

Methods

createLists

global static List<BulkList> createLists(final List<BulkList> bulkLists)

Description

Creates one or more bulk send lists in Salesforce and DocuSign. The lists must have at least one member. Each list may be reused to send multiple envelopes. Currently bulk envelope copies are restricted to exactly one recipient each.

Callers must be assigned the DocuSign User permission set.

Returns

The newly-created bulk send lists.

Parameters

bulkLists

final List<BulkList> bulkLists

The bulk send lists to create.

deleteLists

global static Boolean deleteLists(final Set<Id> bulkListIds)

Description

Deletes one or more bulk send lists in Salesforce and DocuSign.

Callers must be assigned the DocuSign User permission set.

Returns

The result of the delete operation: true if the lists were deleted, and false otherwise.

Parameters

bulkListIds

final Set<Id> bulkListIds

The IDs of the lists to delete.

getDraftEnvelope

global static Envelope getDraftEnvelope(final List<Document> documents, final Entity source)

Description

Gets a new bulk draft envelope instance with a single bulk recipient placeholder and default email and notification settings. This may be further customized via the dfsle.Envelope.withEmail or dfsle.Envelope.withNotifications methods.

Callers must be assigned the DocuSign User permission set.

Returns

A new bulk envelope instance.

Parameters

documents

final List<Document> documents

List of envelope documents. At least one document is required.

source

final Entity source

Optional Salesforce source object for the envelope.

getStatus

global static List<BulkList.Status> getStatus(final Set<Id> bulkStatusIds)

Description

Retrieves status for one or more bulk send jobs.

Callers must be assigned the DocuSign User permission set.

Returns

A list of bulk send job statuses.

Parameters

bulkStatusIds

final Set<Id> bulkStatusIds

The list of status IDs.

searchLists

global static List<BulkList> searchLists(final String name, final Integer maximumRecords)

Description

Searches for bulk send lists partially matching a name.

Callers must be assigned the DocuSign User permission set.

Returns

Bulk send lists matching the search criteria.

Parameters

name

final String name

The beginning part of the name to match.

maximumRecords

final Integer maximumRecords

The maximum number of records to retrieve.

sendEnvelope

global static BulkList.Result sendEnvelope(final Id bulkListId, final Envelope envelope)

Description

Sends an envelope to a bulk send list. The envelope will be created in DocuSign and Salesforce.

If previously created, the caller must be the owner of the envelope. Otherwise the caller must be assigned the DocuSign User permission set.

Returns

The result of the bulk send operation.

Parameters

bulkListId

final Id bulkListId

The bulk send list Salesforce ID.

envelope

final Envelope envelope

The draft envelope.

updateLists

global static List<BulkList> updateLists(final List<BulkList> bulkLists)

Description

Updates one or more bulk send lists in Salesforce and DocuSign. Currently bulk envelope copies are restricted to exactly one recipient each.

This method should be called any time the source Salesforce group membership changes to ensure the lists are synchronized.

Callers must be assigned the DocuSign User permission set.

Returns

The updated bulk send lists.

Parameters

bulkLists

final List<BulkList> bulkLists

The bulk send lists to update.

"}},"metadata":{"title":{"data":"bulksendservice Apex Toolkit"},"routes":{"items":[{"data":"/docs/salesforce/apex-toolkit-reference/bulksendservice.html"}]},"slug":{"data":"-docs-salesforce-apex-toolkit-reference-bulksendservice.html"}}}},"staticQueryHashes":["1243170842","791459392"]}

DocuSign Apex Toolkit

BulkSendService

Methods