Apply bulk action to all envelopes from bulk send

PUT

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

PUT

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

curl -X PUT https://demo.docusign.net/restapi/v2.1/accounts/ACCOUNT_ID/bulk_send_batch/BULK_SEND_BATCH_ID/BULK_ACTION \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "action": "sample string 1",
  "notification": {
    "expirations": {
      "expireAfter": "sample string 1",
      "expireEnabled": "sample string 2",
      "expireWarn": "sample string 3"
    },
    "reminders": {
      "maximumReminderCount": "sample string 1",
      "reminderDelay": "sample string 2",
      "reminderEnabled": "sample string 3",
      "reminderFrequency": "sample string 4",
      "smartReminderEnabled": "sample string 5"
    },
    "useAccountDefaults": "sample string 1"
  },
  "voidReason": "sample string 2"
}'

{
  "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"
}

Use this endpoint to resend, correct, or void all envelopes from a specified bulk send.

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.

bulkActionstringRequired

The action to apply. Valid values:

resend
correct
void

bulkSendBatchIdstringRequired

The batch ID.

Request

This endpoint expects an object: bulkSendBatchActionRequest

actionstringOptional

The action to apply. Valid values:

Resend
Correct
Void

This property is required and case-sensitive. The value must correspond to the bulkAction query parameter.

notificationobjectOptional

A complex element that specifies the notification settings for the envelope.

voidReasonstringOptional

A string explaining why the envelope is voided. This value is shown in a message to the recipients.

This property is required if action is Void.

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