Skip to content

DocuSign: Updates the scheduled sending rules for a template's workflow definition

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

← Esignature operations · Get started

Operation docusign.esignature_templateworkflowscheduledsending_puttemplatescheduledsendingdefinition

Provider route: PUT /restapi/v2.1/accounts/{accountId}/templates/{templateId}/workflow/scheduledSending. 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"]["esignatureTemplateWorkflowScheduledSendingPutTemplateScheduledSendingDefinition"]>[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.esignatureTemplateWorkflowScheduledSendingPutTemplateScheduledSendingDefinition(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_scheduled_sending_put_template_scheduled_sending_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
bodyModelOptionalExpand Updates the scheduled sending rules for an envelope’s workflow — response body

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

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 scheduled sending rules for an envelope’s workflow — response body

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

Updates the scheduled sending rules for an envelope's workflow — response body
FieldTypePresenceDescription and constraints
$objectRootA complex element that specifies the scheduled sending settings for the envelope.
bulkListIdstringOptionalThe ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation.
resumeDatestringOptionalThe timestamp of when the envelope is scheduled to be sent in ISO 8601 format.

This property is read-only.
rulesarrayOptionalUser-specified rules indicating how and when the envelope should be scheduled for sending. 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 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.

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_templateworkflowscheduledsending_puttemplatescheduledsendingdefinition. Catalog operation: esignature:TemplateWorkflowScheduledSending_PutTemplateScheduledSendingDefinition. 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.