POST /push/v1/messageBatch/{messageid}/send
Sends unique messages to devices within the same API call. Each batch can include a maximum of 5000 subscriber key or device token values, depending on which value the call uses.
| Name | Type | Description | |
|---|---|---|---|
| messageID | string | The ID of the message to update |
| Name | Type | Description | |
|---|---|---|---|
| deviceTokens | array | Required | Device tokens of the mobile devices that will receive the message. Required if subscriberKeys are not set. |
| subscriberKeys | array | Required | Subscriber keys of the mobile devices that will receive the message. Required if deviceTokens are not set. |
| inclusionTags | array | Tags used to identify contacts that will receive the message | |
| exclusionTags | array | Tags used to identify contacts that will not receive the message | |
| sendTime | date | Date formatted yyyy-MM-dd HH | |
| message | array | Required | Components of the message to include in the send |
| message.alert | string | Required | Message text displayed on the mobile device |
| message.sound | string | A sound filename to be played on the device | |
| message.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. | |
| message.openDirect | string | Value used as the OpenDirect destination | |
| message.custom | array | Custom definition in escaped JSON | |
| message.keys | array | An array of key/value pairs used as custom keys to be sent with the message request body | |
| 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. |
Example Request
Example Response
Additional Example Request
This request includes custom keys as an additional parameter. The mobile app must already include custom keys as part of the available functionality. The custom key name values must match between the message and application or the values will not update.