Skip to navigation
Docusign eSignature REST APIEnvelopesEnvelopeWorkflowDefinition

Update envelope scheduled sending rules

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

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.

envelopeIdstringRequired

The envelope’s GUID.

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

Request

This endpoint expects an object: scheduledSending

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

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

This property is read-only.

ruleslist of objectsOptional

User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified.

statusstringOptional

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.
bulkListIdstringOptional
The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation.
resumeDatestringOptional

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

This property is read-only.

ruleslist of objectsOptional

User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified.

statusstringOptional

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.

Errors

400
Bad Request Error