Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeWorkflowDefinition

Updates the workflow definition for an envelope.

Updates the specified envelope's workflow.

You can use this endpoint to add scheduled sending to a draft envelope. You can also update the scheduled sending for a sent envelope if the scheduled sending countdown is in progress. In that case, the envelope will be reset to a draft state.

You can also add delayed routing to a draft envelope or a sent envelope that has not started workflow processing.

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

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

Request body

currentWorkflowStepIdstring

The workflowStepId of the current step. This is not an index into the workflowSteps array in this object. See the workflowStep object.

resumeDatestring

The ISO 8601 timestamp of when the envelope is scheduled to be sent, if applicable. Its value is the maximum of the resumeDate property on scheduledSending and the resumeDate property on the current workflowStep.

This property is read-only.

workflowStatusstring

The status of the workflow:

  • paused if the workflow is paused
  • in_progress if the workflow is in progress

Response

Successful response.