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

Returns the workflow definition for a template

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

Returns the workflow definition for the template specified by templateId. If the template does not have a workflow object, this method returns a 404.

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.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/templates/string/workflow"
{  "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"    }  ]}

Updates the delayed routing rules for an envelope's workflow step definition PUT

Updates the delayed routing rules for an envelope's workflow step definition. You can use this endpoint to add delayed routing to a draft envelope or a sent envelope (as long as the previous workflow step has not yet been completed). You can also update the delayed routing rule for an envelope, as long as the delay is not yet complete. If you update the delayed routing rule while the delay is already in progress, the countdown will reset.

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.