Defines a mobile-originated (MO) keyword, which mobile users can use to subscribe to SMS messages by completing a double opt-in workflow.
Properties
| Name | Data Type | Description |
|---|---|---|
Client |
ClientID object | Specifies the account ownership and context of an object. |
CorrelationID |
String | Identifies correlation of objects across several requests. |
CreatedDate |
DateTime | The date and time when the object was created. |
CustomerKey |
String | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
DefaultPublication |
List object | Specifies the default publication list to which to add a subscriber. |
ID |
Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
InvalidPublicationMessage |
String | Specifies message to send in case a subscriber requests subscription to or unsubscription from an invalid publication list. |
InvalidResponseMessage |
String | Specifies message to send in case a subscriber sends in an invalid response. |
IsDefaultKeyword |
Boolean | Specifies if account defaults to this SMS keyword action if no other options are available. |
MissingPublicationMessage |
String | Not used. |
ModifiedDate |
DateTime | The date and time when the object was last modified. |
NeedPublicationMessage |
String | Specifies message to send in case a subscriber sends in an response that doesn't specify a publication list. |
ObjectID |
String | System-controlled, read-only text string identifier for object. |
ObjectState |
String | Not used. |
Owner |
Owner object | Describes account ownership of subscriber in an on-your-behalf account. |
PartnerKey |
String | Unique identifier provided by partner for an object. This property is accessible only via API. |
PartnerProperties |
Array of APIProperty objects | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API. |
PromptMessage |
String | Contains message sent to subscriber to prompt response as part of the double opt-in process. |
SuccessMessage |
String | Defines SMS message to send if triggered email send succeeds. |
UnexpectedErrorMessage |
String | Contains message to send to subscriber in case of unexpected error. |
ValidPublications |
Array of List objects | Defines valid publication lists for use with a double opt-in event. |
ValidResponses |
Array of strings | Defines valid responses a subscriber can use as part of a double opt-in process. |