The smsKeywordObject is used to add, update, and delete SMS keywords via the API. You can also add contacts to, and remove contacts from specific SMS keywords.

Name Type Description
id string The unique id for the SMS keyword.
name string The name assigned to the SMS keyword.
description string The description provided for the SMS keyword.
subscriberCount long The number of people subscribed to the SMS keyword.
frequencyCap long The frequency cap represents the maximum number of SMS messages you can send to a person subscribed to the keyword each month. Best practice suggests you set the frequency cap to 30 or less per month. Valid values are 1-30.
dateCreated dateTime The date and time the SMS keyword was created.
scheduledDeleteDate dateTime When you delete an SMS keyword, it is marked for deletion and then deleted 7 days later. The scheduledDeleteDate represents the date the SMS keyword will be deleted.
confirmationMessage string The confirmation message set for the SMS keyword. The confirmation message is sent when a user confirms their subscription to the SMS keyword. The text “Txt STOP to <XXXXX> to end, HELP for info. <XX>msg/mo. Msg&Data rate may apply.” will be appended to your message. The confirmation message can be a maximum of 83 characters.
messageContent string The message content set for the SMS keyword. The messageContent will be sent each time a contact texts into the keyword or replies to a message from the keyword. The messageContent can be a maximum of 160 characters.
keywordType string The type set for the SMS keyword. Valid values are:
  • basic – Basic keywords are non-subscription keywords meant for individual transactions. With basic keywords, a person texts into a keyword and a response is sent back. The interaction ends there. The recipient is not added to a list because they have not agreed to receive future marketing messages from you.
  • subscription – Subscription based keywords require a person to choose to receive SMS messages from you by texting into a given keyword. Contacts who subscribe to a subscription based keyword will be added to a list so that you can send SMS messages to them in the future.
  • text2join – text2join keywords allows you to grow your list by providing a way for potential contacts to text their email address in and automatically be added to one of your lists.