docusign.envelope-workflow-definition.put-template-delayed-routing-definition

Updates the scheduled sending rules for a template's workflow.

Updates the delayed routing rules for a template's workflow step.

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.
templateid	string	Yes	—	The ID of the template.
workflowstepid	string	Yes	—	The ID of the workflow step.
resumedate	string	No	—	The ISO 8601 timestamp of when the envelope is scheduled to be sent to the recipients associated with the workflow step. This property is null if the workflow step has not been initiated. This property is read-only.
rules	list	No	—	User-specified rules indicating how and when the envelope should sent for the workflow step and its associated recipients. Only one rule may be specified.
status	string	No	—	Status of the delayed routing step. Valid values: * pending: The workflow step has not been reached and the delay has not been initiated. * started: The workflow step has begun and the delay is in progress. The envelope has not yet been sent to the workflow step's recipients. * completed: The delay has elapsed and the envelope has been sent to the workflow step's recipients. 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.
templateid	string	Yes	—	The ID of the template.
workflowstepid	string	Yes	—	The ID of the workflow step.
resumedate	string	No	—	The ISO 8601 timestamp of when the envelope is scheduled to be sent to the recipients associated with the workflow step. This property is null if the workflow step has not been initiated. This property is read-only.
rules	list	No	—	User-specified rules indicating how and when the envelope should sent for the workflow step and its associated recipients. Only one rule may be specified.
status	string	No	—	Status of the delayed routing step. Valid values: * pending: The workflow step has not been reached and the delay has not been initiated. * started: The workflow step has begun and the delay is in progress. The envelope has not yet been sent to the workflow step's recipients. * completed: The delay has elapsed and the envelope has been sent to the workflow step's recipients. 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}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting
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}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting
* (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-template-delayed-routing-definition",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "templateid": "value",
    "workflowstepid": "value"
  }
}