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

Overview

Sends a push message to users with the specified tags.

NameTypeDescription
messageIDstringRequiredThe ID of the triggered send definition configured for MessageSend sending used for the send
NameTypeDescription
inclusionTagsarrayRequiredTags used to identify contacts that will receive the message
exclusionTagsarrayTags used to identify contacts that will not receive the message
overridebooleanFlag to indicate that the contact is to receive the messageText as provided instead of the message's original text
messageTextbooleanText value to be used in place of the message's original text. This value 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