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

Gets the Original HTML Definition used to generate the Responsive HTML for a given document in a template

GET
/v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions

Gets the Original HTML Definition used to generate the Responsive HTML for a given document in a template.

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.

documentId*string

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.

templateId*string

The ID of the template.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/templates/string/documents/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 versions of all of the documents associated with a template 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 associated with a template. 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.

Gets the Original HTML Definition used to generate the Responsive HTML for the template GET

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