Sign in
latestSwagger 2.02026-07-134146194.6 MB

77f1998c313d

EnvelopeWorkflowDefinition

Updates the workflow definition for a template.

Updates the specified template's workflow definition.

put/v2.1/accounts/{accountId}/templates/{templateId}/workflow

Path parameters

accountIdstring required

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

templateIdstring required

The ID of the template.

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.