DocuSign icon

DocuSign

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

Actions341

Envelope View → Create Sender View

AI-generated

Summary

Generates an embedded URL for a sender to interact with an envelope's settings, documents, or recipients.

Inputs

  • authentication (required) — Authentication method for the view session: OAuth2 or JWT (Service Integration).
  • category (required) — API category to work with: Envelopes, Templates, Account, etc.
  • accountId (required) — The DocuSign Account ID (GUID).
  • envelopeId (required) — The ID (GUID) of the envelope.
  • returnUrl (required) — URL to redirect to after the view session ends. Must be HTTPS.
  • viewOptions — Optional settings for the view (e.g., Starting Envelope ID for console view).

Output shape

A JSON object containing an embedded URL string and authentication token data.

The URL is meant to be opened in an iframe or new window. Returns data only; the session itself is handled in the browser.

Examples

Example 1: Open an envelope for review/editing

Set category to 'Envelopes', provide envelope ID and returnUrl.

Example 2: Launch the envelope console view

Set category to 'Envelopes', include viewOptions.envelopeId to start at a specific envelope.

Links

Discussion