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

Overview

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

URL Parameters

NameTypeDescription
messageIDstringRequiredThe ID of the triggered send definition configured for MessageSend sending used for the send

JSON Parameters

NameTypeDescription
inclusionTagsarrayTags used to identify contacts that will receive the message
exclusionTagsarrayTags used to identify contacts that will not receive the message
deviceTokensarrayThe device tokens of the mobile devices that will receive the message (5000 max.). This value is required if subscriberKeys are not set.
subscriberKeysarrayThe subscriber keys of the mobile devices that will receive the message (5000 max.). This value is required if deviceTokens are not set.
overridebooleanIf true, the contact receives the messageText, title, and subtitle as provided instead of the message's original text.
messageTextstringThe text value to be used in place of the message's original text. This value is required if deviceTokens are not set.
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, referencing UTC-6.
blackoutWindowstringBlackout window definition used to delay message sending outside a given windowStart and windowEnd and utcOffset.
MessageCategoryobjectUsed to specify the Interactive Notification category for a given send. Sending a messageCategory triggers the mobile device to the display buttons the application has defined and associated with that category name. Each Push application can have one or more categories.
MessageCategory.NamestringA name is required when including the MessageCategory object.
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
content-availableintegerIndicates the availability of content for an application enabled to use silent push. Set this value to 1 to indicate available content. This parameter applies only to apps integrated with the background push functionality available in iOS.

Usage

Example Request

Example Response