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

Request Details

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.

Request Properties
CharacterId String

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

Data Dict<String, String>

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 (required) String

Unique PlayFab assigned instance identifier of the item

KeysToRemove List<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 (required) String

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

POST https://{{TitleID}}
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
  "PlayFabId": "204883457",
  "CharacterId": "9890723423",
  "ItemInstanceId": "88331144",
  "Data": {
    "Equipped": "True",
    "Slot": "Head"

Response Details

Result Properties

Sample Response

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



Possible Error Codes

Name Code