docusign.envelope-workflow-definition.put-envelope-scheduled-sending-definition

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

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

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
envelopeid	string	Yes	—	The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
bulklistid	string	No	—	The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation.
resumedate	string	No	—	The timestamp of when the envelope is scheduled to be sent in ISO 8601 format. This property is read-only.
rules	list	No	—	User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified.
status	string	No	—	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.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
envelopeid	string	Yes	—	The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
bulklistid	string	No	—	The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation.
resumedate	string	No	—	The timestamp of when the envelope is scheduled to be sent in ISO 8601 format. This property is read-only.
rules	list	No	—	User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified.
status	string	No	—	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.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/scheduledSending
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.envelope-workflow-definition.put-envelope-scheduled-sending-definition",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "envelopeid": "value"
  }
}