CreateOptInMessage
Creates an SMS opt-in message permitting contacts to subscribe to further SMS messages.
Input
| Name | Type | Required | Description |
| LongCode | String | False | Long code that the message will be created on. Either long code or short code is required. |
| ShortCode | String | False | Short code that the message will be created on. Either long code or short code is required. |
| MessageName | String | True | Name of the message. |
| MessageText | String | False | Text of the message. |
| CountryCode | String | False | Two-letter country code specifying the country that the short code belongs to. Required for short code. |
| Keyword | String | True | Keyword to which users are subscribed |
| MessageOptInType | String | True | Opt-in template: Single, Double, or Age. Single opt-in requires users to text one keyword (e.g., JOIN) to opt in. Double opt-in requires users to text in a second keyword (e.g., Y or YES) to confirm opt in. Age means double opt-in with age confirmation. It requires users to text in their age after texting JOIN. If age is above the minimum, the user is opted in. |
| ResponseMessage | String | False | Response sent to users after they text in the keyword for Single. Required for Single. Not used for Double or Age. |
| DoubleOptInInitialMessage | String | False | Response sent to users that asks for confirmation of opt-in (for Double) or for their age (for Age). Required for Double and Age. Not used for Single. |
| DoubleOptInConfirmationMessage | String | False | Response sent to users after they text Y or YES for Double. Required for Double or Age. Not used for Single. |
| DoubleOptInValidResponses | String | False | Valid responses that users can text in for Double, such as Y or YES. Required for Double. Not used for Single or Age. |
| OptInInvalidAgeMessage | String | False | Response sent to users whose age is below the minimum. Required for Age. Not used for Single or Double. |
| MinimumAge | Integer | False | Minimum age that users can text in and be opted in. Required for Age. Not used for Single or Double. |
| AllowSingleOptIn | Boolean | False | Determines whether users receive a different response if they are already opted in: True or False. |
| DuplicateOptInMessage | String | False | Response sent to users who are already opted in. |
| OptinErrorMessage | String | True | Response sent to users if an error occurred while opting them in. |
| StartDate | Date | True | Date the message becomes active. |
| EndDate | Date | True | Date the message becomes inactive. If users try to opt in to an inactive message, they receive the default keyword response for the code or the new message that the keyword has been set up for. |
| NextKeyword | String | False | Keyword to append to the next message received from users. For example, the NextKeyword is ZIP. After a user texts in JOIN, the response is 'Welcome. Please send your zip code.' Users can text in their zip code without using the keyword ZIP. |
Result Set Columns
| Name | Type | Description |
| MessageID | String | The Id of the created opt-in message. |