Documentation

UpdateCharacterData

Creates and updates the title-specific custom data for the user's character which is readable and writable by the client

Request Details

This function performs an additive update of the arbitrary strings containing the custom data for the character. 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. New keys will be added, with the given values. No other key-value pairs will be changed apart from those specified in the call.

UpdateCharacterDataRequest
Request Properties
CharacterId (required) 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.

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.

Permission UserDataPermission

Permission to be applied to all user data keys written in this request. Defaults to "private" if not set.

POST https://{{TitleID}}.playfabapi.com/Client/UpdateCharacterData
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "CharacterId": "98765456",
  "Data": {
    "Class": "Fighter",
    "Gender": "Female",
    "Icon": "Guard 3",
    "Theme": "Colorful"
  },
  "Permission": "Public"
}
        

Response Details

UpdateCharacterDataResult
Result Properties
DataVersion (required) uint32

Indicates the current version of the data that has been set. This is incremented with every set call for that type of data (read-only, internal, etc). This version can be provided in Get calls to find updated data.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "DataVersion": 5
  }
}

Authentication

SessionTicket

Possible Error Codes

Name Code
AccountNotFound 1001
CharacterNotFound 1135