Skip to main content
POST
Consume Item

Authorizations

X-SecretKey
string
header
required

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

Body

application/json
ConsumeCount
number
required

Number of uses to consume from the item.

ItemInstanceId
string
required

Unique instance identifier of the item to be consumed.

PlayFabId
string
required

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

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Last modified on October 1, 2026