Message Center Campaigns Object Properties Reference

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

Nested schema: campaignMetadata

Name	Type	Required?	Description
`campaignName`	String	Yes	Name of the campaign.
`folderName`	String	Yes	Folder name for the campaign, where the campaign will be stored in Responsys.
`type`	String	No	Type of the campaign. For message center campaigns, type is `messagecenter` (case insensitive).
`appName`	String	No	Name of the app associated to the message center campaign. The app must have a valid platform and be associated with an app channel list. If `appName` is null or empty: The campaign will be created without associating an app to the campaign. The `message`, `dataSource`, and `targeting` schemas below cannot be specified.
`description`	String	No	Description of the campaign.
`marketingProgram`	String	No	Type of marketing program. The values are defined by the Responsys Account Administrator.
`marketingStrategy`	String	No	Type of marketing strategy. The values are defined by the Responsys Account Administrator.
`purpose`	String	No	Campaign purpose, either `Promotional` or `Transactional`.

Nested schema: message

Message properties to specify. All message parameters are optional and can be null.

Name	Type	Required?	Description
`textMessage`	String	No	Text content for the message center campaign.
`deepLinkUrl`	String	No	The URL location for the message's deep link content.
`destinationMessageCenter`	String	No	The name of the message center for which the campaign will be sent.
`subject`	String	No	The message subject.
`messageIconUrl`	String	No	The message icon URL.
`relativeExpiryDateOffset`	Integer	No	The relative message expiry time in terms of days. Must be a positive number. If specified, you cannot specify a `expiryDate`.
`expiryDate`	String	No	The message's expiry date. Must be in format "yyyy-MM-dd hh:mm a" (i.e. "2022-09-19 12:15 AM"). If specified, you cannot specify a `relativeExpiryDateOffset`.
`badgeOption`	String	No	Specify message center badge behavior. Possible values include: `none`, `increment`, `reset`, and `specifyBadgeCount`.
`badgeCount`	String	No	Badge count. Required if `badgeOption` is set to `specifyBadgeCount`.
`richMessagePath`	String	No	The location in Responsys of the rich message.
`richMessageExternalUrl`	String	No	The URL location of external rich message content.

Nested schema: dataSource > dataSourceTables

Name	Type	Required?	Description
`folder`	String	No	Indicates the folder where the data source is located in Responsys.
`type`	String	No	The data source type. Possible values include: PROFILE_LIST,CHANNEL_LIST, SUPPLEMENTAL_TABLE, and CHANNEL_EXTENSION PROFILE_EXTENSION.
`alias`	String	No	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.
`name`	String	No	The name of the data source.
`lookupTable`	Boolean	No	Whether the data source will be used as a lookup table.

Nested schema: dataSource > dataSourceTables > columns

Name	Type	Required?	Description
`alias`	String	No	An alias Responsys uses to identify the data source column. Optional if creating or updating a campaign. If not specified, defaults to the data source name.
`defaultValue`	String	No	The default value of the data source column.
`name`	String	No	The name of the data source column.
`lookupKey`	Boolean	No	Boolean value to determine whether or not the column is a lookup key. Defaults to false, if not specified for any column.

Nested schema: dataSource > dataSourceTables > dynamicVariables > columns

The dynamicVariables section is a type of data source that contains variables that define and control campaign content.

Name	Type	Required?	Description
`alias`	String	No	An alias Responsys uses to identify the dynamic variable. Optional if creating or updating a campaign. If not specified, defaults to the column name. Alias must be unique among dynamic variable aliases.
`defaultValue`	String	No	The default value of the dynamic variable.

Nested schema: targeting

The targeting strategy for the campaign. This schema is a list of strings.

Name	Type	Required?	Description
`filterNames`	String Array	No	An array of filters to be applied, letting you choose which customers you wish to send to.
`audienceName`	String	No	The name of the audience to target.
`allRecipients`	Boolean	No	Whether to target all customers in the app channel list with this campaign. Default value is false. This parameter may not be available depending on your account settings.

Nested schema: launchSettings

Name	Type	Required?	Description
`progressEmailAddresses`	String Array	No	Email addresses to receive notifications about campaign launch progress.
`skipAlertEnabled`	Boolean	No	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	No	Applicable to marketer-initiated campaigns only. The percentage of skipped messages that need to be skipped for an email notification.
`sentAlertEnabled`	Boolean	No	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	No	Applicable to marketer-initiated campaigns only. The percentage of sent messages that need to be sent for an email notification.
`startAlertEnabled`	Boolean	No	Applicable to marketer-initiated campaigns only. Whether or not to send a notification when the campaign is launched.
`emptyAlertEnabled`	Boolean	No	Applicable to marketer-initiated campaigns only. Whether or not to send a notification for an empty launch.
`failureEmailAddresses`	String Array	No	Email addresses to send launch failure notifications. The email contains information that identifies the campaign and program.
`skippedLaunchEmailAddresses`	String Array	No	Email addresses to send launch failure notifications. The email contains information that identifies the campaign and program.
`launchThrottleRate`	Integer	No	The throttle rate at launch. It should be greater than 3600. The default is 6000.

Learn more

Message Center