POST /push/v1/messageApp/{messageId}/send
Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.
Broadcasts a message to all users of a push-enabled app.
| Name | Type | Description | |
|---|---|---|---|
| messageID | string | Required | The ID of the triggered send definition configured for MessageSend sending used for the send |
| Name | Type | Description | |
|---|---|---|---|
| override | boolean | A flag indicating the contact is to receive the messageText as provided instead of the message's original text. | |
| messageText | string | The text value to be used in place of the message's original text. This field is required when override is true. | |
| title | string | The title to be used in place of the message's original title. | |
| subtitle | string | The subtitle to be used in place of the message's original subtitle. | |
| mutable-content | boolean | If true, rich push functionality is enabled for the message. | |
| sendTime | date | Date formatted yyyy-MM-dd HH | |
| blackoutWindow | string | The blockoutWindow definition used to delay message sending outside a given windowStart and windowEnd and utcOffset. | |
| sound | string | Sound filename to be played on the device. | |
| badge | string | For 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. | |
| openDirect | string | Value used as the open direct destination | |
| customPayload | string | Custom definition in escaped JSON. | |
| customKeys | array | An array of key/value pairs used as custom keys to be sent with the message request body. |
Example Request
Example Response