DocuSign Momentum 2018DocuSign Momentum 2018

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.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

envelopeIdstring

The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec

recipientIdstring

The recipientId used when the envelope or template was created.

Responses

CodeDescriptionReference
200

Successful response.

bulkRecipientsSummaryResponse
400

Error encountered.

errorDetails

SDK Method

BulkEnvelopes::updateRecipients

Definitions

bulkRecipient
bulkRecipientSignatureProvider
bulkRecipientsRequest
bulkRecipientsSummaryResponse
bulkRecipientTabLabel
errorDetails

Examples

Generic JSON Request/Response
Generic XML Request/Response