Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeWorkflowDefinition

Updates the specified workflow step for an envelope.

Updates the workflow step specified by workflowStepId for an envelope.

You can use this endpoint to add or update delayed routing for a draft envelope. You can add or update delayed routing for a sent envelope as long as the previous workflow step has not been completed.

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

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

envelopeIdstring required

The envelope's GUID.

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

workflowStepIdstring required

The ID of the workflow step.

Request body

actionstring

Indicates the action to perform. Valid values:

  • pause_before: The workflow should pause before the trigger described by triggerOnItem is reached.
completedDatestring

The timestamp of when the workflow step transitioned to completed status.

This property is read-only.

itemIdstring

The unique ID of the item being triggered.

statusstring

The status of the step. Valid values:

  • inactive
  • in_progress
  • paused
  • pending
  • completed

This property is read-only.

triggeredDatestring

The timestamp of when the workflow step transitioned to in_progress status.

This property is read-only.

triggerOnItemstring

The type of item that triggers this workflow step. Valid values:

  • routing_order
workflowStepIdstring

A unique identifier for this workflow step.

This property is read-only.

Response

Successful response.