Player Item Management - Update User Inventory Item Custom Data

Updates the key-value pair data tagged to the specified item, which is read-only from the client.

POST https://titleId.playfabapi.com/Server/UpdateUserInventoryItemCustomData

Request Header

Name Required Type Description
SecretKey True
  • string

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

Request Body

Name Required Type Description
CharacterId
  • string

Unique PlayFab assigned ID for a specific character owned by a user

Data
  • object

Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may not begin with a '!' character or be null.

ItemInstanceId True
  • string

Unique PlayFab assigned instance identifier of the item

KeysToRemove
  • string[]

Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language constraints. Use this to delete the keys directly.

PlayFabId True
  • string

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

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

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

EmptyResponse
UpdateUserInventoryItemDataRequest

This function performs an additive update of the arbitrary JSON object containing the custom data for the item instance which belongs to the specified user. In updating the custom data object, keys which already exist in the object will have their values overwritten, while keys with null values will be removed. No other key-value pairs will be changed apart from those specified in the call.

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

EmptyResponse

UpdateUserInventoryItemDataRequest

This function performs an additive update of the arbitrary JSON object containing the custom data for the item instance which belongs to the specified user. In updating the custom data object, keys which already exist in the object will have their values overwritten, while keys with null values will be removed. No other key-value pairs will be changed apart from those specified in the call.

Name Type Description
CharacterId
  • string

Unique PlayFab assigned ID for a specific character owned by a user

Data
  • object

Key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may not begin with a '!' character or be null.

ItemInstanceId
  • string

Unique PlayFab assigned instance identifier of the item

KeysToRemove
  • string[]

Optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language constraints. Use this to delete the keys directly.

PlayFabId
  • string

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