Bulk Send
Applies a bulk action to all envelopes from a specified bulk send
Use this endpoint to resend, correct, or void all envelopes from a specified bulk send.
Authorization
OAuth2 AuthorizationBearer <token>
OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
accountId*string
The external account number (int) or account ID GUID.
bulkAction*string
The action to apply. Valid values:
resendcorrectvoid
bulkSendBatchId*string
The batch ID.
Request Body
application/json
action?string
The action to apply. Valid values:
ResendCorrectVoid
This property is required and case-sensitive. The value must correspond to the bulkAction query parameter.
notification?
A complex element that specifies the notification settings for the envelope.
voidReason?string
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 Body
application/json
application/json
curl -X PUT "https://example.com/v2.1/accounts/string/bulk_send_batch/string/string" \ -H "Content-Type: application/json" \ -d '{}'{ "action": "string", "actionStatus": "string", "batchId": "string", "batchName": "string", "batchSize": "string", "bulkErrors": [ { "created": "string", "envelopeId": "string", "errorMessage": "string", "recipientEmails": [ "string" ] } ], "envelopeIdOrTemplateId": "string", "envelopesInfo": { "authoritativeCopy": "string", "completed": "string", "correct": "string", "created": "string", "declined": "string", "deleted": "string", "delivered": "string", "digitalSignaturesPending": "string", "sent": "string", "signed": "string", "timedOut": "string", "transferCompleted": "string", "voided": "string" }, "envelopesUri": "string", "failed": "string", "mailingListId": "string", "mailingListName": "string", "ownerUserId": "string", "queued": "string", "resendsRemaining": "string", "senderUserId": "string", "sent": "string", "submittedDate": "string"}