DocuSign icon

DocuSign

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

Actions341

Responsive HTML Preview → Create Document Preview

AI-generated

Summary

Create a responsive HTML preview for a specific document within a DocuSign envelope, generating an interactive and embeddable document view based on the provided JSON request body.

Inputs

  • Authentication — Choose between OAuth2 or JWT (Service Integration) authentication methods for API access.
  • Category — Select the DocuSign API category, defaulting to 'Envelopes' for this operation.
  • Account ID (required) — The DocuSign Account ID (GUID) required to identify the account context for the request.
  • Envelope ID (required) — The ID (GUID) of the envelope containing the document to preview.
  • Document ID (required) — The numeric ID of the document within the envelope; special values like 'combined', 'archive', or 'certificate' are also supported to reference merged documents, ZIP archives, or certificate of completion respectively.
  • Request Body (JSON) (required) — A JSON object specifying parameters for generating the responsive HTML preview, such as layout or display options.

Output shape

a single JSON object containing the responsive HTML preview data as returned by DocuSign API

The returned data is the raw API response for the document preview generation request, which includes HTML content for embedding or displaying the document preview in workflows.

Examples

Example 1: Generate a responsive HTML preview of document ID 1 in a specific envelope

Provide Account ID, Envelope ID, Document ID = '1', and a properly structured JSON request body to customize preview options.

Links

Discussion