SMS Campaigns Object Properties Reference

Note: The Responsys Advanced API is generally available for all Responsys customers.

Name

Nested schema

Data Type

Default Value

Description 

generalInfo
  

List <String>

 

General information about the new campaign such as the folder where the campaign will be created.
  id String   Identifier of the SMS campaign.

 

 folderName

String

 
null

Folder name for the campaign to be created.

 

 purpose

String

 
null

Purpose of the campaign. Values include Promotional or Transactional.

 

 description

String

 
null

Description of the campaign.

 

 marketingStrategy

String

 
null

Type of marketing strategy. The values are defined by the Responsys Account Administrator.

 

 marketingProgram

String

 
null

Type of marketing program. The values are defined by the Responsys Account Administrator.

 

 template

String

 
null

Required. The SMS template type. Values include: Broadcast, DirectAPINotification, SmsOptout, SmsOptIn, SmsNotification, and Custom.

 

 assignedOrganizations

List <String>

 
null

Applicable only for accounts with Organizational Access and Targeting by Organization. List of organizations for the campaign. 

dataSources
  

List <String>

 
null

List of data sources that the SMS message references. Data sources include: Profile Lists, Profile Extensions, Supplemental Tables, and Dynamic Variables. For each data source you can supply the following details:

  • path - indicates where the data source is located in Responsys. Specify path by supplying the folder name, followed by the data source name. Example: "path": "folderName/objectName"
  • alias –an alias Responsys uses to identify the data source. Optional if creating or updating a campaign. If not specified, defaults to the data source name.
  • fields – array containing details about data source columns. Optional if creating or updating a campaign.
    • name – the name of the column.
    • alias – an alias Responsys uses to identify the column. Optional if creating or updating a campaign. If not specified, defaults to the column name.
    • lookUpKey – boolean value to determine whether or not the column is a lookup key. Defaults to false, if not specified for any column.
  • type – The data source type.
  • defaultValue – the default value of the data source.

 

 folder

String

 
null

The folder name where the data source is located in Responsys.

 

 type

String

 
null
 The data source type. Data sources include: Profile Lists (PROFILE_LIST), Profile Extensions (PROFILE_EXTENSION), Supplemental Tables (SUPPLEMENTAL_TABLE), and Dynamic Variables (DYNAMIC_VARIABLE

).

 

 alias

String

 
null

The alias Responsys uses to identify the data source. If not specified, defaults to the data source name.

 

 name

String

 
null

Name of the data source.

 

 columns

List <String>

 
null

List of data source columns. For each column you can specify:

  • alias: An alias Responsys uses to identify the column. If not specified, defaults to the column name.
  • name: The name of the column.
  • type: The column data type. Must be one of: CHAR, VARCHAR2, NUMBER, DATE, TIMESTAMP, BLOG, or CLOB.
    • defaultValue: The default value of the column.
    • lookupKey: Boolean value to determine whether or not the column is a lookup key. Defaults to false, if not specified for any column.

 

 lookupTable

Boolean

 
null

Boolean value to determine whether or not the data source is a lookup table. Defaults to false, if not specified for any data source.

 
messageInfo
  

List <String>

 

The SMS campaign message details, including messages and message codes for the SMS campaign.

 

 codeCountries

List <String>

 
null

Required. A list of code and country combinations to be used in the SMS campaign. At least one valid code must be provided. Refer to the online help to learn more about codes. For example:

"codeCountries": [
  {
    "code": "28179",
    "country": "US"
  }

 

 outboundMessage

String

 
null

The message to initiate the campaign. Required only for market-initiated messages. Refer to the online help to learn more.

 

 resposeMessages

List <String>

 
null

The response message is the message that is sent when you receive a keyword from your subscriber. Required only for subscriber-initiated messages. Refer to the online help to learn more. For each response message specify the following:

  • keywords: List of keywords to prompt a response message.
  • keywordType: The type of keyword. Values include: OPTIN(OPTIN), OPTOUT(OPTOUT), HELP(HELP), CUSTOM(CUSTOM), and INVALID(INVALID).
  • message: The response message to send to the subscriber.

For example:

"codeCountries": [
  {
    "code": "28179",
    "country": "US"
  }
  smsDltInfo

List <String>

 null

Enables you to send SMS messages under Distributed Ledger Technology (DLT) regulations. Specify a templateID and messageType.

"smsDltInfo": [
  {
    "templateId": "9005",
    "messageType": "OUTBOUND"
  }
],

 

 enableLinkTracking

Boolean

 

Boolean value to indicate whether link tracking is enabled.

 

 linkTablePath

String

 

If link tracking is enabled, the file name of the link table.

 
additionalInfo
  

List <String>

 

Additional campaign metadata. At minimum, specifying initiationType is required.
  initiationType String null Required. The initiation type of the SMS campaign. Values include: subscriber initiated (Y) or marketer initiated (N).

 

 externalTrackingParams

Map <String, String>

 
null

Name and value of external tracking parameters.

 

 campaignVariables

Map <String, String>

 
null

Name and value of campaign variables which are used as default values for text replacement.

 

 externalTracking

String

 
null

 

 

 externalTrackingEnabled

Boolean

 
false

Whether external tracking is enabled.

 

 honorPermission

Boolean

 
null

 

 

 emailOptIn

Boolean

 
false

Applicable only to Email Acquisition campaigns. Whether to opt customers into the email channel.

 

 smsOptIn

Boolean

 
false

Applicable only to Email Acquisition campaigns. Whether customers should be opted into mobile channel.

 

 smsOptOutFromAllLists

Boolean

 
false

Whether customers should be opted out from all lists.

 

 active

Boolean

 
false

Whether or not the campaign should be active.

launchOptions

 

List <String>

 

Details about how the SMS campaign will be launched. Refer to the online help to learn more about these options.

 

 progressAddress

String

 
null

Email address to receive notifications about campaign launch progress.

 

 skipAlertEnabled

Boolean

 
false

Applicable to marketer-initiated campaigns only. Whether or not to send email notifications for skipped messages. Notifications are sent when the specified percentage of messages are skipped (skipAlertPercent).

 

 skipAlertPercent

Integer

 
null

Applicable to marketer-initiated campaigns only. The percentage of skipped messages that need to be skipped for an email notification.

 

 sentAlertEnabled

Boolean

 
false

Applicable to marketer-initiated campaigns only. Whether or not to send email notifications for sent messages. Notifications are sent when the specified percentage of messages are skipped (sentAlertPercent).

 

 sentAlertPercent

Integer

 
null

Applicable to marketer-initiated campaigns only. The percentage of sent messages that need to be sent for an email notification.

 

 startAlertEnabled

Boolean

 
false

Applicable to marketer-initiated campaigns only. Whether or not to send a notification when the campaign is launched.

 

 emptyAlertEnabled

Boolean

 
false

Applicable to marketer-initiated campaigns only. Whether or not to send a notification for an empty launch.

 

 failureAddress

String

 
null

Email address to send launch failure notifications. The email contains information that identifies the campaign and program.

 

 withdrawnAddress

String

 
null

Email address to send launch withdrawn notifications.

 

 launchRate

String

 
null

The campaign launch throttle rate. Refer to the online help to learn more.

Learn more

Create SMS Campaign

Advanced API Resources