Delete objects individually or in batches. You can delete multiple object types in a request. The API deletes objects in the order they appear in the APIObject array.
A collection of one or more objects to delete. The objects are deleted in the order they have been acted upon: first in, first out. This array can hold different object types, which allows you to perform complex interactions like deleting an account and two emails, in one call.
Optionally specifies more processing options. A DeleteOptions instance is required for this parameter. However, no properties need to be defined for the instance.
OverallStatus
String
Specifies the overall status of the request. Valid status values include:
OK - This status code states that all objects were successfully deleted.
Has Error - Valid for Delete method calls with multiple APIObject objects, this status code states that some of the operations failed, while some succeeded.
Error - This status code states that all delete operations failed during validation or processing.
RequestID
String
A unique identifier for the request. This string contains an output variable of the key of the request.
Output
Name
Data Type
Description
DeleteResult
Array
An array of objects that contains a list of return values. The API returns objects in the order they are deleted. This array contains one DeleteResult object for each APIObject in the request.
j
