TemplateBulkRecipients Resource

The TemplateBulkRecipients resource provide methods that allow you manage the bulk recipient file for an template.

The bulk recipient CSV (Comma Separated Value) file contains the list of recipient names and email addresses that you can add to an template 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 BulkEnvelope: updateRecipients method

Methods

Method Description
delete DELETE /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients

Deletes the bulk recipient list on a template.

list GET /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients

Gets the bulk recipient file from a template.

update PUT /v2/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients

Adds or replaces the bulk recipients list in a template.