Docusign EnvelopeDocumentHtmlDefinitions API

openapi: 3.2.0
info:
  title: Docusign Envelope Document Html Definitions API
  termsOfService: https://www.docusign.com/company/terms-and-conditions/web
  version: '1.0'
  description: 'Operations tagged EnvelopeDocumentHtmlDefinitions across 2 of this provider''s published API definitions: docusign-openapi-original.yml, docusign-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://www.docusign.net/restapi
tags:
- name: EnvelopeDocumentHtmlDefinitions
  description: ''
paths:
  /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions:
    get:
      tags:
      - EnvelopeDocumentHtmlDefinitions
      operationId: ResponsiveHtml_GetEnvelopeDocumentHtmlDefinitions
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account id GUID.
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: The ID of the document being accessed.
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/documentHtmlDefinitionOriginals'
        '400':
          description: Error encountered.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/errorDetails'
      deprecated: false
      x-ds-methodname: getEnvelopeDocumentHtmlDefinitions
      x-ds-method: get
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
      summary: Responsive html get envelope document html definitions
      x-summary-source: derived
    servers:
    - url: https://www.docusign.net/restapi
  /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions:
    parameters: []
    get:
      tags:
      - EnvelopeDocumentHtmlDefinitions
      summary: Retrieves the HTML definition used to generate a dynamically sized responsive…
      operationId: getV21AccountsByAccountIdEnvelopesByEnvelopeIdDocumentsByDocumentIdHtmlDefinitions
      parameters:
      - name: accountId
        in: path
        description: The external account number (int) or account ID GUID.
        required: true
        schema:
          type: string
      - name: documentId
        in: path
        description: 'The GUID of the document.


          Example: c671747c-xxxx-xxxx-xxxx-4a4a48e23744'
        required: true
        schema:
          type: string
      - name: envelopeId
        in: path
        description: "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documentHtmlDefinitionOriginals_2'
        '400':
          description: Error encountered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorDetails_2'
      deprecated: false
      x-ds-methodname: getEnvelopeDocumentHtmlDefinitions
      description: 'Retrieves the HTML definition used to generate a dynamically sized responsive document.


        If the document was not created as a signable HTML document, this endpoint will return a 200-OK response and an empty JSON body.


        **Note:** The `documentId` query parameter is a GUID value, not an integer document ID. If an invalid document ID is provided, this endpoint will return a 200-OK response and an empty JSON body.


        ### Related topics


        - Responsive signing'
      x-ds-method: get
      x-ds-service: Uncategorized
      x-ds-in-sdk: true
      x-operation-id-source: normalized
      x-operation-id-original: ResponsiveHtml_GetEnvelopeDocumentHtmlDefinitions
    servers:
    - url: https://www.docusign.net/restapi
components:
  schemas:
    documentHtmlDisplayAnchor:
      type: object
      properties:
        caseSensitive:
          type: boolean
          description: ''
        displaySettings:
          $ref: '#/components/schemas/documentHtmlDisplaySettings'
        endAnchor:
          type: string
          description: ''
        removeEndAnchor:
          type: boolean
          description: ''
        removeStartAnchor:
          type: boolean
          description: ''
        startAnchor:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: documentHtmlDisplayAnchor
      x-ms-summary: ''
    documentHtmlDefinitionOriginals:
      type: object
      properties:
        htmlDefinitions:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/documentHtmlDefinitionOriginal'
      description: ''
      x-ds-definition-name: documentHtmlDefinitionOriginals
      x-ms-summary: ''
    errorDetails:
      type: object
      properties:
        errorCode:
          type: string
          description: An error code associated with the error.
        message:
          type: string
          description: A short error message.
      description: This object describes errors that occur. It is only valid for responses, and ignored in requests.
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests.
    documentHtmlDisplaySettings:
      type: object
      properties:
        cellStyle:
          type: string
          description: ''
        collapsibleSettings:
          $ref: '#/components/schemas/documentHtmlCollapsibleDisplaySettings'
        display:
          type: string
          description: "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`<br>\n  The document is shown as a supplement action strip\n  and can be viewed, downloaded, or printed in a modal window.\n  This is the recommended value for supplemental documents. \n\n* `download`<br>\n  The document is shown as a supplement action strip\n  and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`<br>\n  The document is shown in the normal signing window.\n  This value is not used with supplemental documents,\n  but is the default value for all other documents.\n"
        displayLabel:
          type: string
          description: ''
        displayOrder:
          type: integer
          description: ''
          format: int32
        displayPageNumber:
          type: integer
          description: ''
          format: int32
        hideLabelWhenOpened:
          type: boolean
          description: ''
        inlineOuterStyle:
          type: string
          description: ''
        labelWhenOpened:
          type: string
          description: ''
        preLabel:
          type: string
          description: ''
        scrollToTopWhenOpened:
          type: boolean
          description: ''
        tableStyle:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: documentHtmlDisplaySettings
      x-ms-summary: ''
    documentHtmlDefinitionOriginal:
      type: object
      properties:
        documentId:
          type: string
          description: The ID of the document being accessed.
        documentIdGuid:
          type: string
          description: ''
        htmlDefinition:
          $ref: '#/components/schemas/documentHtmlDefinition'
      description: ''
      x-ds-definition-name: documentHtmlDefinitionOriginal
      x-ms-summary: ''
    documentHtmlCollapsibleDisplaySettings:
      type: object
      properties:
        arrowClosed:
          type: string
          description: ''
        arrowColor:
          type: string
          description: ''
        arrowLocation:
          type: string
          description: ''
        arrowOpen:
          type: string
          description: ''
        arrowSize:
          type: string
          description: ''
        arrowStyle:
          type: string
          description: ''
        containerStyle:
          type: string
          description: ''
        labelStyle:
          type: string
          description: ''
        onlyArrowIsClickable:
          type: boolean
          description: ''
        outerLabelAndArrowStyle:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: documentHtmlCollapsibleDisplaySettings
      x-ms-summary: ''
    documentHtmlDefinition:
      type: object
      properties:
        displayAnchorPrefix:
          type: string
          description: ''
        displayAnchors:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/documentHtmlDisplayAnchor'
        displayOrder:
          type: string
          description: ''
        displayPageNumber:
          type: string
          description: ''
        documentGuid:
          type: string
          description: ''
        documentId:
          type: string
          description: The ID of the document being accessed.
        headerLabel:
          type: string
          description: ''
        maxScreenWidth:
          type: string
          description: ''
        removeEmptyTags:
          type: string
          description: ''
        showMobileOptimizedToggle:
          type: string
          description: ''
        source:
          type: string
          description: ''
      description: ''
      x-ds-definition-name: documentHtmlDefinition
      x-ms-summary: ''
    documentHtmlDisplayAnchor_2:
      type: object
      properties:
        caseSensitive:
          description: When **true,** the start or end anchor strings must match the strings specified by the start and end anchor settings in case as well as in content.
          type: boolean
        displaySettings:
          $ref: '#/components/schemas/documentHtmlDisplaySettings_2'
          description: This object defines how the HTML section inside the `startAnchor` and `endAnchor` displays.
        endAnchor:
          description: '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.'
          type: string
        removeEndAnchor:
          description: When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying.
          type: boolean
        removeStartAnchor:
          description: When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying.
          type: boolean
        startAnchor:
          description: '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.'
          type: string
      x-ds-definition-name: documentHtmlDisplayAnchor
      description: ''
      x-ms-summary: ''
    documentHtmlDefinitionOriginals_2:
      type: object
      properties:
        htmlDefinitions:
          description: Holds the properties that define how to generate the responsive-formatted HTML for the document.
          type: array
          items:
            $ref: '#/components/schemas/documentHtmlDefinitionOriginal_2'
      x-ds-definition-name: documentHtmlDefinitionOriginals
      description: ''
      x-ms-summary: ''
    errorDetails_2:
      description: This object describes errors that occur. It is only valid for responses and ignored in requests.
      type: object
      properties:
        errorCode:
          description: The code associated with the error condition.
          type: string
        message:
          description: A brief message describing the error condition.
          type: string
      x-ds-definition-name: errorDetails
      x-ms-summary: This object describes errors that occur. It is only valid for responses and ignored in requests.
    documentHtmlDisplaySettings_2:
      type: object
      properties:
        cellStyle:
          description: 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.
          type: string
        collapsibleSettings:
          $ref: '#/components/schemas/documentHtmlCollapsibleDisplaySettings_2'
          description: This object defines the appearance and function of a collapsible section or item.
        display:
          description: "Sets the display and behavior properties. Possible  values are:\n\n- `inline`:\n  Leaves the HTML where it is in the document.\n  This property lets you add a label or present on a separate page.\n\n- `collapsible`:\n  The HTML in this section may be expanded or collapsed.\n  Initially this section is expanded.\n\n- `collapsed`:\n  The HTML in this section may be expanded or collapsed.\n  Initially this section is collapsed.\n\n- `continue_button`:\n  Creates a stop point in the document to draw the reader's\n  attention before proceeding to the next section.\n\n- `responsive_table`:\n  Turns this section into a responsive table.\n  Note that this is only used on HTML tables that fall within the anchor start and end positions.\n\n- `responsive_table_single_column`:\n  Turns this section into a responsive single-column table.\n  Note this is only used on HTML tables that fall within the anchor start and end positions.\n  The table will be converted to one single column where each current column will become a row, then stacked.\n\n- `print_only`:\n  Do not show this portion of the HTML in the responsive signing view.\n\n\n"
          type: string
        displayLabel:
          description: 'The label to add to this display section in the signing page.

            '
          type: string
        displayOrder:
          format: int32
          description: The position on the page where the display section appears.
          type: integer
        displayPageNumber:
          format: int32
          description: The number of the page on which the display section appears.
          type: integer
        hideLabelWhenOpened:
          description: 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`.
          type: boolean
        inlineOuterStyle:
          description: 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`.
          type: string
        labelWhenOpened:
          description: 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`.
          type: string
        preLabel:
          description: Enables you to add descriptive text that appears before a collapsed section or continue button.
          type: string
        scrollToTopWhenOpened:
          description: 'When **true** and the section is expanded,

            the position of the section-close control

            scrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`.

            '
          type: boolean
        tableStyle:
          description: 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`.
          type: string
      x-ds-definition-name: documentHtmlDisplaySettings
      description: 'This object defines how to display the HTML

        between the `startAnchor` and `endAnchor`.'
      x-ms-summary: 'This object defines how to display the HTML

        between the `startAnchor` and `endAnchor`.'
    documentHtmlDefinitionOriginal_2:
      type: object
      properties:
        documentId:
          description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
          type: string
        documentIdGuid:
          description: The GUID of the document.
          type: string
        htmlDefinition:
          $ref: '#/components/schemas/documentHtmlDefinition_2'
          description: Defines how to generate the responsive-formatted HTML for the document.
      x-ds-definition-name: documentHtmlDefinitionOriginal
      description: ''
      x-ms-summary: ''
    documentHtmlCollapsibleDisplaySettings_2:
      type: object
      properties:
        arrowClosed:
          description: 'Indicates the direction of the disclosure arrow

            when the collapsible section is in the closed state.


            One of the following:


            - `up`: In the closed state, the disclosure arrow points up.

            - `down`: In the closed state, the disclosure arrow points down.

            - `left`: In the closed state, the disclosure arrow points left.

            - `right`: In the closed state, the disclosure arrow points right.

            '
          type: string
        arrowColor:
          description: 'A CSS color value (such as `#DCF851`) that indicates the color of the arrow.

            '
          type: string
        arrowLocation:
          description: 'The location of the arrow relative to the collapsible section''s label. Possible values are:


            - `right` (default)

            - `left`

            '
          type: string
        arrowOpen:
          description: 'Indicates the direction of the disclosure arrow

            when the collapsible section is in the open state.


            One of the following:


            - `up`: In the open state, the disclosure arrow points up.

            - `down`: In the open state, the disclosure arrow points down.

            - `left`: In the open state, the disclosure arrow points left.

            - `right`: In the open state, the disclosure arrow points right.

            '
          type: string
        arrowSize:
          description: 'Indicates the size of the collapsible arrows. Possible values are:


            - `small`

            - `large` (default)

            '
          type: string
        arrowStyle:
          description: 'The name of the CSS style to be used on collapsible arrow section.

            '
          type: string
        containerStyle:
          description: 'The name of the CSS style to be used for the collapsible container.

            '
          type: string
        labelStyle:
          description: The name of the CSS style to be used for the collapsible container's label.
          type: string
        onlyArrowIsClickable:
          description: 'When **true,** only the arrow is clickable to expand or collapse the section.

            When **false** (the default), both the label and the arrow are clickable.


            If no arrow is used, this setting is ignored.

            '
          type: boolean
        outerLabelAndArrowStyle:
          description: The name of the CSS style to be used for the collapsible container's outer label and arrow style.
          type: string
      description: Display settings for collapsible section.
      x-ds-definition-name: documentHtmlCollapsibleDisplaySettings
      x-ms-summary: Display settings for collapsible section.
    documentHtmlDefinition_2:
      type: object
      properties:
        displayAnchorPrefix:
          description: Contains text that all display anchors must start with. Using at least four characters will improve anchor processing performance.
          type: string
        displayAnchors:
          description: 'An object that defines how to handle a section of the HTML in signing. This property enables an incoming request to make a section of the HTML collapsible and expandable or hidden from view.


            A start anchor, end anchor, or both are required.

            If the anchors are not found, the display anchor will be ignored.


            For a list of the available types, see the

            [`display` property](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings_display)

            of the

            [`displaySettings` object.](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings)'
          type: array
          items:
            $ref: '#/components/schemas/documentHtmlDisplayAnchor_2'
        displayOrder:
          description: The position on the page where the display section appears.
          type: string
        displayPageNumber:
          description: The number of the page on which the display section appears.
          type: string
        documentGuid:
          description: The GUID of the document.
          type: string
        documentId:
          description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
          type: string
        headerLabel:
          description: Header text or an HTML tag to place above the responsive HTML block.
          type: string
        maxScreenWidth:
          description: '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.

            '
          type: string
        removeEmptyTags:
          description: Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).
          type: string
        showMobileOptimizedToggle:
          description: '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.

            '
          type: string
        source:
          description: '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](/docs/esign-rest-api/how-to/creating-signable-html/)

            - [How to convert a PDF file into a signable HTML document](/docs/esign-rest-api/how-to/converting-pdf/)

            - [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/)



            [smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html'
          type: string
      description: 'Holds the properties that define how to generate the responsive-formatted HTML for the document.

        See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/)

        in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/).'
      x-ds-definition-name: documentHtmlDefinition
      x-ms-summary: 'Holds the properties that define how to generate the responsive-formatted HTML for the document.

        See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/)

        in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/).'
x-refined-from:
- docusign-openapi-original.yml
- docusign-openapi.json
x-ds-categories:
- name: UserManagement
  summary: Methods to manage users in an account.
  description: Methods to manage users in an account.
- name: BulkOperations
  summary: Methods to import and export users and accounts.
  description: Methods to import and export users and accounts.
- name: IdentityProviders
  summary: Methods to get a list of identity providers.
  description: Methods to get a list of identity providers.
- name: ReservedDomains
  summary: Methods to get a list of reserved domains.
  description: Methods to get a list of reserved domains.
- name: Organization
  summary: Methods for working with organizations.
  description: Methods for working with organizations.
x-original-swagger-version: '2.0'