proxy.perform

Perform a lifecycle action on an SFMC object — start, pause, stop, or resume automation, journeys, and other objects.

Syntax

var result = proxy.perform(objectType, action, properties);

Parameters

Name	Type	Required	Description
objectType	string	Yes	SOAP API object type
action	string	Yes	Action to perform: "start", "pause", "stop", "resume", "publish"
properties	object	Yes	Object identifying the target

Examples

Start an Automation

var proxy = new Script.Util.WSProxy();
var result = proxy.perform("Automation", "start", {
    CustomerKey: "MyAutomation_Key"
});
if (result.Status === "OK") {
    Write("Automation started.");
}

Pause a Triggered Send Definition

var proxy = new Script.Util.WSProxy();
proxy.perform("TriggeredSendDefinition", "pause", {
    CustomerKey: "WelcomeEmail_TSD"
});

Start a Triggered Send Definition

var proxy = new Script.Util.WSProxy();
proxy.perform("TriggeredSendDefinition", "start", {
    CustomerKey: "WelcomeEmail_TSD"
});

Common action/objectType Combinations

Object Type	Actions
"Automation"	"start", "pause", "stop", "resume"
"TriggeredSendDefinition"	"start", "pause"

See Also

See Also

• proxy.execute