POST /push/v1/messageBatch/{messageid}/send
Sends unique messages to devices. Each batch can include a maximum of 5,000 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. The device tokens of the mobile devices that will receive the message. Required if subscriberKeys is not set. |
subscriberKeys | array | Required. The subscriber keys of the mobile devices that will receive the message. Required if deviceTokens is not set. |
inclusionTags | array | An array of tags that identify the contacts who receive the message. |
exclusionTags | array | An array of tags that identify the contacts who are excluded from receiving the message. |
sendTime | date | A timestamp that specifies when to send the message. Specify this value in yyyy-MM-dd HH:mm format. |
message | array | Required. Components of the message to include in the send. |
message.alert | string | Required. Message text displayed on the recipient's device. |
message.sound | string | The filename of the sound to play when the message is received. |
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 | The value used as the OpenDirect destination. |
message.custom | array | A custom message definition. Specify this value using escaped JSON. |
message.keys | array | An array of key–value pairs to use as custom keys that are sent with the message request body. |
title | string | The title to use in place of the message's original title. |
subtitle | string | The subtitle to use in place of the message's original subtitle. |
mutable-content | boolean | If true, rich push functionality is enabled for the message. |
The request must include either a DeviceTokens or SubscriberKeys array. It must also include the details of the message itself.
The response includes the tokenId value for each message.