Push Campaigns Object Properties Reference

Name of the campaign to be created.

Folder name for the campaign to be created.

Type of the campaign. For push campaigns, type is PUSH (case insensitive).

Description of the campaign.

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

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

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

• folder – indicates the folder where the data source is located in Responsys.
• type – The data source type.
• 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.
• name – The name of the data source.
• columns – 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.
  • defaultValue – the default value of the data source.
• dynamicVariables - a type of data source that contains variables that define and controls campaign content.

The message of the push notification to be displayed. This includes:

• title – The title of the notification.
• textMessage – The body message of the notification
• iosMediaUrl – A link to media to be included in the iOS version of the notification.
• androidImageUrl – A link to an image to be included in the Android version of the notification.
• deepLinkUrl – A link through the push notification to another webpage.

• interruptionLevel – For iOS 15 and above, you can determine how and when mobile app users receive your Push notification by using the Interruption Level setting. Possible values include: active, passive,time-sensitive, and critical. The default value is active.

  Tip: See the Notifications article in the Apple Human Interface Guidelines to learn more about notification alert behaviors for each interruption level and how to use interruption levels effectively.

  • Active (default) - This is the default interruption level where the notification appears on the users screen immediately, makes a sound and lights up. If a user has system notification summary turned on, then the notification will be included in the summary. It will not break through Focus and will not override sound when the user has their phone muted.

  • Passive - This is used for notifications that do not need immediate attention, and does not trigger any sound or light up the screen.

  • Time Sensitive - This is the interruption level used for notifications that need immediate attention. It acts the same as the Active level notification, except it overrides device notification settings, but it won’t override the users mute switch.

    Important: When allowed, Time Sensitive notifications break through a Focus or scheduled delivery. Therefore make sure the notification is about time sensitive information only, such as events that would happen at the exact moment of the notification or would happen within an hour of the notification (for example, a courier delivery). Apple recommends not using this interruption level for marketing notifications. See the Notifications article in the Apple Human Interface Guidelines for more details and examples.

  • Critical - This is an extremely rare interruption level used for notifications that need urgent attention, such as information about personal health and public safety information. The notification is immediate, lights up the screen and will bypass all device notification settings, including the mute switch.

    Warning:

    Be cautious about using the Critical interruption level. Apple must provide your app with an entitlement before you use this level. Using this level without the right entitlement could affect notification delivery.

    According to the Notifications article in the Apple Human Interface Guidelines, Critical interruption level is defined as:

    Urgent information about personal health and public safety that directly impacts people and demands their immediate attention. Critical notifications are extremely rare and typically come from governmental and public agencies or healthcare apps. You must get an entitlement to use the Critical interruption level

• relevanceScore – iOS 15 and above can use the relevance score feature to order Push notifications from the same mobile app in the Notification Summary, so that device users see higher priority messages before lower priority messages.

  Relevance Score settings only impact the order of messages from your own app. For example, if you send one notification with Relevance Score 1, and another with Relevance Score 0.50, then the one with Relevance Score 1 will appear first in the summary of notifications from your app.

  Possible values include: 0.0, 0.25, 0.50, 0.75, and 1. The default Relevance score value is 0.0.

A list of settings to be enabled upon the launch of the campaign. This includes:

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