DocuSign: Adds a new step to an envelope's workflow
DocuSign esignature.esignatureEnvelopeWorkflowStepPostEnvelopeWorkflowStepDefinition: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_envelopeworkflowstep_postenvelopeworkflowstepdefinition
Provider route: POST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps. 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"]["esignatureEnvelopeWorkflowStepPostEnvelopeWorkflowStepDefinition"]>[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.esignatureEnvelopeWorkflowStepPostEnvelopeWorkflowStepDefinition(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_envelope_workflow_step_post_envelope_workflow_step_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.envelopeId | string | Required within parent | |
body | Model | Optional | Expand 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
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 Adds a new step to a template’s workflow — response body |
Referenced models: Adds a new step to a template’s workflow — response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Adds a new step to a template's workflow — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes a single step in a workflow. |
action | string | Optional | Indicates the action to perform. Valid values: - `pause_before`: The workflow should pause before the trigger described by `triggerOnItem` is reached. |
completedDate | string | Optional | The timestamp of when the workflow step transitioned to `completed` status. This property is read-only. |
delayedRouting | Model | Optional | Expand 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. |
itemId | string | Optional | The unique ID of the item being triggered. |
recipientRouting | Model | Optional | Expand Adds a new step to a template's workflow — response body — recipient Routing The rules for recipient routing. |
status | string | Optional | The status of the step. Valid values: - `inactive` - `in_progress` - `paused` - `pending` - `completed` This property is read-only. |
triggerOnItem | string | Optional | The type of item that triggers this workflow step. Valid values: * `routing_order` |
triggeredDate | string | Optional | The timestamp of when the workflow step transitioned to `in_progress` status. This property is read-only. |
workflowStepId | string | Optional | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that specifies the delayed routing settings for the workflow step. |
resumeDate | string | Optional | The 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. |
rules | array | Optional | User-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[] | Model | Each item | Expand Updates the scheduled sending rules for an envelope's workflow — response body — rules item |
status | string | Optional | Status 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes the recipient routing rules. |
rules | Model | Optional | Expand 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
| 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. |
Adds a new step to a template's workflow — response body — recipient Routing rules
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
conditionalRecipients | array | Optional | |
conditionalRecipients[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A rule that defines a set of recipients and the conditions under which they will be used for the envelope. |
conditions | array | Optional | An array of conditions that define when the recipients will be used. |
conditions[] | Model | Each item | Expand Adds a new step to a template's workflow — response body — recipient Routing rules conditional Recipients item conditions item |
order | string | Optional | An integer that specifies the order in which rules are processed. Lower values are processed before higher values. |
recipientGroup | Model | Optional | Expand 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. |
recipientId | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
filters | array | Optional | |
filters[] | Model | Each item | Expand Adds a new step to a template's workflow — response body — recipient Routing rules conditional Recipients item conditions item filters item |
order | string | Optional | An integer that specifies the order in which rules are processed. Lower values are processed before higher values. |
recipientLabel | string | Optional | An 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes a group of recipients. |
groupMessage | string | Optional | The group message, typically a description of the group. |
groupName | string | Optional | The name of the group. |
recipients | array | Optional | An array of recipient objects that provides details about the recipients of the envelope. |
recipients[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
operator | string | Optional | How the tab value is compared to the `value` property. Valid values: * `equals` * `greaterThan` * `greaterThanEquals` * `lessThan` * `lessThanEquals` * `filled` * `selected` |
recipientId | string | Optional | A 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`. |
scope | string | Optional | The scope under which the condition is evaluated. Valid values: * `tabs` |
tabId | string | Optional | The unique identifier for the tab. |
tabLabel | string | Optional | The 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. |
tabType | string | Optional | Indicates the type of tab (for example, `signHere` or `initialHere`). |
value | string | Optional | A set value to which the tab's actual value is compared. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_envelopeworkflowstep_postenvelopeworkflowstepdefinition. Catalog operation: esignature:EnvelopeWorkflowStep_PostEnvelopeWorkflowStepDefinition. 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.