DocuSign icon

DocuSign

Interact with the DocuSign eSignature REST API v2.1 — complete enterprise coverage

Actions341

Envelope Workflow → Update Workflow

AI-generated

Summary

Updates an existing DocuSign envelope workflow definition or template workflow definition using a JSON request body.

Inputs

  • authentication — Authentication method: OAuth2 or JWT (Service Integration). Defaults to OAuth2.
  • accountId (required) — The DocuSign Account ID (GUID). Find it in DocuSign Admin → API and Keys.
  • scope (required) — Whether to manage workflow on an envelope or a template.
  • envelopeId (required) — The ID (GUID) of the envelope. Required when scope is 'envelope'.
  • templateId (required) — The ID (GUID) of the template. Required when scope is 'template'.
  • requestBody (required) — The JSON request body for the operation.

Output shape

The response from the DocuSign API (typically a JSON object representing the updated workflow definition).

The response structure depends on the specific fields provided in the request body. For envelope workflows, the response corresponds to the envelope workflow definition.

Examples

Example 1: Update an envelope workflow definition.

Set 'Authentication' to 'OAuth2', provide the 'Account ID', select 'Envelope' as 'Scope', provide the 'Envelope ID', and input the specific workflow configuration JSON in 'Request Body (JSON)'.

Example 2: Update a template workflow definition.

Set 'Authentication' to 'OAuth2', provide the 'Account ID', select 'Template' as 'Scope', provide the 'Template ID', and input the specific workflow configuration JSON in 'Request Body (JSON)'.

Links

Discussion