ScheduleBatchUserScript

Schedules a script to run on the server at a later date.

Service	Operation
script	SCHEDULE_BATCH_USER_SCRIPT

Method Parameters

Parameter	Description
scriptName	The name of the script with its path to be run.
scriptData	Data to be sent to the script in JSON format.
segmentIdList	List of target segments.
startDateUTC	If scheduling at a set time. The start date in UTC in Unix millis timestamp format.
minutesFromNow	If scheduling in minutes from the current time. Number of minutes from now to run the script.

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

Cloud Code

var scriptName = "path/to/script1";
var scriptData = {
  "parm": "value"
};
var segmentIdList = [
    1,
    2
];
var startDateUTC = 1512750683157;
var minutesFromNow = 1;
var scriptProxy = bridge.getScriptServiceProxy();

var postResult = scriptProxy.scheduleBatchUserScript(scriptName, scriptData, segmentIdList, startDateUTC, minutesFromNow);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "script",
    "operation": "SCHEDULE_BATCH_USER_SCRIPT",
    "data": {
        "scriptName": "path/to/script1",
        "scriptData": {
            "parm": "value"
        },
        "segmentIdList": [
            1,
            2
        ],
        "startDateUTC": "[[#ts+60000]]",
        "minutesFromNow": 1
    }
}