Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
TemplateDocumentResponsiveHtmlPreview

Creates a preview of the responsive version of a template document.

Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending.

The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

post/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

documentIdstring required

The unique ID of the document within the envelope.

Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647).

Tab objects have a documentId property that specifies the document on which to place the tab.

templateIdstring required

The ID of the template.

Request body

displayAnchorPrefixstring

Contains text that all display anchors must start with. Using at least four characters will improve anchor processing performance.

displayOrderstring

The position on the page where the display section appears.

displayPageNumberstring

The number of the page on which the display section appears.

documentGuidstring

The GUID of the document.

documentIdstring

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

headerLabelstring

Header text or an HTML tag to place above the responsive HTML block.

maxScreenWidthstring

If set, the responsive HTML version of the signing document will only display on screens with the specified pixel width or less. If the screen is larger than the value that you specify, the default PDF version of the content displays instead.

This setting can also be configured at the account level.

removeEmptyTagsstring

Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).

showMobileOptimizedTogglestring

When true (the default), the Mobile-Friendly toggle displays at the top of the screen on the user's mobile device. When false, the toggle will not be displayed.

the Mobile-Friendly toggle lets the user switch between the mobile-friendly and the PDF versions of a document. For example, the recipient can use this toggle to review the document using the PDF view before they finish signing.

sourcestring

Specifies the type of responsive signing that will be used with the document.

If the value of this property is valid HTML, and the smart sections feature is enabled, the HTML code is used to display the signing page:

source: "<html> ... <body><p>hello world</p></body></html>"

If the value of this property is the string document, the HTML signing page is generated from the provided document.

source: "document"

Related topics

  • How to create a signable HTML document
  • How to convert a PDF file into a signable HTML document
  • Responsive signing

Response

Successful response.