Use the DELETE method to delete objects individually or in batches. Multiple object types can be deleted with one call. Objects are deleted in the order they are added to the APIObject array.
DeleteResult[] delete = Delete(Options, Objects, RequestID, OverallStatus)</p>| Name | Data Type | Description |
|---|---|---|
| Objects | APIObject[] | 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. |
| Options | DeleteOptions | 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:
|
| RequestID | String | A unique identifier for the request. This string contains an output variable of the key of the request. |
NameData TypeDescription
DeleteResult
Array
An array of objects holding a list of return values. The objects are returned in the order they are deleted. This array contains one DeleteResult object per input APIObject.
j
Search Tips: