POST /push/v1/messageList/{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.

Note

Overview

Sends a message to the specified mobile devices of a push-enabled app.

URL Parameters

Name	Type		Description
messageId	string	Required	The API key of the message definition (configured in the MobilePush user interface)

JSON Parameters

Name	Type		Description
inclusionListIds	array	Required	An array of one or more contact list ids to include in send
exclusionListIds	array		An array of one or more contact list ids to exclude in send
InclusionDataExtensionIds	array		An array of one or more data extension External Keys to include in send
ExclusionDataExtensionIds	array		An array of one or more data extension External Keys to exclude in send
override	boolean		Flag to indicate that 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:mm` specifying a time in the future to send the message
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

Usage

Example Request

Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
POST /push/v1/messageList/OEl8ODow/send
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

{
    "InclusionListIds": [
        "UTZ6QTh4MVRmMC1XZlN5QUtnS3hWdzo2NTow"
    ],
    "ExclusionListIds": [
        "VWRoY1IzcWh2RXVvc3FDYTRfcGtvQTo2NTow"
    ],
    "Override": true,
    "MessageText": "New information available!",
    "title": "Boost your winnings!",
    "subtitle": "Check your app to see what else is in store.",
    "mutable-content": 1,
    "SendTime": "2012-10-31 09:00",
    "Sound": "MyFile.caf",
    "Badge": "+1",
    "OpenDirect": "OD01",
    "CustomKeys": {
        "keyA": "keyA_value",
        "keyB": "keyB_value"
    },
    "CustomPayload": { "customA": "customA_value" }
}

Example Response

HTTP/1.1 200
{
    "tokenId": "TokenIDValue"
}

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

Overview

URL Parameters

JSON Parameters

Usage

No Results

Contents