> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Profile Writes Meter API Description

> Reference list of PlayFab APIs, including AddPlayerTag and virtual currency updates, that increment the profile writes meter for player and entity data.

Profile includes any data stored related to the player profile, entity profile, character profile, groups, and inventory. Profile data is information that applies to an individual player, group of players, or items, and is stored as Key/Value Pairs (KVPs) by PlayFab.

The following APIs cause the Profile writes meter to increment.

## Admin APIs

* [AddPlayerTag](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/playstream/addplayertag?) Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
* [AddUserVirtualCurrency](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-item-management/adduservirtualcurrency?) Increments the specified virtual currency by the stated amount
* [AddVirtualCurrencyTypes](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/addvirtualcurrencytypes?) Adds one or more virtual currencies to the set defined for the title. Virtual Currencies have a maximum value of 2,147,483,647 when granted to a player. Any value over that will be discarded.
* [BanUsers](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/banusers?) Bans users by PlayFab ID with optional IP address, for the provided game.
* [CreateActionsOnPlayersInSegmentTask](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/scheduledtask/createactionsonplayersinsegmenttask?) Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action.
* [CreatePlayerSharedSecret](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/authentication/createplayersharedsecret?) Creates a new Player Shared Secret Key. It may take up to 5 minutes for this key to become generally available after this API returns.
* [CreatePlayerStatisticDefinition](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/createplayerstatisticdefinition?) Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval and an aggregation method.
* [DeleteMasterPlayerAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/deletemasterplayeraccount?) Removes a master player account entirely from all titles and deletes all associated data.
* [DeletePlayer](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/deleteplayer?) Removes a user's player account from a title and deletes all associated data
* [DeletePlayerSharedSecret](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/authentication/deleteplayersharedsecret?) Deletes an existing Player Shared Secret Key. It may take up to 5 minutes for this delete to be reflected after this API returns.
* [DeleteStore](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/deletestore?) Deletes an existing virtual item store.
* [DeleteTitle](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/deletetitle?) Permanently deletes a title and all associated configuration.
* [GrantItemsToUsers](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-item-management/grantitemstousers?) Adds the specified items to the specified user inventories
* [IncrementLimitedEditionItemAvailability](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-item-management/incrementlimitededitionitemavailability?) Increases the global count for the given scarce resource.
* [IncrementPlayerStatisticVersion](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/incrementplayerstatisticversion?) Resets the indicated statistic, removing all player entries for it and backing up the old values.
* [RefundPurchase](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/refundpurchase?) Attempts to process an order refund through the origin'l real money payment provider.""
* [RemovePlayerTag](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/playstream/removeplayertag?) Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
* [RemoveVirtualCurrencyTypes](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/removevirtualcurrencytypes?) Removes one or more virtual currencies from the set defined for the title.
* [ResetCharacterStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/characters/resetcharacterstatistics?) Completely removes all statistics for the specified character, for the current game.
* [ResetUserStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/resetuserstatistics?) Completely removes all statistics for the specified user, for the current game.
* [ResolvePurchaseDispute](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/resolvepurchasedispute?) Attempts to resolve a dispute with the original order's payment provider.
* [RevokeAllBansForUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/revokeallbansforuser?) Revoke all active bans for a user.
* [RevokeBans](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/revokebans?) Revoke all active bans specified with BanId.
* [RevokeInventoryItem](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-item-management/revokeinventoryitem?) Revokes access to an item in a user's inventory
* [RevokeInventoryItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-item-management/revokeinventoryitems?) Revokes access for up to 25 items across multiple users and characters.
* [SetCatalogItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/setcatalogitems?) Creates the catalog configuration of all virtual goods for the specified catalog version.
* [SetPlayerSecret](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/authentication/setplayersecret?) Sets or resets the player's secret. Player secrets are used to sign API requests.
* [SetPublishedRevision](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/server-side-cloud-script/setpublishedrevision?) Sets the currently published revision of a title Cloud Script.
* [SetPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/shared-group-data/setpublisherdata?) Updates the key-value store of custom publisher settings
* [SetStoreItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/setstoreitems?) Sets all the items in one virtual store.
* [SetTitleData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/settitledata?) Creates and updates the key-value store of custom title settings which can be read by the client.
* [SetTitleInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/settitleinternaldata?) Updates the key-value store of custom title settings which cannot be read by the client.
* [SubtractUserVirtualCurrency](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-item-management/subtractuservirtualcurrency?) Decrements the specified virtual currency by the stated amount.
* [UpdateBans](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/updatebans?) Updates information of a list of existing bans specified with Ban Ids.
* [UpdateCatalogItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/updatecatalogitems?) Updates the catalog configuration for virtual goods in the specified catalog version.
* [UpdatePlayerSharedSecret](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/authentication/updateplayersharedsecret?) Updates a existing Player Shared Secret Key. It may take up to 5 minutes for this update to become generally available after this API returns.
* [UpdatePlayerStatisticDefinition](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/updateplayerstatisticdefinition?) Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval.
* [UpdateRandomResultTables](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/updaterandomresulttables?) Updates the random drop table configuration for the title
* [UpdateStoreItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/title-wide-data-management/updatestoreitems?) Updates an existing virtual item store with new or modified items.
* [UpdateUserData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/updateuserdata?) Updates the title-specific custom data for the user which is readable and writable by the client.
* [UpdateUserInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/updateuserinternaldata?) Updates the title-specific custom data for the user which cannot be accessed by the client.
* [UpdateUserPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/updateuserpublisherdata?) Updates the publisher-specific custom data for the user which is readable and writable by the client.
* [UpdateUserPublisherInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/updateuserpublisherinternaldata?) Updates the publisher-specific custom data for the user which cannot be accessed by the client.
* [UpdateUserPublisherReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/updateuserpublisherreadonlydata?) Updates the publisher-specific custom data for the user which can only be read by the client.
* [UpdateUserReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/player-data-management/updateuserreadonlydata?) Updates the title-specific custom data for the user which can only be read by the client.
* [UpdateUserTitleDisplayName](https://learn.microsoft.com/en-us/rest/api/services/playfab/admin/account-management/updateusertitledisplayname?) Updates the title specific display name for a user.

## Client APIs

* [AcceptTrade](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/trading/accepttrade?) Accepts an open trade (one that has not yet been accepted or cancelled), if the locally signed-in player is in the allowed player list for the trade, or it is open to all players. If the call is successful, the offered and accepted items will be swapped between the two players' inventories.
* [AddFriend](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/friend-list-management/addfriend?) Adds the PlayFab user, based upon a match against a supplied unique identifier, to the friend list of the local user. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
* [AddGenericID](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/addgenericid?) Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players.
* [AddOrUpdateContactEmail](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/addorupdatecontactemail?) Adds or updates a contact email to the player's profile.
* [AddSharedGroupMembers](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/shared-group-data/addsharedgroupmembers?) Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group (and the server) can add new members. Shared Groups are designed for sharing data between a very small number of players, see [Using Shared Group Data](/services/playfab/community/associations/groups/using-shared-group-data).
* [AddUsernamePassword](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/addusernamepassword?) Adds PlayFab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login.
* [AndroidDevicePushNotificationRegistration](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/platform-specific-methods/androiddevicepushnotificationregistration?) Registers the Android device to receive push notifications
* [ConsumePSNEntitlements](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/platform-specific-methods/consumepsnentitlements?) Checks for any new consumable entitlements. If any are found, they are consumed and added as PlayFab items.
* [ConsumeXboxEntitlements](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/platform-specific-methods/consumexboxentitlements?) Grants the player's current entitlements from XBOX Live, consuming all available items in XBOX and granting them to the player's PlayFab inventory. This call is idempotent and will not grant previously granted items to the player.
* [CreateSharedGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/shared-group-data/createsharedgroup?) Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. Upon creation, the current user will be the only member of the group. Shared Groups are designed for sharing data between a very small number of players. For more info, see [Using Shared Group Data](/services/playfab/community/associations/groups/using-shared-group-data).
* [GrantCharacterToUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/characters/grantcharactertouser?) Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.
* [LinkAndroidDeviceID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkandroiddeviceid?) Links the Android device identifier to the user's PlayFab account
* [LinkCustomID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkcustomid?) Links the custom identifier, generated by the title, to the user's PlayFab account.
* [LinkFacebookAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkfacebookaccount?) Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account.
* [LinkFacebookInstantGamesId](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkfacebookinstantgamesid?) Links the Facebook Instant Games Id to the user's PlayFab account.
* [LinkGameCenterAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkgamecenteraccount?) Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account.
* [LinkGoogleAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkgoogleaccount?) Links the currently signed-in user account to their Google account, using their Google account credentials.
* [LinkIOSDeviceID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkiosdeviceid?) Links the vendor-specific iOS device identifier to the user's PlayFab account.
* [LinkKongregate](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkkongregate?) Links the Kongregate identifier to the user's PlayFab account.
* [LinkNintendoSwitchDeviceId](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linknintendoswitchdeviceid?) Links the NintendoSwitchDeviceId to the user's PlayFab account.
* [LinkOpenIdConnect](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkopenidconnect?) Links an OpenID Connect account to a user's PlayFab account, based on an existing relationship between a title and an Open ID Connect provider and the OpenId Connect JWT from that provider.
* [LinkPSNAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkpsnaccount?) Links the PlayStation™Network account associated with the provided access code to the user's PlayFab account.
* [LinkSteamAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linksteamaccount?) Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account.
* [LinkTwitch](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linktwitch?) Links the Twitch account associated with the token to the user's PlayFab account.
* [LinkXboxAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/linkxboxaccount?) Links the XBOX Live account associated with the provided access code to the user's PlayFab account.
* [OpenTrade](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/trading/opentrade?) Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time.
* [PurchaseItem](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-item-management/purchaseitem?) Buys a single item with virtual currency. You must specify both the virtual currency to use to purchase, as well as what the client believes the price to be. This lets the server fail the purchase if the price has changed.
* [PayForPurchase](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-item-management/payforpurchase?) Selects a payment option for purchase order created via StartPurchase
* [RegisterForIOSPushNotification](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/platform-specific-methods/registerforiospushnotification?) Registers the iOS device to receive push notifications
* [RegisterPlayFabUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/authentication/registerplayfabuser?) Registers a new PlayFab user account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. You must supply either a username or an email address.
* [RemoveContactEmail](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/removecontactemail?) Removes a contact email from the player's profile.
* [RemoveFriend](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/friend-list-management/removefriend?) Removes a specified user from the friend list of the local user.
* [RemoveGenericID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/removegenericid?) Removes the specified generic service identifier from the player's PlayFab account.
* [RemoveSharedGroupMembers](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/shared-group-data/removesharedgroupmembers?) Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. Shared Groups are designed for sharing data between a very small number of players, see [Using Shared Group Data](/services/playfab/community/associations/groups/using-shared-group-data).
* [ReportAdActivity](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/advertising/reportadactivity?) Report player's ad activity
* [ReportDeviceInfo](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/analytics/reportdeviceinfo?) Write a PlayStream event to describe the provided player device information. This API method is not designed to be called directly by developers. Each PlayFab client SDK will eventually report this information automatically.
* [ReportPlayer](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/reportplayer?) Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially toxic players.
* [RestoreIOSPurchases](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/platform-specific-methods/restoreiospurchases?) Restores all in-app purchases based on the given restore receipt
* [SetFriendTags](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/friend-list-management/setfriendtags?) Updates the tag list for a specified user in the friend list of the local user.
* [SubtractUserVirtualCurrency](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-item-management/subtractuservirtualcurrency?) Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.
* [UnlinkAndroidDeviceID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkandroiddeviceid?) Unlinks the related Android device identifier from the user's PlayFab account.
* [UnlinkCustomID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkcustomid?) Unlinks the related custom identifier from the user's PlayFab account.
* [UnlinkFacebookAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkfacebookaccount?) Unlinks the related Facebook account from the user's PlayFab account.
* [UnlinkFacebookInstantGamesId](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkfacebookinstantgamesid?) Unlinks the related Facebook Instant Game Ids from the user's PlayFab account.
* [UnlinkGameCenterAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkgoogleaccount?) Unlinks the related Game Center account from the user's PlayFab account.
* [UnlinkGoogleAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkiosdeviceid?) Unlinks the related Google account from the user's PlayFab account ([https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods](https://developers.google.com/android/reference/com/google/android/gms/auth/GoogleAuthUtil#public-methods)).
* [UnlinkIOSDeviceID](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkiosdeviceid?) Unlinks the related iOS device identifier from the user's PlayFab account.
* [UnlinkKongregate](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkkongregate?) Unlinks the related Kongregate identifier from the user's PlayFab account.
* [UnlinkNintendoSwitchDeviceId](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinknintendoswitchdeviceid?) Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account.
* [UnlinkOpenIdConnect](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkopenidconnect?) Unlinks an OpenID Connect account from a user's PlayFab account, based on the connection ID of an existing relationship between a title and an Open ID Connect provider.
* [UnlinkPSNAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkpsnaccount?) Unlinks the related PSN™ account from the user's PlayFab account.
* [UnlinkSteamAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinksteamaccount?) Unlinks the related Steam account from the user's PlayFab account.
* [UnlinkTwitch](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinktwitch?) Unlinks the related Twitch account from the user's PlayFab account.
* [UnlinkXboxAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/unlinkxboxaccount?) Unlinks the related XBOX Live account from the user's PlayFab account.
* [UnlockContainerInstance](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-item-management/unlockcontainerinstance?) Opens the specified container, with the specified key (when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
* [UnlockContainerItem](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-item-management/unlockcontaineritem?) Searches target inventory for an ItemInstance matching the given CatalogItemId, if necessary unlocks it using an appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
* [UpdateAvatarUrl](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/updateavatarurl?) Update the avatar URL of the player.
* [UpdateCharacterData](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/character-data/updatecharacterdata?) Creates and updates the title-specific custom data for the user's character which is readable and writable by the client
* [UpdateCharacterStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/characters/updatecharacterstatistics?) Updates the values of the specified title-specific statistics for the specific character. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
* [UpdatePlayerStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-data-management/updateplayerstatistics?) Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.
* [UpdateSharedGroupData](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/shared-group-data/updatesharedgroupdata?) Adds, updates, and removes data keys for a shared group object. If the permission is set to Public, all fields updated or added in this call will be readable by users not in the group. By default, data permissions are set to Private. Regardless of the permission setting, only members of the group can update the data. Shared Groups are designed for sharing data between a very small number of players, see [Using Shared Group Data](/services/playfab/community/associations/groups/using-shared-group-data).
* [UpdateUserData](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-data-management/updateuserdata?) Creates and updates the title-specific custom data for the user which is readable and writable by the client.
* [UpdateUserPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/player-data-management/updateuserpublisherdata?) Creates and updates the publisher-specific custom data for the user which is readable and writable by the client.
* [UpdateUserTitleDisplayName](https://learn.microsoft.com/en-us/rest/api/services/playfab/client/account-management/updateusertitledisplayname?) Updates the title specific display name for the user

"PlayStation" is a registered trademark or trademark of Sony Interactive Entertainment Inc.

"PSN" is a registered trademark or trademark of Sony Interactive Entertainment Inc.

## Data APIs

* [SetObjects](https://learn.microsoft.com/en-us/rest/api/services/playfab/data/object/setobjects?) Sets objects on an entity's profile.

## Groups APIs

* [AcceptGroupApplication](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/acceptgroupapplication?) Accepts an outstanding invitation to join a group
* [AcceptGroupInvitation](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/acceptgroupinvitation?) Accepts an invitation to join a group.
* [AddMembers](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/addmembers?) Adds members to a group or role.
* [ApplyToGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/applytogroup?) Applies to join a group.
* [BlockEntity](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/blockentity?) Blocks a list of entities from joining a group.
* [ChangeMemberRole](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/changememberrole?) Changes the role membership of a list of entities from one role to another.
* [CreateGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/creategroup?) Creates a new group.
* [CreateRole](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/createrole?) Creates a new group role.
* [DeleteGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/deletegroup?) Deletes a group and all roles, invitations, join requests, and blocks associated with it.
* [DeleteRole](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/deleterole?) Deletes an existing role in a group.
* [InviteToGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/invitetogroup?) Invites a player to join a group,
* [RemoveGroupApplication](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/removegroupapplication?) Removes an application to join a group.
* [RemoveGroupInvitation](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/removegroupinvitation?) Removes an invitation join a group.
* [RemoveMembers](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/removemembers?) Removes members from a group.
* [UnblockEntity](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/unblockentity?) Unblocks a list of entities from joining a group.
* [UpdateGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/updategroup?) Updates non-membership data about a group.
* [UpdateRole](https://learn.microsoft.com/en-us/rest/api/services/playfab/groups/groups/updaterole?) Updates metadata about a role.

## Profile APIs

* [SetGlobalPolicy](https://learn.microsoft.com/en-us/rest/api/services/playfab/profiles/account-management/setglobalpolicy?) Sets the global title access policy.
* [SetProfileLanguage](https://learn.microsoft.com/en-us/rest/api/services/playfab/profiles/account-management/setprofilelanguage?) Updates the entity's language. The precedence hierarchy for communication to the player is Title Player Account language, Master Player Account language, and then title default language if the first two aren't set or supported.
* [SetProfilePolicy](https://learn.microsoft.com/en-us/rest/api/services/playfab/profiles/account-management/setprofilepolicy?) Sets the profiles access policy.

## Server APIs

* [AddCharacterVirtualCurrency](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/addcharactervirtualcurrency?) Increments the character's balance of the specified virtual currency by the stated amount.
* [AddFriend](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/friend-list-management/addfriend?) Adds the Friend user to the friendlist of the user with PlayFabId. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.
* [AddGenericID](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/addgenericid?) Adds the specified generic service identifier to the player's PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players.
* [AddPlayerTag](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/playstream/addplayertag?) Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.
* [AddSharedGroupMembers](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/shared-group-data/addsharedgroupmembers?) Adds users to the set of those able to update both the shared data, as well as the set of users in the group. Only users in the group (and the server) can add new members. Shared Groups are designed for sharing data between a very small number of players, see [Using Shared Group Data](/services/playfab/community/associations/groups/using-shared-group-data).
* [AddUserVirtualCurrency](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/adduservirtualcurrency?) Increments the user's balance of the specified virtual currency by the stated amount.
* [AwardSteamAchievement](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/platform-specific-methods/awardsteamachievement?) Awards the specified users the specified Steam achievements.
* [BanUsers](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/banusers?) Bans users by PlayFab ID with optional IP address, for the provided game.
* [ConsumeItem](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/consumeitem?) Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory.
* [CreateSharedGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/shared-group-data/createsharedgroup?) Requests the creation of a shared group object, containing key/value pairs which may be updated by all members of the group. When created by a server, the group will initially have no members. Shared Groups are designed for sharing data between a very small number of players, see [Using Shared Group Data](/services/playfab/community/associations/groups/using-shared-group-data).
* [DeleteCharacterFromUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/characters/deletecharacterfromuser?) Deletes the specific character ID from the specified user.
* [DeleteSharedGroup](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/shared-group-data/deletesharedgroup?) Deletes a shared group, freeing up the shared group ID to be reused for a new group. Shared Groups are designed for sharing data between a very small number of players, see [Using Shared Group Data](/services/playfab/community/associations/groups/using-shared-group-data).
* [GrantCharacterToUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/characters/grantcharactertouser?) Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.
* [GrantItemsToCharacter](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/grantitemstocharacter?) Adds the specified items to the specified character's inventory.
* [GrantItemsToUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/grantitemstouser?) Adds the specified items to the specified user's inventory.
* [GrantItemsToUsers](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/grantitemstousers?) Adds the specified items to the specified user inventories,
* [LinkServerCustomId](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/linkservercustomid?) Links the custom server identifier, generated by the title, to the user's PlayFab account.
* [LinkXboxAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/linkxboxaccount?) Links the XBOX Live account associated with the provided access code to the user's PlayFab account.
* [ModifyItemUses](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/modifyitemuses?) Modifies the number of remaining uses of a player's inventory item.
* [MoveItemToCharacterFromCharacter](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/moveitemtocharacterfromcharacter?) Moves an item from a character's inventory into another of the users's character's inventory.
* [MoveItemToCharacterFromUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/moveitemtocharacterfromuser?) Moves an item from a user's inventory into their character's inventory.
* [MoveItemToUserFromCharacter](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/moveitemtouserfromcharacter?) Moves an item from a character's inventory into the owning user's inventory.
* [RedeemCoupon](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/redeemcoupon?) Adds the virtual goods associated with the coupon to the user's inventory. Coupons can be generated via the Economy->Catalogs tab in the PlayFab Game Manager.
* [RemoveFriend](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/friend-list-management/removefriend?) Removes the specified friend from the user's friend list.
* [RemoveGenericID](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/removegenericid?) Removes the specified generic service identifier from the player's PlayFab account.
* [RemovePlayerTag](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/playstream/removeplayertag?) Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.
* [RemoveSharedGroupMembers](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/shared-group-data/removesharedgroupmembers?) Removes users from the set of those able to update the shared data and the set of users in the group. Only users in the group can remove members. If as a result of the call, zero users remain with access, the group and its associated data will be deleted. Shared Groups are designed for sharing data between a very small number of players, see [Using Shared Group Data](/services/playfab/community/associations/groups/using-shared-group-data).
* [RevokeAllBansForUser](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/revokeallbansforuser?) Revoke all active bans for a user.
* [RevokeBans](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/revokebans?) Revoke all active bans specified with BanId.
* [RevokeInventoryItem](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/revokeinventoryitem?) Revokes access to an item in a user's inventory.
* [RevokeInventoryItems](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/revokeinventoryitems?) Revokes access for up to 25 items across multiple users and characters.
* [SetFriendTags](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/friend-list-management/setfriendtags?) Updates the tag list for a specified user in the friend list of another user.
* [SetPlayerSecret](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/authentication/setplayersecret?) Sets the player's secret if it is not already set. Player secrets are used to sign API requests. To reset a player's secret use the Admin or Server API method SetPlayerSecret.
* [SetPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/title-wide-data-management/setpublisherdata?) Updates the key-value store of custom publisher settings.
* [SetTitleData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/title-wide-data-management/settitledata?) /rest/api/services/playfab/server/title-wide-data-management/setpublisherdata?
* [SetTitleInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/title-wide-data-management/settitleinternaldata?) Updates the key-value store of custom title settings
* [SubtractCharacterVirtualCurrency](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/subtractcharactervirtualcurrency?) Decrements the character's balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.
* [SubtractUserVirtualCurrency](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/subtractuservirtualcurrency?) Decrements the user's balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.
* [UnlinkServerCustomId](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/unlinkservercustomid?) Unlinks the custom server identifier from the user's PlayFab account.
* [UnlinkXboxAccount](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/unlinkxboxaccount?) Unlinks the related XBOX Live account from the user's PlayFab account.
* [UnlockContainerInstance](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/unlockcontainerinstance?) Opens a specific container (ContainerItemInstanceId), with a specific key (KeyItemInstanceId, when required), and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
* [UnlockContainerItem](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/unlockcontaineritem?) Searches Player or Character inventory for any ItemInstance matching the given CatalogItemId, if necessary unlocks it using any appropriate key, and returns the contents of the opened container. If the container (and key when relevant) are consumable (RemainingUses > 0), their RemainingUses will be decremented, consistent with the operation of ConsumeItem.
* [UpdateAvatarUrl](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/updateavatarurl?) Update the avatar URL of the specified player.
* [UpdateBans](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/account-management/updatebans?) Updates information of a list of existing bans specified with Ban Ids.
* [UpdateCharacterData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/character-data/updatecharacterdata?) Updates the title-specific custom data for the user's character which is readable and writable by the client.
* [UpdateCharacterInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/character-data/updatecharacterinternaldata?) Updates the title-specific custom data for the user's character which cannot be accessed by the client.
* [UpdateCharacterReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/character-data/updatecharacterreadonlydata?) Updates the title-specific custom data for the user's character which can only be read by the client.
* [UpdateCharacterStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/characters/updatecharacterstatistics?) Updates the values of the specified title-specific statistics for the specific character.
* [UpdatePlayerStatistics](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/updateplayerstatistics?) Updates the values of the specified title-specific statistics for the user.
* [UpdateUserData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/updateuserdata?) Updates the title-specific custom data for the user which is readable and writable by the client.
* [UpdateUserInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/updateuserinternaldata?) Updates the title-specific custom data for the user which cannot be accessed by the client.
* [UpdateUserInventoryItemCustomData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-item-management/updateuserinventoryitemcustomdata?) Updates the key-value pair data tagged to the specified item, which is read-only from the client.
* [UpdateUserPublisherData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/updateuserpublisherdata?) Updates the publisher-specific custom data for the user which is readable and writable by the client.
* [UpdateUserPublisherInternalData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/updateuserpublisherinternaldata?) Updates the publisher-specific custom data for the user which cannot be accessed by the client.
* [UpdateUserPublisherReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/updateuserpublisherreadonlydata?) Updates the publisher-specific custom data for the user which can only be read by the client.
* [UpdateUserReadOnlyData](https://learn.microsoft.com/en-us/rest/api/services/playfab/server/player-data-management/updateuserreadonlydata?) Updates the title-specific custom data for the user which can only be read by the client.


## Related topics

- [Content & Configuration Writes Meter API Description](/services/playfab/pricing/meters/file-writes.md)
- [Profile Reads Meter API Description](/services/playfab/pricing/meters/profile-reads.md)
- [Inventory Writes Meter API Description](/services/playfab/pricing/meters/economy-writes.md)
- [Content & Configuration Reads Meter API Description](/services/playfab/pricing/meters/file-reads.md)
- [Inventory Reads Meter API Description](/services/playfab/pricing/meters/economy-reads.md)