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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
path.templateId | string | Required within parent | |
body | Model | Optional | Expand 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
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand 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
Schemas
Section titled “Schemas”Updates the scheduled sending rules for an envelope's workflow — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that specifies the scheduled sending settings for the envelope. |
bulkListId | string | Optional | The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation. |
resumeDate | string | Optional | The timestamp of when the envelope is scheduled to be sent in ISO 8601 format. This property is read-only. |
rules | array | Optional | User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified. |
rules[] | Model | Each item | Expand Updates the scheduled sending rules for an envelope's workflow — response body — rules item |
status | string | Optional | 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. |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
delay | string | Optional | A 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. |
resumeDate | string | Optional | An 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. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.