Skip to content

DocuSign: Updates the workflow definition for a template

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

← Esignature operations · Get started

Operation docusign.esignature_templateworkflowdefinition_puttemplateworkflowdefinition

Provider route: PUT /restapi/v2.1/accounts/{accountId}/templates/{templateId}/workflow. 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"]["esignatureTemplateWorkflowDefinitionPutTemplateWorkflowDefinition"]>[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.esignatureTemplateWorkflowDefinitionPutTemplateWorkflowDefinition(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_definition_put_template_workflow_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 Returns the workflow definition for a template — response body

Referenced models: Returns the workflow definition for a template — 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 Returns the workflow definition for a template — response body

Referenced models: Returns the workflow definition for a template — response body

4 more schemas are linked from the tables above, on the schema pages.

Returns the workflow definition for a template — response body
FieldTypePresenceDescription and constraints
$objectRootDescribes the workflow for an envelope.
currentWorkflowStepIdstringOptionalThe `workflowStepId` of the current step.
This is not an index into the `workflowSteps` array in this object.
See the `workflowStep` object.
resumeDatestringOptionalThe ISO 8601 timestamp of when the envelope is scheduled to be sent, if applicable. Its value is the maximum of the `resumeDate` property on `scheduledSending` and the `resumeDate` property on the current `workflowStep`.

This property is read-only.
scheduledSendingModelOptionalExpand Updates the scheduled sending rules for an envelope's workflow — response body
An object that describes the settings for scheduled sending.
workflowStatusstringOptionalThe status of the workflow:

- `paused` if the workflow is paused
- `in_progress` if the workflow is in progress
workflowStepsarrayOptionalAn array of workflow steps.
workflowSteps[]ModelEach itemExpand Adds a new step to a template's workflow — response body

Referenced models: Updates the scheduled sending rules for an envelope's workflow — response body, Adds a new step to a template'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

Adds a new step to a template's workflow — response body
FieldTypePresenceDescription and constraints
$objectRootDescribes a single step in a workflow.
actionstringOptionalIndicates the action to perform. Valid values:

- `pause_before`: The workflow should pause before the trigger described by `triggerOnItem` is reached.
completedDatestringOptionalThe timestamp of when the workflow step transitioned to `completed` status.

This property is read-only.
delayedRoutingModelOptionalExpand Updates the delayed routing rules for a template's workflow step — response body
A complex element that specifies the delayed routing settings for the workflow step.
itemIdstringOptionalThe unique ID of the item being triggered.
recipientRoutingModelOptionalExpand Adds a new step to a template's workflow — response body — recipient Routing
The rules for recipient routing.
statusstringOptionalThe status of the step. Valid values:

- `inactive`
- `in_progress`
- `paused`
- `pending`
- `completed`

This property is read-only.
triggerOnItemstringOptionalThe type of item that triggers this workflow step. Valid values:

* `routing_order`
triggeredDatestringOptionalThe timestamp of when the workflow step transitioned to `in_progress` status.

This property is read-only.
workflowStepIdstringOptionalA unique identifier for this workflow step.

This property is read-only.

Referenced models: Updates the delayed routing rules for a template's workflow step — response body, Adds a new step to a template's workflow — response body — recipient Routing

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.
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

Adds a new step to a template's workflow — response body — recipient Routing
FieldTypePresenceDescription and constraints
$objectRootDescribes the recipient routing rules.
rulesModelOptionalExpand Adds a new step to a template's workflow — response body — recipient Routing rules
The recipient routing rules.

Referenced models: Adds a new step to a template's workflow — response body — recipient Routing rules

Adds a new step to a template's workflow — response body — recipient Routing rules
FieldTypePresenceDescription and constraints
$objectRoot
conditionalRecipientsarrayOptional
conditionalRecipients[]ModelEach itemExpand Adds a new step to a template's workflow — response body — recipient Routing rules conditional Recipients item

Referenced models: Adds a new step to a template's workflow — response body — recipient Routing rules conditional Recipients item

Adds a new step to a template's workflow — response body — recipient Routing rules conditional Recipients item
FieldTypePresenceDescription and constraints
$objectRootA rule that defines a set of recipients and the conditions under which they will be used for the envelope.
conditionsarrayOptionalAn array of conditions that define when the recipients will be used.
conditions[]ModelEach itemExpand Adds a new step to a template's workflow — response body — recipient Routing rules conditional Recipients item conditions item
orderstringOptionalAn integer that specifies the order in which rules are processed.
Lower values are processed before higher values.
recipientGroupModelOptionalExpand Adds a new step to a template's workflow — response body — recipient Routing rules conditional Recipients item recipient Group
A set of recipients that may be used for the envelope, depending on the `conditions` defined.
recipientIdstringOptionalThe ID of the recipient to whom the condition will be applied. This value should match the `recipientId` defined in the recipient object.

Referenced models: Adds a new step to a template's workflow — response body — recipient Routing rules conditional Recipients item conditions item, Adds a new step to a template's workflow — response body — recipient Routing rules conditional Recipients item recipient Group

SDK function policy ID: docusign.esignature_templateworkflowdefinition_puttemplateworkflowdefinition. Catalog operation: esignature:TemplateWorkflowDefinition_PutTemplateWorkflowDefinition. 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.