InvokeDelete
This function executes the deletion of the instantiated Marketing Cloud API Object. In order to delete an object, you must specify a ID, ObjectID or CustomerKey property for the object. API error codes are outlined in the official documentation.
Arguments
InvokeDelete(1,2,3,4)
| Ordinal | Type | Required | Description |
|---|---|---|---|
| 1 | API Object | True | The API Object to be deleted |
| 2 | Variable | True | The AMPscript variable in which the resulting status message is stored |
| 3 | Variable | True | The AMPscript variable in which the resulting error code is stored |
| 4 | API Object | False | The optional DeleteOptions API Object |
Example
The following example deletes an existing DataFolder object. The CustomerKey property indicates the DataFolder to delete. It returns a status code, message and an error code.
%%[
var @df, @deleteStatusCode, @deleteStatusMessage, @deleteErrorCode
set @df = CreateObject("DataFolder")
SetObjectProperty(@df, "CustomerKey", "Test Folder")
set @deleteStatusCode = InvokeDelete(@df, @deleteStatusMessage, @deleteErrorCode)
]%%
deleteStatusCode: %%=v(@deleteStatusCode)=%%
<br>deleteStatusMessage: %%=v(@deleteStatusMessage)=%%
<br>deleteErrorCode: %%=v(@deleteErrorCode)=%%Output
deleteStatusCode: OK
deleteStatusMessage: Folder deleted successfully.
deleteErrorCode: 0If the DataFolder is not found, it will return an error:
deleteStatusCode: Error
deleteStatusMessage: Folder with CustomerKey: "Test Folder " could not be found.
deleteErrorCode: 396009