> ## Documentation Index
> Fetch the complete documentation index at: https://signatureapi-daf4ee54.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Multi-Line Text Input Place

> Collect longer text from recipients during signing with multi-line input fields

A **multi-line text input place** marks a location in a document where a recipient enters text that spans multiple lines. Unlike [text input places](/docs/api/resources/places/text-input), which are single-line fields, multi-line text input places support multiple lines of text. Use them for comments, addresses, descriptions, or any input that may span several lines.

<Note>Multi-line text input places are only available in envelopes with sequential signing.</Note>

You can position multi-line text input places using either [placeholders](/docs/api/resources/places/positioning/#placeholders) or [fixed positions](/docs/api/resources/places/positioning/#fixed-positions).

## Hints and Prompts

Use `hint` and `prompt` to guide recipients while they fill out the field.

* **`hint`**: A tooltip shown when the recipient hovers over or focuses on the field.
* **`prompt`**: Placeholder text displayed inside the field. It disappears when the recipient starts typing.

```json theme={null}
{
  //...
  "hint": "Describe the reason for this request",
  "prompt": "Enter your comments here..."
  //...
}
```

## Capturing Input

Set `capture_as` to store the entered value in the envelope's `captures` object. After the envelope is completed, retrieve the value using the key you specified.

## Size and Appearance

* **`width`**: The width of the field in points (1/72 inch). Must be between 30 and 540.
* **`line_count`**: The number of visible lines. Required. Must be between 1 and 100.
* **`line_height`**: The vertical spacing between lines in points. Must be between 6 and 72. Must be greater than or equal to `font_size`. Defaults to 12.
* **`font_size`**: The text size inside the field, in points. Must be between 6 and 12. Defaults to 12.

## Attributes

<ParamField body="type" type="enum" required={true}>
  Specifies the type of place.

  For a multi-line text input place, the value must be `multiline_text_input`.
</ParamField>

<ParamField body="key" type="string" required={true}>
  A unique identifier for this place within the document. Use this key to match the place to its position, either through a `[[place_key]]` placeholder in the document or an entry in `fixed_positions`.

  Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.
</ParamField>

<ParamField body="recipient_key" type="string" required={true}>
  The key of the recipient assigned to this place. Must match one of the `key` values in the envelope's `recipients` array.
</ParamField>

<ParamField body="capture_as" type="string">
  A key that stores the recipient's input in the envelope's `captures` object. When set, the value entered or selected by the recipient is saved under this key after the envelope is completed.

  Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters. Set to `null` to disable capture.
</ParamField>

<ParamField body="hint" type="string">
  A tooltip message displayed over the input text field during the signing ceremony.

  Learn more in [Hints and Prompts](/docs/api/resources/places/multiline-text-input#hints-and-prompts).
</ParamField>

<ParamField body="prompt" type="string">
  A placeholder message shown inside the input text field during the signing ceremony.

  Learn more in [Hints and Prompts](/docs/api/resources/places/multiline-text-input#hints-and-prompts).
</ParamField>

<ParamField body="requirement" type="enum">
  Specifies whether the recipient must fill this field to complete the signing ceremony.

  Possible values are `required` or `optional`. The default is `required`.
</ParamField>

<ParamField body="width" type="number" required={true}>
  The width of the multi-line text input place in <Tooltip tip="1/72th of an inch">points</Tooltip>.

  Must be between 30 and 540. The default is 30.
</ParamField>

<ParamField body="line_count" type="integer" required={true}>
  The number of lines for the multi-line text input field.

  Must be between 1 and 100.
</ParamField>

<ParamField body="line_height" type="number">
  The line height in <Tooltip tip="1/72th of an inch">points</Tooltip>. Must be greater than or equal to `font_size`.

  Must be between 6 and 72. The default is 12.
</ParamField>

<ParamField body="font_size" type="number">
  The font size in <Tooltip tip="1/72th of an inch">points</Tooltip>.

  Must be between 6 and 12. The default is 12.
</ParamField>

## Examples

<CodeGroup>
  ```json Comments Field theme={null}
  "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
        }
      ]
      //...
    }
  ]
  ```

  ```json Mailing Address theme={null}
  "documents": [
    {
      //...
      "places": [
        {
          "key": "full_address",
          "type": "multiline_text_input",
          "recipient_key": "applicant",
          "capture_as": "mailing_address",
          "prompt": "Enter your complete mailing address",
          "requirement": "required",
          "width": 350,
          "line_count": 3
        }
      ]
      //...
    }
  ]
  ```

  ```json Reason for Request theme={null}
  "documents": [
    {
      //...
      "places": [
        {
          "key": "request_reason",
          "type": "multiline_text_input",
          "recipient_key": "requester",
          "capture_as": "reason",
          "hint": "Describe why this request is needed",
          "requirement": "required",
          "width": 450,
          "line_count": 4,
          "font_size": 10
        }
      ]
      //...
    }
  ]
  ```
</CodeGroup>