Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Envelope Workflow Definition

Updates a specified workflow step for a template

PUT
/v2.1/accounts/{accountId}/templates/{templateId}/workflow/steps/{workflowStepId}

Updates a specified workflow step for a template.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

The external account number (int) or account ID GUID.

templateId*string

The ID of the template.

workflowStepId*string

The ID of the workflow step.

Request Body

application/json

Describes a single step in a workflow.

action?string

Indicates the action to perform. Valid values:

  • pause_before: The workflow should pause before the trigger described by triggerOnItem is reached.
completedDate?string

The timestamp of when the workflow step transitioned to completed status.

This property is read-only.

delayedRouting?

A complex element that specifies the delayed routing settings for the workflow step.

itemId?string

The unique ID of the item being triggered.

recipientRouting?

Describes the recipient routing rules.

status?string

The status of the step. Valid values:

  • inactive
  • in_progress
  • paused
  • pending
  • completed

This property is read-only.

triggeredDate?string

The timestamp of when the workflow step transitioned to in_progress status.

This property is read-only.

triggerOnItem?string

The type of item that triggers this workflow step. Valid values:

  • routing_order
workflowStepId?string

A unique identifier for this workflow step.

This property is read-only.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/templates/string/workflow/steps/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "action": "string",  "completedDate": "string",  "delayedRouting": {    "resumeDate": "string",    "rules": [      {        "delay": "string",        "resumeDate": "string"      }    ],    "status": "string"  },  "itemId": "string",  "recipientRouting": {    "rules": {      "conditionalRecipients": [        {          "conditions": [            {              "filters": [                {                  "operator": "string",                  "recipientId": "string",                  "scope": "string",                  "tabId": "string",                  "tabLabel": "string",                  "tabType": "string",                  "value": "string"                }              ],              "order": "string",              "recipientLabel": "string"            }          ],          "order": "string",          "recipientGroup": {            "groupMessage": "string",            "groupName": "string",            "recipients": [              {                "email": "string",                "name": "string",                "recipientLabel": "string",                "roleName": "string",                "signingGroupId": "string"              }            ]          },          "recipientId": "string"        }      ]    }  },  "status": "string",  "triggeredDate": "string",  "triggerOnItem": "string",  "workflowStepId": "string"}

Deletes a workflow step from an template's workflow definition DELETE

Deletes a workflow step from an template's workflow definition.

Returns the delayed routing rules for a template's workflow step definition GET

Given a template and a workflow step, returns the delayed routing rules for that workflow step. **Note:** If the workflow step does not have a delayed routing object, this method returns a 404.