Envelope Workflow Definition

Updates the delayed routing rules for a template's workflow step

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

Updates the scheduled sending rules for a template's workflow.

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

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/templates/string/workflow/steps/string/delayedRouting" \  -H "Content-Type: application/json" \  -d '{}'
{  "resumeDate": "string",  "rules": [    {      "delay": "string",      "resumeDate": "string"    }  ],  "status": "string"}