InvokeConfigure
→ stringInvokes the SOAP API Configure method on a fully configured API object. Used for configuration-type operations on SOAP objects.
Available in:
Email
CloudPage
Automation
Triggered Send
Syntax
Platform.Function.InvokeConfigure(apiObject, action[, statusArray, options])
2–4 arguments
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
apiObject |
object | Yes | SOAP API object built with CreateObject and configured with SetObjectProperty |
action |
string | Yes | Configure action to perform on the object |
statusArray |
array | No | Array that receives the status and RequestID of the API call |
options |
object | No | Additional API options; may be null |
Examples
var configObj = Platform.Function.CreateObject("DataRetentionPolicyConfiguration");
Platform.Function.SetObjectProperty(configObj, "CustomerKey", "MyDE");
Platform.Function.SetObjectProperty(configObj, "DataRetentionPeriod", "6");
Platform.Function.SetObjectProperty(configObj, "DataRetentionPeriodLength", "Months");
var status = [];
var result = Platform.Function.InvokeConfigure(configObj, "set", status, null);
Write("Status: " + result);
WSProxy is the recommended approach for most SOAP API interactions. Use InvokeConfigure only when the Configure SOAP verb is specifically required.