Skip to content

DocuSign: Adds a new step to a template's workflow

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

← Esignature operations · Get started

Operation docusign.esignature_templateworkflowstep_posttemplateworkflowstepdefinition

Provider route: POST /restapi/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps. 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"]["esignatureTemplateWorkflowStepPostTemplateWorkflowStepDefinition"]>[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.esignatureTemplateWorkflowStepPostTemplateWorkflowStepDefinition(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_step_post_template_workflow_step_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 Adds a new step to a template’s workflow — response body

Referenced models: Adds a new step to a template’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 Adds a new step to a template’s workflow — response body

Referenced models: Adds a new step to a template’s workflow — response body

1 more schema is linked from the tables above, on the schema pages.

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

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

Adds a new step to a template's workflow — response body — recipient Routing rules conditional Recipients item conditions item
FieldTypePresenceDescription and constraints
$objectRoot
filtersarrayOptional
filters[]ModelEach itemExpand Adds a new step to a template's workflow — response body — recipient Routing rules conditional Recipients item conditions item filters item
orderstringOptionalAn integer that specifies the order in which rules are processed.
Lower values are processed before higher values.
recipientLabelstringOptionalAn identifier for the recipient. After assigning this value in a `recipient` object, you can reference it in the `conditions` object to set the recipient as a conditional recipient. For an example, see [How to use conditional recipients](/docs/esign-rest-api/how-to/use-conditional-recipients/).

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

Adds a new step to a template's workflow — response body — recipient Routing rules conditional Recipients item recipient Group
FieldTypePresenceDescription and constraints
$objectRootDescribes a group of recipients.
groupMessagestringOptionalThe group message, typically a description of the group.
groupNamestringOptionalThe name of the group.
recipientsarrayOptionalAn array of recipient objects that provides details about the recipients of the envelope.
recipients[]ModelEach itemExpand Adds a new step to a template's workflow — response body — recipient Routing rules conditional Recipients item recipient Group recipients item

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

Adds a new step to a template's workflow — response body — recipient Routing rules conditional Recipients item conditions item filters item
FieldTypePresenceDescription and constraints
$objectRoot
operatorstringOptionalHow the tab value is compared to the `value` property. Valid values:

* `equals`
* `greaterThan`
* `greaterThanEquals`
* `lessThan`
* `lessThanEquals`
* `filled`
* `selected`
recipientIdstringOptionalA local reference used to map
recipients to other objects, such as specific
document tabs.

A `recipientId` must be
either an integer or a GUID,
and the `recipientId` must be
unique within an envelope.

For example, many envelopes assign the first recipient
a `recipientId` of `1`.
scopestringOptionalThe scope under which the condition is evaluated. Valid values:

* `tabs`
tabIdstringOptionalThe unique identifier for the tab.
tabLabelstringOptionalThe label associated with the tab. This value may be an empty string.
If no value is provided, the tab type is used as the value.

Maximum Length: 500 characters.
tabTypestringOptionalIndicates the type of tab (for example, `signHere` or `initialHere`).
valuestringOptionalA set value to which the tab's actual value is compared.

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