| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
Survey ID |
integer |
Required |
| Header |
Survey title |
string |
String length: inclusive between 0 and 150 |
| Keyword |
Survey keyword |
string |
Matching regular expression pattern: ^\S+$ String length: inclusive between 0 and 15 |
| KeywordResponse |
If you have a virtual phone number and recieve an SMS beginning with the value of the keyword property this string will be sent as a response. |
string |
None. |
| WelcomeText |
Survey introduction text |
string |
None. |
| ThankYouText |
Survey completed text |
string |
None. |
| AllowAnonymous |
Whether to enable recipients to remain anonymous |
boolean |
Required |
| TextColor |
Color of survey text, hexadecimal (ex. #333333) |
string |
Matching regular expression pattern: ^#([A-Fa-f0-9]{6})$ |
| BackgroundColor |
Color of survey background, hexadecimal (ex. #eeeeee) |
string |
Matching regular expression pattern: ^#([A-Fa-f0-9]{6})$ |
| ButtonColor |
Color of survey buttons, hexadecimal (ex. #a1c775) |
string |
Matching regular expression pattern: ^#([A-Fa-f0-9]{6})$ |
| AlarmRecipient |
Phone number that alarms should be sent to when triggered |
string |
None. |
| Name |
Survey name |
string |
Required String length: inclusive between 0 and 150 |
| Ends |
Timestamp for survey end, or null if not set |
date |
None. |