Character Data - Update Character Data

Service:

Client

API Version:

241122

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

POST https://titleId.playfabapi.com/Client/UpdateCharacterData

Request Header

Name	Required	Type	Description
X-Authorization	True	string	This API requires a client session ticket, available from any Client Login function.

Request Body

Name	Required	Type	Description
CharacterId	True	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.).
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.
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.
Permission		UserDataPermission	Permission to be applied to all user data keys written in this request. Defaults to "private" if not set.

Responses

Name	Type	Description
200 OK	UpdateCharacterDataResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-Authorization

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
UpdateCharacterDataRequest	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.
UpdateCharacterDataResult
UserDataPermission	Indicates whether a given data key is private (readable only by the player) or public (readable by all players). When a player makes a GetUserData request about another player, only keys marked Public will be returned.

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

UpdateCharacterDataRequest

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.

Name	Type	Description
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.).
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.
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.
Permission	UserDataPermission	Permission to be applied to all user data keys written in this request. Defaults to "private" if not set.

UpdateCharacterDataResult

Name	Type	Description
DataVersion	number	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.

UserDataPermission

Indicates whether a given data key is private (readable only by the player) or public (readable by all players). When a player makes a GetUserData request about another player, only keys marked Public will be returned.

Name	Type	Description
Private	string
Public	string

Error Codes

Name	Code
CharacterNotFound	1135