DocuSign Momentum 2018DocuSign Momentum 2018
{"api":"esign_rest","category":"reference"}

BulkEnvelopes Category

Use the BulkEnvelopes category to manage the sending of envelopes to multiple recipients.

EnvelopeBulkRecipients

Envelope bulk recipients

MethodDescription
list
GET /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients

Retrieves the bulk recipient file information from an envelope that has a bulk recipient.

update
PUT /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients

Updates the bulk recipients in a draft envelope using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv).

The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.

delete
DELETE /v2/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients

Deletes the bulk recipient file from an envelope. This cannot be used if the envelope has been sent.

After using this, the bulkRecipientsUri property is not returned in subsequent GET calls for the envelope, but the recipient will remain as a bulk recipient.

BulkEnvelopes

Bulk envelopes

MethodDescription
list
GET /v2/accounts/{accountId}/bulk_envelopes

Retrieves status information about all the bulk recipient batches. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file. The response includes general information about each bulk recipient batch.

The response returns information about the envelopes sent with bulk recipient batches, including the batchId property, which can be used to retrieve a more detailed status of individual bulk recipient batches.

get
GET /v2/accounts/{accountId}/bulk_envelopes/{batchId}

Retrieves the status information of a single bulk recipient batch. A bulk recipient batch is the set of envelopes sent from a single bulk recipient file.