FormMessage

The FormMessage message type supports the Inputs format type. See Format Types for a list of supported message types and the format types they support.

Inputs 

Sample Payload
1{
2    "entryType": "Message",
3    "id": "412c0379-ea42-4549-8338-a98f897bdb13",
4    "abstractMessage": {
5        "messageType": "FormMessage",
6        "inReplyToMessageId": null,
7        "id": "412c0379-ea42-4549-8338-a98f897bdb13",
8        "references": null,
9        "form": {
10            "formatType": "Inputs",
11            "formTitle": {
12                "itemType": "TitleItem",
13                "secondarySubTitle": null,
14                "title": "Please fill out this form",
15                "subTitle": null,
16                "tertiarySubTitle": null,
17                "referenceId": null
18            },
19            "introScreen": null,
20            "images": [],
21            "message": {
22                "itemType": "TitleItem",
23                "secondarySubTitle": null,
24                "title": "Please fill out this form",
25                "subTitle": null,
26                "tertiarySubTitle": null,
27                "referenceId": null
28            },
29            "reply": {
30                "itemType": "TitleItem",
31                "secondarySubTitle": null,
32                "title": "Please fill out this form",
33                "subTitle": null,
34                "tertiarySubTitle": null,
35                "referenceId": null
36            },
37            "sections": [
38                {
39                    "sectionType": "SingleInputSection",
40                    "nextSectionInputId": "4",
41                    "input": {
42                        "inputType": "TextInput",
43                        "id": "1",
44                        "label": {
45                            "itemType": "TitleItem",
46                            "secondarySubTitle": null,
47                            "title": "Secure Form Name",
48                            "subTitle": null,
49                            "tertiarySubTitle": null,
50                            "referenceId": null
51                        },
52                        "hintText": null,
53                        "required": true,
54                        "regEx": null,
55                        "prefixText": null,
56                        "maximumCharacterCount": 80,
57                        "keyboardType": null,
58                        "textInputType": "Singleline",
59                        "textContentType": null,
60                        "placeholder": null
61                    },
62                    "submitForm": null
63                },
64                {
65                    "sectionType": "SingleInputSection",
66                    "nextSectionInputId": "3",
67                    "input": {
68                        "inputType": "TextInput",
69                        "id": "4",
70                        "label": {
71                            "itemType": "TitleItem",
72                            "secondarySubTitle": null,
73                            "title": "Text",
74                            "subTitle": null,
75                            "tertiarySubTitle": null,
76                            "referenceId": null
77                        },
78                        "hintText": null,
79                        "required": false,
80                        "regEx": null,
81                        "prefixText": null,
82                        "maximumCharacterCount": 100,
83                        "keyboardType": null,
84                        "textInputType": "Singleline",
85                        "textContentType": null,
86                        "placeholder": null
87                    },
88                    "submitForm": null
89                },
90                {
91                    "sectionType": "SingleInputSection",
92                    "nextSectionInputId": "5",
93                    "input": {
94                        "inputType": "TextInput",
95                        "id": "3",
96                        "label": {
97                            "itemType": "TitleItem",
98                            "secondarySubTitle": null,
99                            "title": "Text Area",
100                            "subTitle": null,
101                            "tertiarySubTitle": null,
102                            "referenceId": null
103                        },
104                        "hintText": null,
105                        "required": false,
106                        "regEx": null,
107                        "prefixText": null,
108                        "maximumCharacterCount": 255,
109                        "keyboardType": null,
110                        "textInputType": "Multiline",
111                        "textContentType": null,
112                        "placeholder": null
113                    },
114                    "submitForm": null
115                },
116                {
117                    "sectionType": "SingleInputSection",
118                    "nextSectionInputId": "6",
119                    "input": {
120                        "inputType": "TextInput",
121                        "id": "5",
122                        "label": {
123                            "itemType": "TitleItem",
124                            "secondarySubTitle": null,
125                            "title": "URL",
126                            "subTitle": null,
127                            "tertiarySubTitle": null,
128                            "referenceId": null
129                        },
130                        "hintText": null,
131                        "required": false,
132                        "regEx": null,
133                        "prefixText": null,
134                        "maximumCharacterCount": null,
135                        "keyboardType": "URL",
136                        "textInputType": "Singleline",
137                        "textContentType": "URL",
138                        "placeholder": null
139                    },
140                    "submitForm": null
141                },
142                {
143                    "sectionType": "SingleInputSection",
144                    "nextSectionInputId": "2",
145                    "input": {
146                        "inputType": "TextInput",
147                        "id": "6",
148                        "label": {
149                            "itemType": "TitleItem",
150                            "secondarySubTitle": null,
151                            "title": "Phone",
152                            "subTitle": null,
153                            "tertiarySubTitle": null,
154                            "referenceId": null
155                        },
156                        "hintText": null,
157                        "required": false,
158                        "regEx": null,
159                        "prefixText": null,
160                        "maximumCharacterCount": null,
161                        "keyboardType": "PhonePad",
162                        "textInputType": "Singleline",
163                        "textContentType": "TelephoneNumber",
164                        "placeholder": null
165                    },
166                    "submitForm": null
167                },
168                {
169                    "sectionType": "SingleInputSection",
170                    "nextSectionInputId": "7",
171                    "input": {
172                        "inputType": "TextInput",
173                        "id": "2",
174                        "label": {
175                            "itemType": "TitleItem",
176                            "secondarySubTitle": null,
177                            "title": "Email",
178                            "subTitle": null,
179                            "tertiarySubTitle": null,
180                            "referenceId": null
181                        },
182                        "hintText": null,
183                        "required": true,
184                        "regEx": null,
185                        "prefixText": null,
186                        "maximumCharacterCount": null,
187                        "keyboardType": "EmailAddress",
188                        "textInputType": "Singleline",
189                        "textContentType": "EmailAddress",
190                        "placeholder": null
191                    },
192                    "submitForm": null
193                },
194                {
195                    "sectionType": "SingleInputSection",
196                    "nextSectionInputId": "8",
197                    "input": {
198                        "inputType": "SelectInput",
199                        "id": "7",
200                        "label": {
201                            "itemType": "TitleItem",
202                            "secondarySubTitle": null,
203                            "title": "Single Select",
204                            "subTitle": null,
205                            "tertiarySubTitle": null,
206                            "referenceId": null
207                        },
208                        "hintText": null,
209                        "required": false,
210                        "multipleSelection": false,
211                        "optionItems": [
212                            {
213                                "itemType": "TitleOptionItem",
214                                "titleItem": {
215                                    "itemType": "TitleItem",
216                                    "secondarySubTitle": null,
217                                    "title": "Option 1",
218                                    "subTitle": null,
219                                    "tertiarySubTitle": null,
220                                    "referenceId": null
221                                },
222                                "optionIdentifier": "7-1",
223                                "optionId": null
224                            },
225                            {
226                                "itemType": "TitleOptionItem",
227                                "titleItem": {
228                                    "itemType": "TitleItem",
229                                    "secondarySubTitle": null,
230                                    "title": "Option 2",
231                                    "subTitle": null,
232                                    "tertiarySubTitle": null,
233                                    "referenceId": null
234                                },
235                                "optionIdentifier": "7-2",
236                                "optionId": null
237                            }
238                        ]
239                    },
240                    "submitForm": null
241                },
242                {
243                    "sectionType": "SingleInputSection",
244                    "nextSectionInputId": null,
245                    "input": {
246                        "inputType": "SelectInput",
247                        "id": "8",
248                        "label": {
249                            "itemType": "TitleItem",
250                            "secondarySubTitle": null,
251                            "title": "Multiselect",
252                            "subTitle": null,
253                            "tertiarySubTitle": null,
254                            "referenceId": null
255                        },
256                        "hintText": null,
257                        "required": false,
258                        "multipleSelection": true,
259                        "optionItems": [
260                            {
261                                "itemType": "TitleOptionItem",
262                                "titleItem": {
263                                    "itemType": "TitleItem",
264                                    "secondarySubTitle": null,
265                                    "title": "Option 1",
266                                    "subTitle": null,
267                                    "tertiarySubTitle": null,
268                                    "referenceId": null
269                                },
270                                "optionIdentifier": "8-1",
271                                "optionId": null
272                            },
273                            {
274                                "itemType": "TitleOptionItem",
275                                "titleItem": {
276                                    "itemType": "TitleItem",
277                                    "secondarySubTitle": null,
278                                    "title": "Option 2",
279                                    "subTitle": null,
280                                    "tertiarySubTitle": null,
281                                    "referenceId": null
282                                },
283                                "optionIdentifier": "8-2",
284                                "optionId": null
285                            },
286                            {
287                                "itemType": "TitleOptionItem",
288                                "titleItem": {
289                                    "itemType": "TitleItem",
290                                    "secondarySubTitle": null,
291                                    "title": "Option 3",
292                                    "subTitle": null,
293                                    "tertiarySubTitle": null,
294                                    "referenceId": null
295                                },
296                                "optionIdentifier": "8-3",
297                                "optionId": null
298                            },
299                            {
300                                "itemType": "TitleOptionItem",
301                                "titleItem": {
302                                    "itemType": "TitleItem",
303                                    "secondarySubTitle": null,
304                                    "title": "Option 4",
305                                    "subTitle": null,
306                                    "tertiarySubTitle": null,
307                                    "referenceId": null
308                                },
309                                "optionIdentifier": "8-4",
310                                "optionId": null
311                            }
312                        ]
313                    },
314                    "submitForm": true
315                }
316            ]
317        }
318    },
319    "messageReason": null
320}