InvokeDelete
→ objectExecutes a SOAP Delete operation on a configured SOAP API object.
Available in:
Email
CloudPage
Automation
Triggered Send
Syntax
Platform.Function.InvokeDelete(apiObject, status, options)
3 arguments
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
apiObject |
object | Yes | SOAP object built with CreateObject/SetObjectProperty |
status |
array | Yes | Array that receives the status and request ID of the API call (e.g. [0, 0]) |
options |
object | Yes | API configure options to include in the call. Can contain a null value. |
Examples
var sub = Platform.Function.CreateObject("Subscriber");
Platform.Function.SetObjectProperty(sub, "SubscriberKey", "sub_123");
var StatusAndRequestID = [0, 0];
var result = Platform.Function.InvokeDelete(sub, StatusAndRequestID, null);
var status = StatusAndRequestID[0];
var requestID = StatusAndRequestID[1];