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

Updates the workflow definition for a template

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

Updates the specified template's workflow definition.

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.

Request Body

application/json

Describes the workflow for an envelope.

currentWorkflowStepId?string

The workflowStepId of the current step. This is not an index into the workflowSteps array in this object. See the workflowStep object.

resumeDate?string

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?

A complex element that specifies the scheduled sending settings for the envelope.

workflowStatus?string

The status of the workflow:

  • paused if the workflow is paused
  • in_progress if the workflow is in progress
workflowSteps?array<>

An array of workflow steps.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/templates/string/workflow" \  -H "Content-Type: application/json" \  -d '{}'
{  "currentWorkflowStepId": "string",  "resumeDate": "string",  "scheduledSending": {    "bulkListId": "string",    "resumeDate": "string",    "rules": [      {        "delay": "string",        "resumeDate": "string"      }    ],    "status": "string"  },  "workflowStatus": "string",  "workflowSteps": [    {      "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"    }  ]}

Delete the workflow definition for a template DELETE

Deletes the specified template's workflow definition if it has one. **Note:** If the specified template does not have a workflow definition, this endpoint returns a 200 response.

Returns the scheduled sending rules for a template's workflow definition GET

Given a template specified by `templateId`, returns the scheduled sending rules for that template's workflow object. **Note:** If the template's workflow does not have a scheduled sending object, this method returns a 404.