Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

documentIdstring

The ID of the document being accessed.

templateIdstring

The ID of the template.

Responses

CodeDescriptionReference
200

Successful response.

EnvelopeDocumentHtmlDefinitions
400

Error encountered.

errorDetails

SDK Method

Templates::getTemplateDocumentHtmlDefinitions

Definitions

documentHtmlCollapsibleDisplaySettings

arrowClosedstring

arrowColorstring

arrowLocationstring

arrowOpenstring

arrowSizestring

arrowStylestring

containerStylestring

labelStylestring

onlyArrowIsClickableboolean

outerLabelAndArrowStylestring

documentHtmlDefinition

displayAnchorPrefixstring

displayAnchors[documentHtmlDisplayAnchor]

displayOrderstring

displayPageNumberstring

documentGuidstring

documentIdstring

The ID of the document being accessed.

headerLabelstring

maxScreenWidthstring

removeEmptyTagsstring

showMobileOptimizedTogglestring

sourcestring

documentHtmlDefinitionOriginal

documentIdstring

The ID of the document being accessed.

documentIdGuidstring

The Guid of the document.

htmlDefinitiondocumentHtmlDefinition

documentHtmlDisplayAnchor

caseSensitiveboolean

displaySettingsdocumentHtmlDisplaySettings

endAnchorstring

removeEndAnchorboolean

removeStartAnchorboolean

startAnchorstring

documentHtmlDisplaySettings

cellStylestring

collapsibleSettingsdocumentHtmlCollapsibleDisplaySettings

displaystring

This string sets the display and behavior properties of the document during signing. The possible values are:

  • modal
    The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. This is the recommended value for supplemental documents.

  • download
    The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window.

  • inline
    The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents.

displayLabelstring

displayOrderinteger

displayPageNumberinteger

hideLabelWhenOpenedboolean

inlineOuterStylestring

labelWhenOpenedstring

scrollToTopWhenOpenedboolean

tableStylestring

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

EnvelopeDocumentHtmlDefinitions
}} />