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

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

PUT
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow/steps/{workflowStepId}/delayedRouting

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.

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

workflowStepId*string

The ID of the workflow step.

Request Body

application/json

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

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

resumeDate?string

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<>

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.

status?string

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.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/envelopes/string/workflow/steps/string/delayedRouting" \  -H "Content-Type: application/json" \  -d '{}'
{  "resumeDate": "string",  "rules": [    {      "delay": "string",      "resumeDate": "string"    }  ],  "status": "string"}

Deletes the delayed routing rules for the specified envelope workflow step DELETE

Delete the delayed routing object for an envelope's workflow step. You cannot call this endpoint once the delay is in progress. As a workaround, you can update the delay or send time to one minute in the future using the [updateEnvelopeDelayedRoutingDefinition](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/updateEnvelopeDelayedRoutingDefinition/) endpoint. **Note:** After deleting the delayed routing object, the workflow step still contains the `pause_before` action. Once the workflow step is reached, you will need to [unpause the envelope](https://developers.docusign.com/docs/esign-rest-api/how-to/unpause-workflow/). If you want to delete the step entirely, use [deleteEnvelopeWorkflowStepDefinition](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopeworkflowdefinition/deleteenvelopeworkflowstepdefinition/) instead.

Returns the workflow definition for a template GET

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