Get status of bulk send batch

GET

/v2.1/accounts/:accountId/bulk_send_batch/:bulkSendBatchId

GET

/restapi/v2.1/accounts/:accountId/bulk_send_batch/:bulkSendBatchId

curl https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/bulk_send_batch/BULK_SEND_BATCH_ID \
     -H "Authorization: Bearer <apiKey>"

{
  "action": "sample string 1",
  "actionStatus": "sample string 2",
  "batchId": "sample string 3",
  "batchName": "sample string 4",
  "batchSize": "sample string 5",
  "bulkErrors": [
    {
      "created": "sample string 1",
      "envelopeId": "sample string 2",
      "errorMessage": "sample string 3",
      "recipientEmails": [
        "sample string 1"
      ]
    }
  ],
  "envelopeIdOrTemplateId": "sample string 6",
  "envelopesInfo": {
    "authoritativeCopy": "sample string 1",
    "completed": "sample string 2",
    "correct": "sample string 3",
    "created": "sample string 4",
    "declined": "sample string 5",
    "deleted": "sample string 6",
    "delivered": "sample string 7",
    "digitalSignaturesPending": "sample string 8",
    "sent": "sample string 9",
    "signed": "sample string 10",
    "timedOut": "sample string 11",
    "transferCompleted": "sample string 12",
    "voided": "sample string 13"
  },
  "envelopesUri": "sample string 7",
  "failed": "sample string 8",
  "mailingListId": "sample string 9",
  "mailingListName": "sample string 10",
  "ownerUserId": "sample string 11",
  "queued": "sample string 12",
  "resendsRemaining": "sample string 13",
  "senderUserId": "sample string 14",
  "sent": "sample string 15",
  "submittedDate": "sample string 16"
}

Gets the general status of a specific bulk send batch such as:

number of successes
number pending
number of errors

The bulkErrors property of the response object contains more information about the errors.

How to bulk send envelopes

Authentication

AuthorizationBearer

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token> on every request except GET /v2.1 and GET /service_information, which are public discovery endpoints.

Path parameters

accountIdstringRequired

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

bulkSendBatchIdstringRequired

The batch ID.

Response

Successful response.

actionstringOptional

actionStatusstringOptional

batchIdstringOptional

The batch ID.

batchNamestringOptional

The batch name.

batchSizestringOptional

The number of of bulk envelopes submitted in the current batch

bulkErrorslist of objectsOptional

An array of error statuses.

envelopeIdOrTemplateIdstringOptional

The ID of the draft envelope or template that was used to create the batch.

envelopesInfoobjectOptional

envelopesUristringOptional

The URI to get all envelopes sent in the batch.

failedstringOptional

The number of envelopes that failed to process or send.

mailingListIdstringOptional

The ID of the mailing list used to create the batch.

mailingListNamestringOptional

ownerUserIdstringOptional

queuedstringOptional

The number of envelopes waiting in pending queue

resendsRemainingstringOptional

senderUserIdstringOptional

The ID of the sender.

sentstringOptional

The number of envelopes sent successfully.

submittedDatestringOptional

The timestamp of when the batch was submitted in ISO 8601 format.

Errors

400

Bad Request Error

Related topics

Authentication

Path parameters

Response

Errors