Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Envelope Html Definitions

Gets the Original HTML Definition used to generate the Responsive HTML for the envelope

GET
/v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions

Gets the Original HTML Definition used to generate the Responsive HTML for the envelope.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

envelopeId*string

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/envelopes/string/html_definitions"
{  "htmlDefinitions": [    {      "documentId": "string",      "documentIdGuid": "string",      "htmlDefinition": {        "displayAnchorPrefix": "string",        "displayAnchors": [          {            "caseSensitive": true,            "displaySettings": {              "cellStyle": "string",              "collapsibleSettings": {                "arrowClosed": "string",                "arrowColor": "string",                "arrowLocation": "string",                "arrowOpen": "string",                "arrowSize": "string",                "arrowStyle": "string",                "containerStyle": "string",                "labelStyle": "string",                "onlyArrowIsClickable": true,                "outerLabelAndArrowStyle": "string"              },              "display": "string",              "displayLabel": "string",              "displayOrder": 0,              "displayPageNumber": 0,              "hideLabelWhenOpened": true,              "inlineOuterStyle": "string",              "labelWhenOpened": "string",              "preLabel": "string",              "scrollToTopWhenOpened": true,              "tableStyle": "string"            },            "endAnchor": "string",            "removeEndAnchor": true,            "removeStartAnchor": true,            "startAnchor": "string"          }        ],        "displayOrder": "string",        "displayPageNumber": "string",        "documentGuid": "string",        "documentId": "string",        "headerLabel": "string",        "maxScreenWidth": "string",        "removeEmptyTags": "string",        "showMobileOptimizedToggle": "string",        "source": "string"      }    }  ]}

Creates a preview of the responsive version of a document POST

Creates a preview of the [responsive](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/responsive/) HTML version of a specific 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.

Creates a preview of the responsive versions of all of the documents in an envelope POST

Creates a preview of the [responsive](https://developers.docusign.com/docs/esign-rest-api/esign101/concepts/responsive/), HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions 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 documents.