Documentation

RevokeInventoryItems

Revokes access for up to 25 items across multiple users and characters.

Request Details

In cases where the inventory item in question is a "crate", and the items it contained have already been dispensed, this will not revoke access or otherwise remove the items which were dispensed.

RevokeInventoryItemsRequest
Request Properties
Items (required) List<RevokeInventoryItem>

Array of player items to revoke, between 1 and 25 items.

POST https://{{TitleID}}.playfabapi.com/Admin/RevokeInventoryItems
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "Items": [
    {
      "PlayFabId": "203945882",
      "ItemInstanceId": "2048583045"
    }
  ]
}
        

Response Details

RevokeInventoryItemsResult
Result Properties
Errors List<RevokeItemError>

Collection of any errors that occurred during processing.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

SecretKey

Possible Error Codes

Name Code
ItemNotFound 1047