This endpoint adds a new step to an existing envelope's workflow in DocuSign. It allows for the configuration of complex workflow rules, including delayed routing, conditional recipients, and specific actions based on envelope status or recipient actions. Use this endpoint when…
actionstringIndicates the action to perform. Valid values: - `pause_before`: The workflow should pause before the trigger described by `triggerOnItem` is reached.
itemIdstringThe identifier of the item that triggers this workflow step. When `triggerOnItem` is set to `routing_order`, this should be the routing order number (as a string) where the workflow step action should occur. For example, setting `itemId` to "2" with `action` as "pause_before" wi…
statusstringThe status of the step. Valid values: - `inactive` - `in_progress` - `paused` - `pending` - `completed` This property is read-only.
accountIdstringThe external account number (integer) or account ID GUID that uniquely identifies the DocuSign account. This parameter is required and must be provided in the path of the API call. It is used to specify which account the envelope belongs to.
envelopeIdRequiredstringThe unique identifier for the envelope to which the workflow step will be added. This parameter is required and must be provided in the path of the API call. It should be a valid GUID (Globally Unique Identifier) format, for example: "93be49ab-xxxx-xxxx-xxxx-f752070d71ec".
completedDatestringThe timestamp of when the workflow step transitioned to `completed` status. This property is read-only.
triggerOnItemstringThe type of item that triggers this workflow step. Valid values: * `routing_order`
triggeredDatestringThe timestamp of when the workflow step transitioned to `in_progress` status. This property is read-only.
workflowStepIdstringA unique identifier for this workflow step. This property is read-only.
delayedRouting__rulesarrayUser-specified rules indicating how and when the envelope should sent for the workflow step and its associated recipients. Only one rule may be specified.
delayedRouting__statusstringStatus 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…
delayedRouting__resumeDatestringThe 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.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.