Player Item Management - Revoke Inventory Item
Revokes access to an item in a user's inventory
POST https://titleId.playfabapi.com/Server/RevokeInventoryItem
Request Header
Name | Required | Type | Description |
---|---|---|---|
X-SecretKey | True |
|
This API requires a title secret key, available to title admins, from PlayFab Game Manager. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
ItemInstanceId | True |
|
Unique PlayFab assigned instance identifier of the item |
PlayFabId | True |
|
Unique PlayFab assigned ID of the user on whom the operation will be performed. |
CharacterId |
|
Unique PlayFab assigned ID for a specific character owned by a user |
Responses
Name | Type | Description |
---|---|---|
200 OK | ||
400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-SecretKey
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Type:
apiKey
In:
header
Definitions
Api |
The basic wrapper around every failed API response |
Revoke |
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. |
Revoke |
ApiErrorWrapper
The basic wrapper around every failed API response
Name | Type | Description |
---|---|---|
code |
|
Numerical HTTP code |
error |
|
Playfab error code |
errorCode |
|
Numerical PlayFab error code |
errorDetails |
|
Detailed description of individual issues with the request object |
errorMessage |
|
Description for the PlayFab errorCode |
status |
|
String HTTP code |
RevokeInventoryItemRequest
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.
Name | Type | Description |
---|---|---|
CharacterId |
|
Unique PlayFab assigned ID for a specific character owned by a user |
ItemInstanceId |
|
Unique PlayFab assigned instance identifier of the item |
PlayFabId |
|
Unique PlayFab assigned ID of the user on whom the operation will be performed. |
RevokeInventoryResult
Error Codes
Name | Code |
---|---|
ItemNotFound | 1047 |