POST /push/v1/messageList/{messageId}/send

Overview

Sends a message to the specified mobile devices of a push-enabled app.

URL Parameters

NameTypeDescription
messageIdstringRequiredThe API key of the message definition (configured in the MobilePush user interface)

JSON Parameters

NameTypeDescription
inclusionListIdsarrayRequiredAn array of one or more contact list ids to include in send
exclusionListIdsarrayAn array of one or more contact list ids to exclude in send
InclusionDataExtensionIdsarrayAn array of one or more data extension External Keys to include in send
ExclusionDataExtensionIdsarrayAn array of one or more data extension External Keys to exclude in send
overridebooleanFlag to indicate that the contact is to receive the messageText as provided instead of the message's original text
messageTextstringThe text value to be used in place of the message's original text. This field is required when override is true.
titlestringThe title to be used in place of the message's original title.
subtitlestringThe subtitle to be used in place of the message's original subtitle.
mutable-contentbooleanIf true, rich push functionality is enabled for the message.
sendTimedateDate formatted yyyy-MM-dd HH specifying a time in the future to send the message
blackoutWindowstringBlackout window definition used to delay message sending outside a given windowStart and windowEnd and utcOffset
soundstringSound filename to be played on the device
badgestringFor iOS SDK version 4.9.5 and newer: Overrides the value on the push message definition. Badge count displays this number in a badge on the app and increments this number by one for each new unread message. For older iOS SDK versions: Overrides the value on the push message definition. Badge count does not increment.
openDirectstringValue used as the open direct destination
customPayloadstringCustom definition in escaped JSON
customKeysarrayAn array of key/value pairs used as custom keys to be sent with the message request body

Usage

Example Request

Example Response