DocuSign: Updates the workflow definition for an envelope
DocuSign esignature.esignatureEnvelopeWorkflowDefinitionV2PutEnvelopeWorkflowDefinition: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_envelopeworkflowdefinitionv2_putenvelopeworkflowdefinition
Provider route: PUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow. 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"]["esignatureEnvelopeWorkflowDefinitionV2PutEnvelopeWorkflowDefinition"]>[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.esignatureEnvelopeWorkflowDefinitionV2PutEnvelopeWorkflowDefinition(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_definition_v2_put_envelope_workflow_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 Returns the workflow definition for a template — response body |
Referenced models: Returns the workflow definition for a template — 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 Returns the workflow definition for a template — response body |
Referenced models: Returns the workflow definition for a template — response body
Schemas
Section titled “Schemas”4 more schemas are linked from the tables above, on the schema pages.
Returns the workflow definition for a template — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes the workflow for an envelope. |
currentWorkflowStepId | string | Optional | The `workflowStepId` of the current step. This is not an index into the `workflowSteps` array in this object. See the `workflowStep` object. |
resumeDate | string | Optional | The 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. |
scheduledSending | Model | Optional | Expand Updates the scheduled sending rules for an envelope's workflow — response body An object that describes the settings for scheduled sending. |
workflowStatus | string | Optional | The status of the workflow: - `paused` if the workflow is paused - `in_progress` if the workflow is in progress |
workflowSteps | array | Optional | An array of workflow steps. |
workflowSteps[] | Model | Each item | Expand 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
| 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
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 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. |
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
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
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_envelopeworkflowdefinitionv2_putenvelopeworkflowdefinition. Catalog operation: esignature:EnvelopeWorkflowDefinitionV2_PutEnvelopeWorkflowDefinition. 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.