SendRichToSegments

This operation sends a template based message to multiple user targets.

Example of substitution usage:

Message could be You have won a {2} for entering the {1} contest.

Substitutions parameter would be { "1" : "User Appreciation", "2", "User Appreciation Prize" }

Results

Name	Description
estimatedTargets	Estimate number of targeted users

Service	Operation
pushNotification	SEND_RICH_TO_SEGMENTS

Method Parameters

Parameter	Description
notificationTemplateId	Identifies the template that will determine the message content.
segmentCodeList	List of target segment codes. Omit to send to all users.
segmentIdList	Deprecated: list of target segment ids. Use segmentCodeList instead.
substitutions	Positional message substitution values.

warning

segmentIdList is deprecated. Use segmentCodeList instead. Segment ids are assigned separately in each environment, so the same id can refer to a different segment after an app is copied or promoted, and new apps reject segment ids in cloud code.

Usage

http://localhost:3000

C#

// S2S call: to view example, switch to the Cloud Code or Raw tab.

C++

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Obj-C

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Java

// S2S call: to view example, switch to the Cloud Code or Raw tab.

JavaScript

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Dart

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Roblox

-- N/A

GDScript

N/A

Lua

-- S2S call: to view example, switch to the Cloud Code or Raw tab.

Cloud Code

var notificationTemplateId = 1;
var substitutions = {
    "0": "value0",
    "1": "value1"
};
var segments = [
    "high_spenders",
    "lapsed_30d"
];
var pushNotificationProxy = bridge.getPushNotificationServiceProxy();

var postResult = pushNotificationProxy.sendRichToSegments(notificationTemplateId, substitutions, segments);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "pushNotification",
    "operation": "SEND_RICH_TO_SEGMENTS",
    "data": {
        "notificationTemplateId": 1,
        "segmentCodeList": [
            "high_spenders",
            "lapsed_30d"
        ],
        "substitutions": {
            "0": "value0",
            "1": "value1"
        }
    }
}

JSON Response

{
    "packetId": 1,
    "messageResponses": [
        {
            "data": {
                "estimatedTargets": 1234
            },
            "status": 200
        }
    ]
}