DocuSign icon

DocuSign

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

Actions341

Template HTML Definition → Create Document Responsive HTML

AI-generated

Summary

Generate responsive HTML preview of a specified document within a DocuSign template to enable dynamic rendering of the document in client applications.

Inputs

  • Authentication — Choose between OAuth2 or JWT authentication methods to access the DocuSign API.
  • Category — Select the API category; default is 'envelopes' though it operates on template document level.
  • Account ID (required) — The DocuSign Account ID (GUID) used to scope the API request.
  • Template ID (required) — The ID (GUID) of the template containing the document to render.
  • Document ID (required) — The numeric ID of the document in the template to generate responsive HTML for; special values like 'combined', 'archive', 'certificate' are also supported.
  • Request Body (JSON) — JSON object specifying options for the responsive HTML preview request body as defined by DocuSign API's structure.

Output shape

a JSON object containing the responsive HTML definition for the specified document.

The response conforms to the DocuSign API's responsive HTML preview structure. This operation is used for generating a client-optimized HTML rendering of a template document and may require proper DocuSign account and template setup. No pagination or streaming is involved.

Examples

Example 1: Generate a responsive HTML preview for document ID '1' in a template using OAuth2 authentication.

Set Account ID and Template ID to valid GUIDs, specify Document ID as '1', and provide a compliant JSON object in Request Body if customization is needed.

Links

Discussion