DocuSign Momentum 2018DocuSign Momentum 2018

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.

Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

batchIdstring

Optional Query Parameters
countstring

Specifies the number of entries to return.

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

Specifies the location in the list of envelopes from which to start.

Responses

CodeDescriptionReference
200

Successful response.

bulkEnvelopeStatus
400

Error encountered.

errorDetails

SDK Method

BulkEnvelopes::get

Definitions

bulkEnvelope
bulkEnvelopeStatus
errorDetails

Examples

Generic JSON Response
Generic XML Response