This API is used to soft delete an item from a target list. This API is idempotent.
Mandatory. A unique ID maintained by client for tracing purpose.
Note: ZOLOZ server does not perform uniqueness check on this field. For better tracking, it is strongly recommended client guarantee the uniqueness of this ID.
Required. Specify the type of the item to be removed.
Valid values include:
Mandatory. The ID of the item to be removed (soft deleting).
Contains the result code, result status, and a result message.
Available if the item is removed (soft deleted) successfully.
Common result codes
For the full list of common result codes, see the Common error codes section in the Error handling topic.
API-specific result codes
The following table shows the possible result codes that are specific for this API.
The API call is successful.
Input parameters are invalid. For more information about which parameter is invalid, check the result message or the related log.
The requested item does not exist.
Other internal errors. For more information about the error details, check the result message that is returned and the related log.
Here is an example request to remove a FACE item.
Here is an example when item is removed successfully.