Skip to content

DocuSign: Returns the delayed routing rules for a template's workflow step definition

DocuSign esignature.esignatureTemplateWorkflowDelayedRoutingGetTemplateDelayedRoutingDefinition: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_templateworkflowdelayedrouting_gettemplatedelayedroutingdefinition

Provider route: GET /restapi/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}/delayedRouting. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureTemplateWorkflowDelayedRoutingGetTemplateDelayedRoutingDefinition"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureTemplateWorkflowDelayedRoutingGetTemplateDelayedRoutingDefinition(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_template_workflow_delayed_routing_get_template_delayed_routing_definition(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.templateIdstringRequired within parent
path.workflowStepIdstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Updates the delayed routing rules for a template’s workflow step — response body

Referenced models: Updates the delayed routing rules for a template’s workflow step — response body

Updates the delayed routing rules for a template's workflow step — response body
FieldTypePresenceDescription and constraints
$objectRootA complex element that specifies the delayed routing settings for the workflow step.
resumeDatestringOptionalThe 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.
rulesarrayOptionalUser-specified rules indicating how and when the envelope should sent for the workflow step and its associated recipients. Only one rule may be specified.
rules[]ModelEach itemExpand Updates the scheduled sending rules for an envelope's workflow — response body — rules item
statusstringOptionalStatus 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.

Referenced models: Updates the scheduled sending rules for an envelope's workflow — response body — rules item

Updates the scheduled sending rules for an envelope's workflow — response body — rules item
FieldTypePresenceDescription and constraints
$objectRootA user-specified object that describes the envelope delay.

To indicate a relative delay, use `delay`. To indicate the exact datetime the envelope should be sent, use `resumeDate`. Only one of the two properties can be used.
delaystringOptionalA string timespan representing the duration of the sending delay. The timespan is in the format `d.hh:mm:ss` where `d` is the number of days, `hh` is the number of hours (measured on a 24-hour clock), `mm` is minutes, and `ss` is seconds. The maximum delay is 30 days.
resumeDatestringOptionalAn ISO 8601 formatted datetime string indicating the date and time that the envelope will be sent. The specified datetime must occur in the future. It must not exceed 30 days from the time that the request is made.

SDK function policy ID: docusign.esignature_templateworkflowdelayedrouting_gettemplatedelayedroutingdefinition. Catalog operation: esignature:TemplateWorkflowDelayedRouting_GetTemplateDelayedRoutingDefinition. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.