Skip to main content
POST
Update Player Custom Properties

Authorizations

X-SecretKey
string
header
required

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

Body

application/json

Performs an additive update of the custom properties for the specified player. In updating the player's custom properties, properties which already exist will have their values overwritten. No other properties will be changed apart from those specified in the call.

Performs an additive update of the custom properties for the specified player. In updating the player's custom properties, properties which already exist will have their values overwritten. No other properties will be changed apart from those specified in the call.

PlayFabId
string
required

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

Properties
object[]
required

Collection of properties to be set for a player.

CustomTags
object

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

ExpectedPropertiesVersion
number

Optional field used for concurrency control. One can ensure that the update operation will only be performed if the player's properties have not been updated by any other clients since last the version.

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
Example:
Last modified on October 1, 2026