---
title: "Multi-Line Text Input Place"
description: "Collect longer text from recipients during signing with multi-line input fields"
canonical: "https://signatureapi.com/docs/api/resources/places/multiline-text-input"
source: "https://signatureapi.com/docs/api/resources/places/multiline-text-input.md"
last_verified_api_version: "1.18.0"
last_modified: "2026-11-18T11:48:11Z"
---

# Multi-Line Text Input Place

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

_Last verified against API version 1.18.0._

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](https://signatureapi.com/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.

You can position multi-line text input places using either [placeholders](https://signatureapi.com/docs/api/resources/places/positioning/#placeholders) or [fixed positions](https://signatureapi.com/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
{
  "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.

The field is `line_count` × `line_height` points tall. At 12 points a line holds roughly `width / 6` characters of average text; check long values in a test envelope.

## Attributes

#### `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 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.

#### `recipient_key` (string, required)

The key of the recipient assigned to this place. Must match one of the `key` values in the envelope's `recipients` array.

#### `capture_as` (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.

#### `hint` (string)

A tooltip message displayed over the input text field during the signing ceremony.

Learn more in [Hints and Prompts](https://signatureapi.com/docs/api/resources/places/multiline-text-input#hints-and-prompts).

#### `prompt` (string)

A placeholder message shown inside the input text field during the signing ceremony.

Learn more in [Hints and Prompts](https://signatureapi.com/docs/api/resources/places/multiline-text-input#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 points.

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 points. 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 points.

Must be between 6 and 12. The default is 12.

## Examples

#### Comments Field

```json
{
  "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
}
```

#### Mailing Address

```json
{
  "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
}
```

#### Reason for Request

```json
{
  "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
}
```
