Player Item Management - Revoke Inventory Item

  • Reference
Service:
Server
API Version:
211209

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
  • string

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name Required Type Description
ItemInstanceId True
  • string

Unique PlayFab assigned instance identifier of the item
PlayFabId True
  • string

Unique PlayFab assigned ID of the user on whom the operation will be performed.
CharacterId
  • string

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

ApiErrorWrapper

The basic wrapper around every failed API response
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.
RevokeInventoryResult

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • integer

Numerical HTTP code
error
  • string

Playfab error code
errorCode
  • integer

Numerical PlayFab error code
errorDetails
  • object

Detailed description of individual issues with the request object
errorMessage
  • string

Description for the PlayFab errorCode
status
  • string

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
  • string

Unique PlayFab assigned ID for a specific character owned by a user
ItemInstanceId
  • string

Unique PlayFab assigned instance identifier of the item
PlayFabId
  • string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

RevokeInventoryResult

Error Codes

Name Code
ItemNotFound 1047