---
schema_version: "1"
id: 1efbb48dcbd8a9ff298f9b4faa1e6819581b402d01eafa3e52180a522c0db73b
title: FormMessage
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/service-cloud/messaging-api/references/message-types-payloads-formmessage.md
canonical_url: https://developer.salesforce.com/docs/service/messaging-api/references/about/message-types-payloads-formmessage.html
source_site: developer.salesforce.com
content_type: documentation
content_hash: def4d9f42b3ecd23f51ccafc94cd551fc2e60426f87bd564400822653f76628f
products:
  - Enhanced Chat API
  - Service Cloud Developer Content
---
# FormMessage

The FormMessage message type supports the Inputs format type. See [Format Types](https://developer.salesforce.com/docs/service/messaging-api/references/about/message-types-format-types.md#format-types) for a list of supported message types and the format types they support.

## Inputs

```json
{
    "entryType": "Message",
    "id": "412c0379-ea42-4549-8338-a98f897bdb13",
    "abstractMessage": {
        "messageType": "FormMessage",
        "inReplyToMessageId": null,
        "id": "412c0379-ea42-4549-8338-a98f897bdb13",
        "references": null,
        "form": {
            "formatType": "Inputs",
            "formTitle": {
                "itemType": "TitleItem",
                "secondarySubTitle": null,
                "title": "Please fill out this form",
                "subTitle": null,
                "tertiarySubTitle": null,
                "referenceId": null
            },
            "introScreen": null,
            "images": [],
            "message": {
                "itemType": "TitleItem",
                "secondarySubTitle": null,
                "title": "Please fill out this form",
                "subTitle": null,
                "tertiarySubTitle": null,
                "referenceId": null
            },
            "reply": {
                "itemType": "TitleItem",
                "secondarySubTitle": null,
                "title": "Please fill out this form",
                "subTitle": null,
                "tertiarySubTitle": null,
                "referenceId": null
            },
            "sections": [
                {
                    "sectionType": "SingleInputSection",
                    "nextSectionInputId": "4",
                    "input": {
                        "inputType": "TextInput",
                        "id": "1",
                        "label": {
                            "itemType": "TitleItem",
                            "secondarySubTitle": null,
                            "title": "Secure Form Name",
                            "subTitle": null,
                            "tertiarySubTitle": null,
                            "referenceId": null
                        },
                        "hintText": null,
                        "required": true,
                        "regEx": null,
                        "prefixText": null,
                        "maximumCharacterCount": 80,
                        "keyboardType": null,
                        "textInputType": "Singleline",
                        "textContentType": null,
                        "placeholder": null
                    },
                    "submitForm": null
                },
                {
                    "sectionType": "SingleInputSection",
                    "nextSectionInputId": "3",
                    "input": {
                        "inputType": "TextInput",
                        "id": "4",
                        "label": {
                            "itemType": "TitleItem",
                            "secondarySubTitle": null,
                            "title": "Text",
                            "subTitle": null,
                            "tertiarySubTitle": null,
                            "referenceId": null
                        },
                        "hintText": null,
                        "required": false,
                        "regEx": null,
                        "prefixText": null,
                        "maximumCharacterCount": 100,
                        "keyboardType": null,
                        "textInputType": "Singleline",
                        "textContentType": null,
                        "placeholder": null
                    },
                    "submitForm": null
                },
                {
                    "sectionType": "SingleInputSection",
                    "nextSectionInputId": "5",
                    "input": {
                        "inputType": "TextInput",
                        "id": "3",
                        "label": {
                            "itemType": "TitleItem",
                            "secondarySubTitle": null,
                            "title": "Text Area",
                            "subTitle": null,
                            "tertiarySubTitle": null,
                            "referenceId": null
                        },
                        "hintText": null,
                        "required": false,
                        "regEx": null,
                        "prefixText": null,
                        "maximumCharacterCount": 255,
                        "keyboardType": null,
                        "textInputType": "Multiline",
                        "textContentType": null,
                        "placeholder": null
                    },
                    "submitForm": null
                },
                {
                    "sectionType": "SingleInputSection",
                    "nextSectionInputId": "6",
                    "input": {
                        "inputType": "TextInput",
                        "id": "5",
                        "label": {
                            "itemType": "TitleItem",
                            "secondarySubTitle": null,
                            "title": "URL",
                            "subTitle": null,
                            "tertiarySubTitle": null,
                            "referenceId": null
                        },
                        "hintText": null,
                        "required": false,
                        "regEx": null,
                        "prefixText": null,
                        "maximumCharacterCount": null,
                        "keyboardType": "URL",
                        "textInputType": "Singleline",
                        "textContentType": "URL",
                        "placeholder": null
                    },
                    "submitForm": null
                },
                {
                    "sectionType": "SingleInputSection",
                    "nextSectionInputId": "2",
                    "input": {
                        "inputType": "TextInput",
                        "id": "6",
                        "label": {
                            "itemType": "TitleItem",
                            "secondarySubTitle": null,
                            "title": "Phone",
                            "subTitle": null,
                            "tertiarySubTitle": null,
                            "referenceId": null
                        },
                        "hintText": null,
                        "required": false,
                        "regEx": null,
                        "prefixText": null,
                        "maximumCharacterCount": null,
                        "keyboardType": "PhonePad",
                        "textInputType": "Singleline",
                        "textContentType": "TelephoneNumber",
                        "placeholder": null
                    },
                    "submitForm": null
                },
                {
                    "sectionType": "SingleInputSection",
                    "nextSectionInputId": "7",
                    "input": {
                        "inputType": "TextInput",
                        "id": "2",
                        "label": {
                            "itemType": "TitleItem",
                            "secondarySubTitle": null,
                            "title": "Email",
                            "subTitle": null,
                            "tertiarySubTitle": null,
                            "referenceId": null
                        },
                        "hintText": null,
                        "required": true,
                        "regEx": null,
                        "prefixText": null,
                        "maximumCharacterCount": null,
                        "keyboardType": "EmailAddress",
                        "textInputType": "Singleline",
                        "textContentType": "EmailAddress",
                        "placeholder": null
                    },
                    "submitForm": null
                },
                {
                    "sectionType": "SingleInputSection",
                    "nextSectionInputId": "8",
                    "input": {
                        "inputType": "SelectInput",
                        "id": "7",
                        "label": {
                            "itemType": "TitleItem",
                            "secondarySubTitle": null,
                            "title": "Single Select",
                            "subTitle": null,
                            "tertiarySubTitle": null,
                            "referenceId": null
                        },
                        "hintText": null,
                        "required": false,
                        "multipleSelection": false,
                        "optionItems": [
                            {
                                "itemType": "TitleOptionItem",
                                "titleItem": {
                                    "itemType": "TitleItem",
                                    "secondarySubTitle": null,
                                    "title": "Option 1",
                                    "subTitle": null,
                                    "tertiarySubTitle": null,
                                    "referenceId": null
                                },
                                "optionIdentifier": "7-1",
                                "optionId": null
                            },
                            {
                                "itemType": "TitleOptionItem",
                                "titleItem": {
                                    "itemType": "TitleItem",
                                    "secondarySubTitle": null,
                                    "title": "Option 2",
                                    "subTitle": null,
                                    "tertiarySubTitle": null,
                                    "referenceId": null
                                },
                                "optionIdentifier": "7-2",
                                "optionId": null
                            }
                        ]
                    },
                    "submitForm": null
                },
                {
                    "sectionType": "SingleInputSection",
                    "nextSectionInputId": null,
                    "input": {
                        "inputType": "SelectInput",
                        "id": "8",
                        "label": {
                            "itemType": "TitleItem",
                            "secondarySubTitle": null,
                            "title": "Multiselect",
                            "subTitle": null,
                            "tertiarySubTitle": null,
                            "referenceId": null
                        },
                        "hintText": null,
                        "required": false,
                        "multipleSelection": true,
                        "optionItems": [
                            {
                                "itemType": "TitleOptionItem",
                                "titleItem": {
                                    "itemType": "TitleItem",
                                    "secondarySubTitle": null,
                                    "title": "Option 1",
                                    "subTitle": null,
                                    "tertiarySubTitle": null,
                                    "referenceId": null
                                },
                                "optionIdentifier": "8-1",
                                "optionId": null
                            },
                            {
                                "itemType": "TitleOptionItem",
                                "titleItem": {
                                    "itemType": "TitleItem",
                                    "secondarySubTitle": null,
                                    "title": "Option 2",
                                    "subTitle": null,
                                    "tertiarySubTitle": null,
                                    "referenceId": null
                                },
                                "optionIdentifier": "8-2",
                                "optionId": null
                            },
                            {
                                "itemType": "TitleOptionItem",
                                "titleItem": {
                                    "itemType": "TitleItem",
                                    "secondarySubTitle": null,
                                    "title": "Option 3",
                                    "subTitle": null,
                                    "tertiarySubTitle": null,
                                    "referenceId": null
                                },
                                "optionIdentifier": "8-3",
                                "optionId": null
                            },
                            {
                                "itemType": "TitleOptionItem",
                                "titleItem": {
                                    "itemType": "TitleItem",
                                    "secondarySubTitle": null,
                                    "title": "Option 4",
                                    "subTitle": null,
                                    "tertiarySubTitle": null,
                                    "referenceId": null
                                },
                                "optionIdentifier": "8-4",
                                "optionId": null
                            }
                        ]
                    },
                    "submitForm": true
                }
            ]
        }
    },
    "messageReason": null
}
```