Update Player Custom Properties
Updates the title-specific custom property values for a player
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| PlayerCustomPropertiesDuplicatePropertyName | 19006 |
| PlayerCustomPropertiesPropertyCountTooHigh | 19005 |
| PlayerCustomPropertiesPropertyNameIsInvalid | 19001 |
| PlayerCustomPropertiesPropertyNameTooLong | 19000 |
| PlayerCustomPropertiesStringPropertyValueTooLong | 19002 |
| PlayerCustomPropertiesValueIsInvalidType | 19003 |
| PlayerCustomPropertiesVersionMismatch | 19004 |
| ProductDisabledForTitle | 1609 |
Authorizations
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Body
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.
Unique PlayFab assigned ID of the user on whom the operation will be performed.
Collection of properties to be set for a player.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
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.
