Skip to navigation
Apex Toolkit reference

BulkList

View as Markdown
global class BulkList
Description
Docusign envelope bulk send list.

Exactly one bulk signer recipient per envelope is supported.

copies
@AuraEnabled global List<Envelope> copies
Copies of the Docusign envelope to be sent.
docuSignId
@AuraEnabled global UUID docuSignId
The Docusign bulk send list identifier.
id
@AuraEnabled global Id id
The bulk list identifier.
name
@AuraEnabled global String name
The name of the bulk send list.
source
@AuraEnabled global Entity source
The Salesforce source object from which the list was generated.
STATUS_QUEUED
global static final String STATUS_QUEUED
Constant for queued status.
'queued'
STATUS_PROCESSING
global static final String STATUS_PROCESSING
Constant for processing status.
'processing'
STATUS_SENT
global static final String STATUS_SENT
Constant for sent status.
'sent'
STATUS_FAILED
global static final String STATUS_FAILED
Constant for failed status.
'failed'

Methods

global static BulkList newList(final String name, final List<Envelope> copies, final Entity source)
Description
Creates a new bulk send list.
Returns
The new bulk send list.
Parameters
name
final String name
Required name of the bulk send list.
copies
final List<Envelope> copies
The bulk envelope copies. At least one is required.
source
final Entity source
Optional Salesforce source object for the list (e.g. CollaborationGroup.Id).

BulkList.Result

global class Result
Description
The result of testing or sending a bulk list.
bulkStatusId
@AuraEnabled global Id bulkStatusId
The ID of the bulk status record.
errors
@AuraEnabled global List<APIError> errors
A list of validation or sending errors.
success
@AuraEnabled global Boolean success
Read-only property indicating whether the batch job submission was successful.

BulkList.Status

global class Status
Description
The status of a bulk send batch job.
batchSize
@AuraEnabled global Integer batchSize
The size of the batch.
docuSignId
@AuraEnabled global UUID docuSignId
The Docusign batch job ID.
failedEnvelopes
@AuraEnabled global Integer failedEnvelopes
The number of envelopes that failed to send.
id
global Id id
The ID of the status.
isFinal
@AuraEnabled global Boolean isFinal
Whether or not the status is in a final state.
lastStatusUpdate
@AuraEnabled global Datetime lastStatusUpdate
Date and time when the status was last updated.
queuedEnvelopes
@AuraEnabled global Integer queuedEnvelopes
The number of envelopes remaining to be sent.
sentEnvelopes
@AuraEnabled global Integer sentEnvelopes
The number of envelopes sent successfully.
source
@AuraEnabled global Entity source
The Salesforce source object for the batch.
submitted
@AuraEnabled global Datetime submitted
Date and time when the job was submitted.