Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

documentIdstring

Integer that identifies the document in the envelope.

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

Responses

CodeDescriptionReference
200

Successful response.

EnvelopeDocumentHtmlDefinitions
400

Error encountered.

errorDetails

SDK Method

Envelopes::getEnvelopeDocumentHtmlDefinitions

Definitions

documentHtmlCollapsibleDisplaySettings

arrowClosedstring

arrowColorstring

arrowLocationstring

arrowOpenstring

arrowSizestring

arrowStylestring

containerStylestring

labelStylestring

onlyArrowIsClickableboolean

outerLabelAndArrowStylestring

documentHtmlDefinition

displayAnchorPrefixstring

displayAnchors[documentHtmlDisplayAnchor]

displayOrderstring

The position on the page where the display section appears.

displayPageNumberstring

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

documentGuidstring

documentIdstring

Integer that identifies the document in the envelope.

headerLabelstring

maxScreenWidthstring

removeEmptyTagsstring

showMobileOptimizedTogglestring

sourcestring

documentHtmlDefinitionOriginal

documentIdstring

Integer that identifies the document in the envelope.

documentIdGuidstring

The GUID of the document.

htmlDefinitiondocumentHtmlDefinition

documentHtmlDisplayAnchor

caseSensitiveboolean

displaySettingsdocumentHtmlDisplaySettings

This object defines how the HTML section inside the startAnchor and endAnchor displays.

endAnchorstring

Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default.

Note: A start anchor, an end anchor, or both are required.

removeEndAnchorboolean

When true, removes the end anchor string for the Smart Section from the HTML, preventing it from displaying.

removeStartAnchorboolean

When true, removes the start anchor string for the Smart Section from the HTML, preventing it from displaying.

startAnchorstring

Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.

Note: A start anchor, an end anchor, or both are required.

documentHtmlDisplaySettings

cellStylestring

Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of responsive_table or responsive_table_single_column types.

collapsibleSettingsdocumentHtmlCollapsibleDisplaySettings

This object defines the appearance and function of a collapsible section or item.

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

The label for the display section.

displayOrderinteger

The position on the page where the display section appears.

displayPageNumberinteger

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

hideLabelWhenOpenedboolean

When true, the displayLabel is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the display property is collapsed.

inlineOuterStylestring

Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the display property is inline.

labelWhenOpenedstring

The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the display property is collapsed.

scrollToTopWhenOpenedboolean

When true and the section is expanded, the position of the section close is scrolled to the top of the screen. This property is only valid when the value of the display property is collapsed.

tableStylestring

Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the display property is responsive_table or responsive_table_single_column.

errorDetails

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

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

EnvelopeDocumentHtmlDefinitions
}} />