v1

latestSwagger 2.02026-07-134146194.6 MB
BulkSend

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.

put/v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId}/{bulkAction}

Path parameters

accountIdstring required

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

bulkActionstring required

The action to apply. Valid values:

  • resend
  • correct
  • void
bulkSendBatchIdstring required

The batch ID.

Request body

actionstring

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.

voidReasonstring

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.