The action that occurs if the user taps a push notification delivered by the campaign:
OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent
to the background. This is the default action.

DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display
a designated user interface within the app.

URL - The default mobile browser on the user's device launches and opens a web page
at the URL you specify.

Body

string

The message body. Can include up to 140 characters.

ImageIconUrl

string

The URL that points to the icon image for the push notification icon, for example,
the app icon.

ImageSmallIconUrl

string

The URL that points to the small icon image for the push notification icon, for example,
the app icon.

ImageUrl

string

The URL that points to an image used in the push notification.

JsonBody

string

The JSON payload used for a silent push.

MediaUrl

string

A URL that refers to the location of an image or video that you want to display in
the push notification.

RawContent

string

The Raw JSON formatted string to be used as the payload. This value overrides the
message.

SilentPush

boolean

Indicates if the message should display on the users device.

Silent pushes can be used for Remote Configuration and Phone Home use cases.

TimeToLive

integer

This parameter specifies how long (in seconds) the message should be kept if the service
is unable to deliver the notification the first time. If the value is 0, it treats
the notification as if it expires immediately and does not store the notification
or attempt to redeliver it. This value is converted to the expiration field when sent
to the service. It only applies to APNs and GCM

Title

string

The message title that displays above the message on the user's device.

Url

string

The URL to open in the user's mobile browser. Used if the value for Action is URL.

CampaignEmailMessage

Attribute

Type

Description

Body

string

The email text body.

FromAddress

string

The email address used to send the email from. Defaults to use FromAddress specified
in the Email Channel.

HtmlBody

string

The email html body.

Title

string

The email title (Or subject).

CampaignSmsMessage

Attribute

Type

Description

Body

string

The SMS text body.

MessageType

string

Is this is a transactional SMS message, otherwise a promotional message.

The default quiet time for the campaign. The campaign doesn't send messages to endpoints
during the quiet time.

Note: Make sure that your endpoints include the Demographics.Timezone attribute if
you plan to enable a quiet time for your campaign. If your endpoints don't include
this attribute, they'll receive the messages that you send them, even if quiet time
is enabled.

When you set up a campaign to use quiet time, the campaign doesn't send messages during
the time range you specified, as long as all of the following are true:
- The endpoint includes a valid Demographic.Timezone attribute.
- The current time in the endpoint's time zone is later than or equal to the time
specified in the QuietTime.Start attribute for the campaign.
- The current time in the endpoint's time zone is earlier than or equal to the time
specified in the QuietTime.End attribute for the campaign.

StartTime

string

The scheduled time that the campaign begins in ISO 8601 format.

Timezone

string

The starting UTC offset for the schedule if the value for isLocalTime is true

The time at which quiet time should end. The value that you specify has to be in HH:mm
format, where HH is the hour in 24-hour format (with a leading zero, if applicable),
and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent
2:30 PM.

Start

string

The time at which quiet time should begin. The value that you specify has to be in
HH:mm format, where HH is the hour in 24-hour format (with a leading zero, if applicable),
and mm is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent
2:30 PM.

CampaignState

Attribute

Type

Description

CampaignStatus

string

The status of the campaign, or the status of a treatment that belongs to an A/B test
campaign.