{"api":"esign_rest","category":"reference"}

EnvelopeBulkRecipients Resource

The EnvelopeBulkRecipients resource provide methods that allow you manage the bulk recipient file for an envelope.

The bulk recipient CSV (Comma Separated Value) file contains the list of recipient names and email addresses that you can add to an envelope to send the same document to a large number of recipients.

The required and optional information that can be included the file is described in the BulkEnvelopes::updateRecipients method

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

Gets the bulk recipient file from an envelope.

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

Adds or replaces envelope bulk recipients.

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

Deletes the bulk recipient file from an envelope.

}} />