Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeWorkflowDefinition

Updates the scheduled sending rules for an envelope's workflow.

Updates the scheduled sending rules for an envelope's workflow. The envelope must have an existing workflow object.

put/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending

Path parameters

accountIdstring required

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

envelopeIdstring required

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request body

bulkListIdstring

The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation.

resumeDatestring

The timestamp of when the envelope is scheduled to be sent in ISO 8601 format.

This property is read-only.

statusstring

Status of the scheduled sending job. Valid values:

  • pending: The envelope has not yet been sent and the scheduled sending delay has not been initiated.
  • started: The sender has initiated the sending process. The delay has not elapsed, so the envelope has not yet been sent to the first recipient.
  • completed: The delay has elapsed and the envelope has been sent to the first recipient.

This property is read-only.

Response

Successful response.