Skip to main content
Multi-line text input places allow you to collect longer text from recipients during the signing ceremony. Unlike text input places, which are single-line fields, multi-line text input places support multiple lines of text, making them suitable for comments, addresses, descriptions, or any input that may span several lines.
Multi-line text input places are only available in envelopes with sequential signing.
You can position Multi-Line Text Input Places inside a document using either fixed positions or placeholders.

​
Hints and Prompts

You can use hint and prompt properties to guide recipients while filling out multi-line text fields:
  • Hint: A message shown as a tooltip when the user hovers over or focuses on the text field. Set it using the hint property.
  • Prompt: A placeholder-style message displayed inside the text field. Set it using the prompt property.
For example, a multi-line text input place configured with the following properties: 
{
  //...
  "hint": "Describe the reason for this request",
  "prompt": "Enter your comments here..."
  //...
}

​
Size and Appearance

You can customize the size and appearance of multi-line text input places to better fit your document layout:

​
Width

The width property sets the width of the text input area in points (1/72 of an inch).

​
Line Count

The line_count property determines how many lines the input area displays. This is a required property.

​
Line Height

The line_height property sets the vertical spacing between lines in points. The default is 12 points. Must be greater than or equal to font_size.

​
Font Size

The font_size property controls the size of the text displayed within the input field, measured in points. The default font size is 12 points.

​
Examples

The following examples show different ways to configure multi-line text input places. 
"documents":
[
  {
    //...
    "places": [
      {
        "key": "customer_comments",
        "type": "multiline_text_input",
        "recipient_key": "customer",
        "capture_as": "comments",
        "prompt": "Enter your comments here...",
        "hint": "Please provide detailed feedback",
        "requirement": "optional",
        "width": 400,
        "line_count": 5,
        "line_height": 14,
        "font_size": 10
      }
    ]
    //...
  }
]

​
Parameters

​
type
enum
required
Specifies the type of place.For a multi-line text input place, the value must be multiline_text_input.
​
key
string
required
A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
​
recipient_key
string
required
A user-provided key that identifies a recipient within an envelope.It must match one of the recipient.key values in the envelope’s recipient list.
​
capture_as
string
A user-defined identifier used to store the value entered by the recipient. This value will be included in the captures object of the Envelope.Must start with a lowercase letter and contain only lowercase letters, numbers, or underscores. Maximum length is 32.
​
hint
string
A tooltip message displayed over the input text field during the signing ceremony.Learn more in Hints and Prompts.
​
prompt
string
A placeholder message shown inside the input text field during the signing ceremony.Learn more in Hints and Prompts.
​
requirement
enum
Specifies whether the recipient must fill this field to complete the signing ceremony.Possible values are required or optional. The default is required.
​
width
number
required
The width of the multi-line text input place in .Must be between 30 and 540. The default is 30.
​
line_count
integer
required
The number of lines for the multi-line text input field.Must be between 1 and 100.
​
line_height
number
The line height in . Must be greater than or equal to font_size.Must be between 6 and 72. The default is 12.
​
font_size
number
The font size in .Must be between 6 and 12. The default is 12.