Envelope Workflow Definition

Returns the workflow definition for an envelope

GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow

Returns the workflow definition for the envelope specified by envelopeId. If the envelope 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.

envelopeId*string

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/envelopes/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 jurisdiction information about a notary PUT

Updates the jurisdiction information about a notary. The following restrictions apply: - The current user must be a notary. - The `jurisdictionId` path parameter must be a jurisdiction that the notary is registered for. - The `jurisdictionId` path parameter must match the request body's `jurisdiction.jurisdictionId`. The request body must have a full `jurisdiction` object for the jurisdiction property. The best way to do this is to use `getNotaryJurisdiction` to obtain the current values and update the properties you want to change. For example, assume `getNotaryJurisdiction` returns this: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Bob Notary", "county": "Adams", "sealType": "system_created" } ``` If you want to change the name of the notary from "Bob Notary" to "Robert Notary", your request body would be: ``` { "jurisdiction": { "jurisdictionId": "15", "name": "Iowa", "county": "", "enabled": "true", "countyInSeal": "false", "commissionIdInSeal": "true", "stateNameInSeal": "true", "notaryPublicInSeal": "true", "allowSystemCreatedSeal": "true", "allowUserUploadedSeal": "false" }, "commissionId": "123456", "commissionExpiration": "2020-08-31T07:00:00.0000000Z", "registeredName": "Robert Notary", "county": "Adams", "sealType": "system_created" } ```

Delete the workflow definition for an envelope DELETE

Deletes the specified envelope's workflow definition if it has one. **Note:** If the envelope was scheduled to be sent, this endpoint will cancel the scheduled send and the envelope status will be reset to `created`. To resend the envelope, call the update the status to `sent` with the [Envelopes::Update](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/) method.