POST /push/v1/messageBatch/{messageid}/send

Overview

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.

URL Parameters

NameTypeDescription
messageIDstringThe ID of the message to update

JSON Parameters

NameTypeDescription
deviceTokensarrayRequiredDevice tokens of the mobile devices that will receive the message. Required if subscriberKeys are not set.
subscriberKeysarrayRequiredSubscriber keys of the mobile devices that will receive the message. Required if deviceTokens are not set.
inclusionTagsarrayTags used to identify contacts that will receive the message
exclusionTagsarrayTags used to identify contacts that will not receive the message
sendTimedateDate formatted yyyy-MM-dd HH specifying a time in the future to send the message
messagearrayRequiredComponents of the message to include in the send
message.alertstringRequiredMessage text displayed on the mobile device
message.soundstringA sound filename to be played on the device
message.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.
message.openDirectstringValue used as the OpenDirect destination
message.customarrayCustom definition in escaped JSON
message.keysarrayAn array of key/value pairs used as custom keys to be sent with the message request body
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.

Usage

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.