This endpoint allows users to apply specific actions (resend, correct, or void) to all envelopes within a specified DocuSign bulk send batch. It's designed for managing large-scale document signing processes efficiently, enabling users to update the status or take action on mult…
actionstringThe action to apply in the request body. Valid values: `Resend`, `Correct`, `Void` (capitalized). This should match the `bulkAction` path parameter but with capitalization. Optional - if not provided, the action is inferred from the path parameter.
accountIdstringThe external account number (int) or account ID GUID. This parameter is required and identifies the DocuSign account associated with the bulk send batch. It must be a valid string representing either an integer account number or a GUID.
bulkActionRequiredstringThe action to apply to the bulk send batch. This parameter is required and must be one of: "resend" (resend failed/undelivered envelopes), "correct" (make corrections to envelopes), or "void" (cancel and void all envelopes). Use lowercase values. The action will be applied to al…
voidReasonstringReason for voiding the envelope. This message is shown to recipients. Required when `bulkAction` is "void" or `action` is "Void". Example: "Document no longer needed due to updated requirements."
bulkSendBatchIdRequiredstringThe unique identifier for the bulk send batch. This parameter is required and must be a valid string representing the specific batch ID to which the action will be applied. This ID is typically obtained when creating or retrieving information about a bulk send batch.
notification__useAccountDefaultsbooleanWhether to use account default notification settings. When true, ignores reminder and expiration settings in this request and uses account defaults. When false, uses the settings specified in this request. Default: false.
notification__expirations__expireWarnintegerNumber of days before expiration to send a warning email to recipients. Set to 0 to disable warning emails. Example: 7 (warn 7 days before expiration).
notification__expirations__expireAfterintegerNumber of days the envelope is active before expiring. Only applies when `expireEnabled` is set to true. Example: 120 (envelope expires in 120 days).
notification__reminders__reminderDelayintegerNumber of days after envelope is sent before the first reminder is sent. Example: 3 (send first reminder 3 days after envelope is sent). Default: 0.
notification__expirations__expireEnabledbooleanWhether envelope expiration is enabled. When true, the envelope expires after the number of days specified in `expireAfter`. When false or not set, uses account default expiration settings.
notification__reminders__reminderEnabledbooleanWhether reminders are enabled. When true, reminder emails are sent to recipients based on the delay and frequency settings. Default: false.
notification__reminders__reminderFrequencyintegerInterval in days between reminder emails after the initial reminder. Example: 5 (send reminder every 5 days). Default: 0 (no recurring reminders).
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.