DocuSign Momentum 2018DocuSign Momentum 2018

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.

Request

HTTP request

GET /v2/accounts/{accountId}/bulk_envelopes

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Optional Query Parameters
countstring

The number of results to return. This can be 1 to 20.

includestring

Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include="failed,queued")

Valid values:

  • all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided.
  • failed - Entries with a failed status.
  • processing - Entries with a processing status.
  • queued - Entries with a queued status.
  • sent - Entries with a sent status.

start_positionstring

The position of the bulk envelope items in the response. This is used for repeated calls, when the number of bulk envelopes returned is too large for one return. The default value is 0.

Responses

CodeDescriptionReference
200

Successful response.

BulkEnvelopes
400

Error encountered.

errorDetails

SDK Method

BulkEnvelopes::list

Definitions

bulkEnvelope
bulkEnvelopeStatus
errorDetails
BulkEnvelopes

Examples

Generic JSON Response
Generic XML Response