Use this method to remove Items from the server based on a list of Item IDs. You must have Inbound Services enabled on your account for this to work. This method can be used to remove multiple Items.
Syntax
| C# |  Copy |
|---|---|
RemoveInboundItemsByIDResponse RemoveInboundItemsByID(Authentication authentication, RemoveInboundItemsByIDRequest request) | |
Parameters
Parameter | Type | Required? | Description | |
|---|---|---|---|---|
Input Header | Authorization | String | Required for OAuth 2.0 authorization | A string representing the authentication of the request via an access token in the format Authorization: Bearer {AccessToken}. Example header: Authorization:Bearer M1Q0NjJvZ7Q5OPM2NDW1ZTCjOGZmYjI4 |
x-ch-request-id | String | Client generated unique identifier for tracking | ||
Input Body | authentication | Required | Authentication credentials (User Id and PIN) | |
Output Header | x-ch-activity-id | String | Server generated unique identifier for tracking | |
x-ch-execution-time | String | Server execution time in milli-seconds | ||
request | Required | Request Object | ||
Result | request | Response Object (Output) |
Remarks
RemoveInboundItemsByID removes the Items based on item ID's specified.
Calling this method will move the item to Archive folder by default. If you wish to have items permanently removed you must set to DoNotArchiveItems propery to true.
Archived items will be purged based on Account settings and System policy.
See Also
