proxy.delete

Delete an SFMC object via the SOAP API.

Syntax

var result = proxy.delete(objectType, properties);

Parameters

Name	Type	Required	Description
objectType	string	Yes	SOAP API object type
properties	object	Yes	Object properties identifying the record to delete

Return Value

{
    Status: "OK",
    RequestID: "...",
    Results: [{ StatusCode: "OK", StatusMessage: "..." }]
}

Examples

Delete a Data Extension

var proxy = new Script.Util.WSProxy();
var result = proxy.delete("DataExtension", {
    CustomerKey: "TempDE_Key"
});
if (result.Status === "OK") {
    Write("Deleted successfully.");
}

Delete a subscriber from All Subscribers

var proxy = new Script.Util.WSProxy();
var result = proxy.delete("Subscriber", {
    SubscriberKey: "sub_jane"
});

Delete a DE row

var proxy = new Script.Util.WSProxy();
var result = proxy.delete("DataExtensionObject[MyDE_Key]", {
    Keys: {
        Key: [
            { Name: "SubscriberKey", Value: "sub_jane" }
        ]
    }
});

Deletions are permanent and cannot be undone. Test delete logic in a sandbox before running in production.

See Also

See Also

• proxy.create
• proxy.update