# PromptInput

An input a run is started with, filled into the interaction's prompt wherever it says `%%name%%`.

**Kind:** an object, used in requests and responses. In a request it is called `PromptInputInput`.

## In a request

| Field | Type | Required | Description |
|---|---|---|---|
| `dataType` | [`InteractionInputType`](https://docs.maitento.com/reference/types/interaction-input-type.md) |  | The type of value the input takes. |
| `name` | `string` | yes | The input's name: a run gives the input's value under this name. Constraints: required (empty or whitespace-only strings are rejected). |
| `description` | `string \| null` |  | What the input is for, shown to whoever starts a run. Constraints: minLength: 1. |
| `isRequired` | `boolean` |  | Whether a run must give the input. A run started without a required input is refused. |

```json
{
  "dataType": "String",
  "name": "...",
  "description": "...",
  "isRequired": false
}
```

## In a response

Every field is present in a response; empty ones are `null`.

| Field | Type | Description |
|---|---|---|
| `dataType` | [`InteractionInputType`](https://docs.maitento.com/reference/types/interaction-input-type.md) | The type of value the input takes. |
| `name` | `string` | The input's name: a run gives the input's value under this name. Constraints: required (empty or whitespace-only strings are rejected). |
| `description` | `string \| null` | What the input is for, shown to whoever starts a run. Constraints: minLength: 1. |
| `isRequired` | `boolean` | Whether a run must give the input. A run started without a required input is refused. |

```json
{
  "dataType": "String",
  "name": "...",
  "description": "...",
  "isRequired": false
}
```

## Where it's used

- Inside [`CodePipelineCreateRequest`](https://docs.maitento.com/reference/types/code-pipeline-create-request.md)
- Inside [`CodePipelineUpdateRequest`](https://docs.maitento.com/reference/types/code-pipeline-update-request.md)
- Inside [`CodePipelineVersion`](https://docs.maitento.com/reference/types/code-pipeline-version.md)
- Inside [`ManagedInteractionCreateRequest`](https://docs.maitento.com/reference/types/managed-interaction-create-request.md)
- Inside [`ManagedInteractionUpdateRequest`](https://docs.maitento.com/reference/types/managed-interaction-update-request.md)
- Inside [`ManagedInteractionVersion`](https://docs.maitento.com/reference/types/managed-interaction-version.md)
- Inside [`OneShotInteractionCreateRequest`](https://docs.maitento.com/reference/types/one-shot-interaction-create-request.md)
- Inside [`OneShotInteractionUpdateRequest`](https://docs.maitento.com/reference/types/one-shot-interaction-update-request.md)
- Inside [`OneShotInteractionVersion`](https://docs.maitento.com/reference/types/one-shot-interaction-version.md)
- Inside [`RoundRobinInteractionCreateRequest`](https://docs.maitento.com/reference/types/round-robin-interaction-create-request.md)
- Inside [`RoundRobinInteractionUpdateRequest`](https://docs.maitento.com/reference/types/round-robin-interaction-update-request.md)
- Inside [`RoundRobinInteractionVersion`](https://docs.maitento.com/reference/types/round-robin-interaction-version.md)