{ "id": "PlayFabPostmanSDK", "name": "PlayFab Postman SDK 0.207.240412", "description": "PlayFab API SDK for Postman.\n\nThis is still under development, and is not yet ready for general use. Experienced users can utilize this if they carefully examine the post-body and ensure the data is properly entered. By default, the post-body is NOT defaulting to useable values.", "order": [], "events": [ { "listen": "prerequest", "script": { "id": "b7114d52-8fee-497d-bb42-4b4d1446174c", "type": "text/javascript", "exec": [ "// When enabled, the following script will ensure that the EntityToken environment", "// variable always contains a valid title entity token. To enable the script, create", "// either a global or environment variable named PlayFab_AutoTitleToken and set its ", "// value to true.", "", "if (pm.globals.get(\"PlayFab_AutoTitleToken\") !== \"true\" && ", " pm.environment.get(\"PlayFab_AutoTitleToken\") !== \"true\")", "{", " return;", "}", "", "var titleId = pm.environment.get(\"TitleId\");", "var secretKey = pm.environment.get(\"SecretKey\");", "", "if (titleId == null || secretKey == null)", "{", " return;", "}", "", "var tokenExpiration = pm.environment.get(\"TokenExpiration\");", "var todaysDate = Date.now();", "var tokenExpired = (tokenExpiration == null)", " ? true", " : Date.parse(tokenExpiration) < todaysDate;", "", "if (tokenExpired)", "{", " pm.sendRequest({", " url: 'https://' + titleId + '.playfabapi.com/Authentication/GetEntityToken',", " method: 'POST',", " header: ['X-SecretKey: ' + secretKey, 'Content-Type: application/json'],", " body: {", " }", " }, function (err, res) {", " var response = res.json();", " console.log(response);", " pm.environment.set(\"EntityToken\", response[\"data\"][\"EntityToken\"]);", " pm.environment.set(\"TokenExpiration\", response[\"data\"][\"TokenExpiration\"]);", " });", "}" ] } } ], "folders": [ { "id": "PlayFabPostmanSDK-adminFolder", "name": "admin", "description": "PlayFab admin API.", "order": [ "admin-AbortTaskInstance", "admin-AddLocalizedNews", "admin-AddNews", "admin-AddPlayerTag", "admin-AddUserVirtualCurrency", "admin-AddVirtualCurrencyTypes", "admin-BanUsers", "admin-CheckLimitedEditionItemAvailability", "admin-CreateActionsOnPlayersInSegmentTask", "admin-CreateCloudScriptTask", "admin-CreateInsightsScheduledScalingTask", "admin-CreateOpenIdConnection", "admin-CreatePlayerSharedSecret", "admin-CreatePlayerStatisticDefinition", "admin-CreateSegment", "admin-DeleteContent", "admin-DeleteMasterPlayerAccount", "admin-DeleteMasterPlayerEventData", "admin-DeleteMembershipSubscription", "admin-DeleteOpenIdConnection", "admin-DeletePlayer", "admin-DeletePlayerSharedSecret", "admin-DeleteSegment", "admin-DeleteStore", "admin-DeleteTask", "admin-DeleteTitle", "admin-DeleteTitleDataOverride", "admin-ExportMasterPlayerData", "admin-ExportPlayersInSegment", "admin-GetActionsOnPlayersInSegmentTaskInstance", "admin-GetAllSegments", "admin-GetCatalogItems", "admin-GetCloudScriptRevision", "admin-GetCloudScriptTaskInstance", "admin-GetCloudScriptVersions", "admin-GetContentList", "admin-GetContentUploadUrl", "admin-GetDataReport", "admin-GetPlayedTitleList", "admin-GetPlayerIdFromAuthToken", "admin-GetPlayerProfile", "admin-GetPlayerSegments", "admin-GetPlayerSharedSecrets", "admin-GetPlayerStatisticDefinitions", "admin-GetPlayerStatisticVersions", "admin-GetPlayerTags", "admin-GetPlayersInSegment", "admin-GetPolicy", "admin-GetPublisherData", "admin-GetRandomResultTables", "admin-GetSegmentExport", "admin-GetSegments", "admin-GetStoreItems", "admin-GetTaskInstances", "admin-GetTasks", "admin-GetTitleData", "admin-GetTitleInternalData", "admin-GetUserAccountInfo", "admin-GetUserBans", "admin-GetUserData", "admin-GetUserInternalData", "admin-GetUserInventory", "admin-GetUserPublisherData", "admin-GetUserPublisherInternalData", "admin-GetUserPublisherReadOnlyData", "admin-GetUserReadOnlyData", "admin-GrantItemsToUsers", "admin-IncrementLimitedEditionItemAvailability", "admin-IncrementPlayerStatisticVersion", "admin-ListOpenIdConnection", "admin-ListVirtualCurrencyTypes", "admin-RefundPurchase", "admin-RemovePlayerTag", "admin-RemoveVirtualCurrencyTypes", "admin-ResetCharacterStatistics", "admin-ResetPassword", "admin-ResetUserStatistics", "admin-ResolvePurchaseDispute", "admin-RevokeAllBansForUser", "admin-RevokeBans", "admin-RevokeInventoryItem", "admin-RevokeInventoryItems", "admin-RunTask", "admin-SendAccountRecoveryEmail", "admin-SetCatalogItems", "admin-SetMembershipOverride", "admin-SetPlayerSecret", "admin-SetPublishedRevision", "admin-SetPublisherData", "admin-SetStoreItems", "admin-SetTitleData", "admin-SetTitleDataAndOverrides", "admin-SetTitleInternalData", "admin-SetupPushNotification", "admin-SubtractUserVirtualCurrency", "admin-UpdateBans", "admin-UpdateCatalogItems", "admin-UpdateCloudScript", "admin-UpdateOpenIdConnection", "admin-UpdatePlayerSharedSecret", "admin-UpdatePlayerStatisticDefinition", "admin-UpdatePolicy", "admin-UpdateRandomResultTables", "admin-UpdateSegment", "admin-UpdateStoreItems", "admin-UpdateTask", "admin-UpdateUserData", "admin-UpdateUserInternalData", "admin-UpdateUserPublisherData", "admin-UpdateUserPublisherInternalData", "admin-UpdateUserPublisherReadOnlyData", "admin-UpdateUserReadOnlyData", "admin-UpdateUserTitleDisplayName" ] }, { "id": "PlayFabPostmanSDK-clientFolder", "name": "client", "description": "PlayFab client API.", "order": [ "client-AcceptTrade", "client-AddFriend", "client-AddGenericID", "client-AddOrUpdateContactEmail", "client-AddSharedGroupMembers", "client-AddUserVirtualCurrency", "client-AddUsernamePassword", "client-AndroidDevicePushNotificationRegistration", "client-AttributeInstall", "client-CancelTrade", "client-ConfirmPurchase", "client-ConsumeItem", "client-ConsumeMicrosoftStoreEntitlements", "client-ConsumePS5Entitlements", "client-ConsumePSNEntitlements", "client-ConsumeXboxEntitlements", "client-CreateSharedGroup", "client-ExecuteCloudScript", "client-GetAccountInfo", "client-GetAdPlacements", "client-GetAllUsersCharacters", "client-GetCatalogItems", "client-GetCharacterData", "client-GetCharacterInventory", "client-GetCharacterLeaderboard", "client-GetCharacterReadOnlyData", "client-GetCharacterStatistics", "client-GetContentDownloadUrl", "client-GetFriendLeaderboard", "client-GetFriendLeaderboardAroundPlayer", "client-GetFriendsList", "client-GetLeaderboard", "client-GetLeaderboardAroundCharacter", "client-GetLeaderboardAroundPlayer", "client-GetLeaderboardForUserCharacters", "client-GetPaymentToken", "client-GetPhotonAuthenticationToken", "client-GetPlayFabIDsFromFacebookIDs", "client-GetPlayFabIDsFromFacebookInstantGamesIds", "client-GetPlayFabIDsFromGameCenterIDs", "client-GetPlayFabIDsFromGenericIDs", "client-GetPlayFabIDsFromGoogleIDs", "client-GetPlayFabIDsFromGooglePlayGamesPlayerIDs", "client-GetPlayFabIDsFromKongregateIDs", "client-GetPlayFabIDsFromNintendoServiceAccountIds", "client-GetPlayFabIDsFromNintendoSwitchDeviceIds", "client-GetPlayFabIDsFromPSNAccountIDs", "client-GetPlayFabIDsFromPSNOnlineIDs", "client-GetPlayFabIDsFromSteamIDs", "client-GetPlayFabIDsFromTwitchIDs", "client-GetPlayFabIDsFromXboxLiveIDs", "client-GetPlayerCombinedInfo", "client-GetPlayerProfile", "client-GetPlayerSegments", "client-GetPlayerStatisticVersions", "client-GetPlayerStatistics", "client-GetPlayerTags", "client-GetPlayerTrades", "client-GetPublisherData", "client-GetPurchase", "client-GetSharedGroupData", "client-GetStoreItems", "client-GetTime", "client-GetTitleData", "client-GetTitleNews", "client-GetTitlePublicKey", "client-GetTradeStatus", "client-GetUserData", "client-GetUserInventory", "client-GetUserPublisherData", "client-GetUserPublisherReadOnlyData", "client-GetUserReadOnlyData", "client-GrantCharacterToUser", "client-LinkAndroidDeviceID", "client-LinkApple", "client-LinkCustomID", "client-LinkFacebookAccount", "client-LinkFacebookInstantGamesId", "client-LinkGameCenterAccount", "client-LinkGoogleAccount", "client-LinkGooglePlayGamesServicesAccount", "client-LinkIOSDeviceID", "client-LinkKongregate", "client-LinkNintendoServiceAccount", "client-LinkNintendoSwitchDeviceId", "client-LinkOpenIdConnect", "client-LinkPSNAccount", "client-LinkSteamAccount", "client-LinkTwitch", "client-LinkXboxAccount", "client-LoginWithAndroidDeviceID", "client-LoginWithApple", "client-LoginWithCustomID", "client-LoginWithEmailAddress", "client-LoginWithFacebook", "client-LoginWithFacebookInstantGamesId", "client-LoginWithGameCenter", "client-LoginWithGoogleAccount", "client-LoginWithGooglePlayGamesServices", "client-LoginWithIOSDeviceID", "client-LoginWithKongregate", "client-LoginWithNintendoServiceAccount", "client-LoginWithNintendoSwitchDeviceId", "client-LoginWithOpenIdConnect", "client-LoginWithPSN", "client-LoginWithPlayFab", "client-LoginWithSteam", "client-LoginWithTwitch", "client-LoginWithXbox", "client-OpenTrade", "client-PayForPurchase", "client-PurchaseItem", "client-RedeemCoupon", "client-RefreshPSNAuthToken", "client-RegisterForIOSPushNotification", "client-RegisterPlayFabUser", "client-RemoveContactEmail", "client-RemoveFriend", "client-RemoveGenericID", "client-RemoveSharedGroupMembers", "client-ReportAdActivity", "client-ReportDeviceInfo", "client-ReportPlayer", "client-RestoreIOSPurchases", "client-RewardAdActivity", "client-SendAccountRecoveryEmail", "client-SetFriendTags", "client-SetPlayerSecret", "client-StartPurchase", "client-SubtractUserVirtualCurrency", "client-UnlinkAndroidDeviceID", "client-UnlinkApple", "client-UnlinkCustomID", "client-UnlinkFacebookAccount", "client-UnlinkFacebookInstantGamesId", "client-UnlinkGameCenterAccount", "client-UnlinkGoogleAccount", "client-UnlinkGooglePlayGamesServicesAccount", "client-UnlinkIOSDeviceID", "client-UnlinkKongregate", "client-UnlinkNintendoServiceAccount", "client-UnlinkNintendoSwitchDeviceId", "client-UnlinkOpenIdConnect", "client-UnlinkPSNAccount", "client-UnlinkSteamAccount", "client-UnlinkTwitch", "client-UnlinkXboxAccount", "client-UnlockContainerInstance", "client-UnlockContainerItem", "client-UpdateAvatarUrl", "client-UpdateCharacterData", "client-UpdateCharacterStatistics", "client-UpdatePlayerStatistics", "client-UpdateSharedGroupData", "client-UpdateUserData", "client-UpdateUserPublisherData", "client-UpdateUserTitleDisplayName", "client-ValidateAmazonIAPReceipt", "client-ValidateGooglePlayPurchase", "client-ValidateIOSReceipt", "client-ValidateWindowsStoreReceipt", "client-WriteCharacterEvent", "client-WritePlayerEvent", "client-WriteTitleEvent" ] }, { "id": "PlayFabPostmanSDK-serverFolder", "name": "server", "description": "PlayFab server API.", "order": [ "server-AddCharacterVirtualCurrency", "server-AddFriend", "server-AddGenericID", "server-AddPlayerTag", "server-AddSharedGroupMembers", "server-AddUserVirtualCurrency", "server-AuthenticateSessionTicket", "server-AwardSteamAchievement", "server-BanUsers", "server-ConsumeItem", "server-CreateSharedGroup", "server-DeleteCharacterFromUser", "server-DeletePlayer", "server-DeletePushNotificationTemplate", "server-DeleteSharedGroup", "server-EvaluateRandomResultTable", "server-ExecuteCloudScript", "server-GetAllSegments", "server-GetAllUsersCharacters", "server-GetCatalogItems", "server-GetCharacterData", "server-GetCharacterInternalData", "server-GetCharacterInventory", "server-GetCharacterLeaderboard", "server-GetCharacterReadOnlyData", "server-GetCharacterStatistics", "server-GetContentDownloadUrl", "server-GetFriendLeaderboard", "server-GetFriendsList", "server-GetLeaderboard", "server-GetLeaderboardAroundCharacter", "server-GetLeaderboardAroundUser", "server-GetLeaderboardForUserCharacters", "server-GetPlayFabIDsFromFacebookIDs", "server-GetPlayFabIDsFromFacebookInstantGamesIds", "server-GetPlayFabIDsFromGenericIDs", "server-GetPlayFabIDsFromNintendoServiceAccountIds", "server-GetPlayFabIDsFromNintendoSwitchDeviceIds", "server-GetPlayFabIDsFromPSNAccountIDs", "server-GetPlayFabIDsFromPSNOnlineIDs", "server-GetPlayFabIDsFromSteamIDs", "server-GetPlayFabIDsFromTwitchIDs", "server-GetPlayFabIDsFromXboxLiveIDs", "server-GetPlayerCombinedInfo", "server-GetPlayerProfile", "server-GetPlayerSegments", "server-GetPlayerStatisticVersions", "server-GetPlayerStatistics", "server-GetPlayerTags", "server-GetPlayersInSegment", "server-GetPublisherData", "server-GetRandomResultTables", "server-GetServerCustomIDsFromPlayFabIDs", "server-GetSharedGroupData", "server-GetStoreItems", "server-GetTime", "server-GetTitleData", "server-GetTitleInternalData", "server-GetTitleNews", "server-GetUserAccountInfo", "server-GetUserBans", "server-GetUserData", "server-GetUserInternalData", "server-GetUserInventory", "server-GetUserPublisherData", "server-GetUserPublisherInternalData", "server-GetUserPublisherReadOnlyData", "server-GetUserReadOnlyData", "server-GrantCharacterToUser", "server-GrantItemsToCharacter", "server-GrantItemsToUser", "server-GrantItemsToUsers", "server-LinkNintendoServiceAccount", "server-LinkNintendoServiceAccountSubject", "server-LinkNintendoSwitchDeviceId", "server-LinkPSNAccount", "server-LinkPSNId", "server-LinkServerCustomId", "server-LinkSteamId", "server-LinkXboxAccount", "server-LoginWithServerCustomId", "server-LoginWithSteamId", "server-LoginWithXbox", "server-LoginWithXboxId", "server-ModifyItemUses", "server-MoveItemToCharacterFromCharacter", "server-MoveItemToCharacterFromUser", "server-MoveItemToUserFromCharacter", "server-RedeemCoupon", "server-RemoveFriend", "server-RemoveGenericID", "server-RemovePlayerTag", "server-RemoveSharedGroupMembers", "server-ReportPlayer", "server-RevokeAllBansForUser", "server-RevokeBans", "server-RevokeInventoryItem", "server-RevokeInventoryItems", "server-SavePushNotificationTemplate", "server-SendCustomAccountRecoveryEmail", "server-SendEmailFromTemplate", "server-SendPushNotification", "server-SendPushNotificationFromTemplate", "server-SetFriendTags", "server-SetPlayerSecret", "server-SetPublisherData", "server-SetTitleData", "server-SetTitleInternalData", "server-SubtractCharacterVirtualCurrency", "server-SubtractUserVirtualCurrency", "server-UnlinkNintendoServiceAccount", "server-UnlinkNintendoSwitchDeviceId", "server-UnlinkPSNAccount", "server-UnlinkServerCustomId", "server-UnlinkSteamId", "server-UnlinkXboxAccount", "server-UnlockContainerInstance", "server-UnlockContainerItem", "server-UpdateAvatarUrl", "server-UpdateBans", "server-UpdateCharacterData", "server-UpdateCharacterInternalData", "server-UpdateCharacterReadOnlyData", "server-UpdateCharacterStatistics", "server-UpdatePlayerStatistics", "server-UpdateSharedGroupData", "server-UpdateUserData", "server-UpdateUserInternalData", "server-UpdateUserInventoryItemCustomData", "server-UpdateUserPublisherData", "server-UpdateUserPublisherInternalData", "server-UpdateUserPublisherReadOnlyData", "server-UpdateUserReadOnlyData", "server-WriteCharacterEvent", "server-WritePlayerEvent", "server-WriteTitleEvent" ] }, { "id": "PlayFabPostmanSDK-authenticationFolder", "name": "authentication", "description": "PlayFab authentication API.", "order": [ "authentication-AuthenticateGameServerWithCustomId", "authentication-Delete", "authentication-GetEntityToken", "authentication-ValidateEntityToken" ] }, { "id": "PlayFabPostmanSDK-cloudscriptFolder", "name": "cloudscript", "description": "PlayFab cloudscript API.", "order": [ "cloudscript-ExecuteEntityCloudScript", "cloudscript-ExecuteFunction", "cloudscript-GetFunction", "cloudscript-ListFunctions", "cloudscript-ListHttpFunctions", "cloudscript-ListQueuedFunctions", "cloudscript-PostFunctionResultForEntityTriggeredAction", "cloudscript-PostFunctionResultForFunctionExecution", "cloudscript-PostFunctionResultForPlayerTriggeredAction", "cloudscript-PostFunctionResultForScheduledTask", "cloudscript-RegisterHttpFunction", "cloudscript-RegisterQueuedFunction", "cloudscript-UnregisterFunction" ] }, { "id": "PlayFabPostmanSDK-dataFolder", "name": "data", "description": "PlayFab data API.", "order": [ "data-AbortFileUploads", "data-DeleteFiles", "data-FinalizeFileUploads", "data-GetFiles", "data-GetObjects", "data-InitiateFileUploads", "data-SetObjects" ] }, { "id": "PlayFabPostmanSDK-economyFolder", "name": "economy", "description": "PlayFab economy API.", "order": [ "economy-AddInventoryItems", "economy-CreateDraftItem", "economy-CreateUploadUrls", "economy-DeleteEntityItemReviews", "economy-DeleteInventoryCollection", "economy-DeleteInventoryItems", "economy-DeleteItem", "economy-ExecuteInventoryOperations", "economy-ExecuteTransferOperations", "economy-GetCatalogConfig", "economy-GetDraftItem", "economy-GetDraftItems", "economy-GetEntityDraftItems", "economy-GetEntityItemReview", "economy-GetInventoryCollectionIds", "economy-GetInventoryItems", "economy-GetInventoryOperationStatus", "economy-GetItem", "economy-GetItemContainers", "economy-GetItemModerationState", "economy-GetItemPublishStatus", "economy-GetItemReviewSummary", "economy-GetItemReviews", "economy-GetItems", "economy-GetMicrosoftStoreAccessTokens", "economy-GetTransactionHistory", "economy-PublishDraftItem", "economy-PurchaseInventoryItems", "economy-RedeemAppleAppStoreInventoryItems", "economy-RedeemGooglePlayInventoryItems", "economy-RedeemMicrosoftStoreInventoryItems", "economy-RedeemNintendoEShopInventoryItems", "economy-RedeemPlayStationStoreInventoryItems", "economy-RedeemSteamInventoryItems", "economy-ReportItem", "economy-ReportItemReview", "economy-ReviewItem", "economy-SearchItems", "economy-SetItemModerationState", "economy-SubmitItemReviewVote", "economy-SubtractInventoryItems", "economy-TakedownItemReviews", "economy-TransferInventoryItems", "economy-UpdateCatalogConfig", "economy-UpdateDraftItem", "economy-UpdateInventoryItems" ] }, { "id": "PlayFabPostmanSDK-eventsFolder", "name": "events", "description": "PlayFab events API.", "order": [ "events-CreateTelemetryKey", "events-DeleteTelemetryKey", "events-GetTelemetryKey", "events-ListTelemetryKeys", "events-SetTelemetryKeyActive", "events-WriteEvents", "events-WriteTelemetryEvents" ] }, { "id": "PlayFabPostmanSDK-experimentationFolder", "name": "experimentation", "description": "PlayFab experimentation API.", "order": [ "experimentation-CreateExclusionGroup", "experimentation-CreateExperiment", "experimentation-DeleteExclusionGroup", "experimentation-DeleteExperiment", "experimentation-GetExclusionGroupTraffic", "experimentation-GetExclusionGroups", "experimentation-GetExperiments", "experimentation-GetLatestScorecard", "experimentation-GetTreatmentAssignment", "experimentation-StartExperiment", "experimentation-StopExperiment", "experimentation-UpdateExclusionGroup", "experimentation-UpdateExperiment" ] }, { "id": "PlayFabPostmanSDK-insightsFolder", "name": "insights", "description": "PlayFab insights API.", "order": [ "insights-GetDetails", "insights-GetLimits", "insights-GetOperationStatus", "insights-GetPendingOperations", "insights-SetPerformance", "insights-SetStorageRetention" ] }, { "id": "PlayFabPostmanSDK-groupsFolder", "name": "groups", "description": "PlayFab groups API.", "order": [ "groups-AcceptGroupApplication", "groups-AcceptGroupInvitation", "groups-AddMembers", "groups-ApplyToGroup", "groups-BlockEntity", "groups-ChangeMemberRole", "groups-CreateGroup", "groups-CreateRole", "groups-DeleteGroup", "groups-DeleteRole", "groups-GetGroup", "groups-InviteToGroup", "groups-IsMember", "groups-ListGroupApplications", "groups-ListGroupBlocks", "groups-ListGroupInvitations", "groups-ListGroupMembers", "groups-ListMembership", "groups-ListMembershipOpportunities", "groups-RemoveGroupApplication", "groups-RemoveGroupInvitation", "groups-RemoveMembers", "groups-UnblockEntity", "groups-UpdateGroup", "groups-UpdateRole" ] }, { "id": "PlayFabPostmanSDK-localizationFolder", "name": "localization", "description": "PlayFab localization API.", "order": [ "localization-GetLanguageList" ] }, { "id": "PlayFabPostmanSDK-multiplayerFolder", "name": "multiplayer", "description": "PlayFab multiplayer API.", "order": [ "multiplayer-CancelAllMatchmakingTicketsForPlayer", "multiplayer-CancelAllServerBackfillTicketsForPlayer", "multiplayer-CancelMatchmakingTicket", "multiplayer-CancelServerBackfillTicket", "multiplayer-CreateBuildAlias", "multiplayer-CreateBuildWithCustomContainer", "multiplayer-CreateBuildWithManagedContainer", "multiplayer-CreateBuildWithProcessBasedServer", "multiplayer-CreateLobby", "multiplayer-CreateMatchmakingTicket", "multiplayer-CreateRemoteUser", "multiplayer-CreateServerBackfillTicket", "multiplayer-CreateServerMatchmakingTicket", "multiplayer-CreateTitleMultiplayerServersQuotaChange", "multiplayer-DeleteAsset", "multiplayer-DeleteBuild", "multiplayer-DeleteBuildAlias", "multiplayer-DeleteBuildRegion", "multiplayer-DeleteCertificate", "multiplayer-DeleteContainerImageRepository", "multiplayer-DeleteLobby", "multiplayer-DeleteRemoteUser", "multiplayer-EnableMultiplayerServersForTitle", "multiplayer-FindFriendLobbies", "multiplayer-FindLobbies", "multiplayer-GetAssetDownloadUrl", "multiplayer-GetAssetUploadUrl", "multiplayer-GetBuild", "multiplayer-GetBuildAlias", "multiplayer-GetContainerRegistryCredentials", "multiplayer-GetLobby", "multiplayer-GetMatch", "multiplayer-GetMatchmakingQueue", "multiplayer-GetMatchmakingTicket", "multiplayer-GetMultiplayerServerDetails", "multiplayer-GetMultiplayerServerLogs", "multiplayer-GetMultiplayerSessionLogsBySessionId", "multiplayer-GetQueueStatistics", "multiplayer-GetRemoteLoginEndpoint", "multiplayer-GetServerBackfillTicket", "multiplayer-GetTitleEnabledForMultiplayerServersStatus", "multiplayer-GetTitleMultiplayerServersQuotaChange", "multiplayer-GetTitleMultiplayerServersQuotas", "multiplayer-InviteToLobby", "multiplayer-JoinArrangedLobby", "multiplayer-JoinLobby", "multiplayer-JoinLobbyAsServer", "multiplayer-JoinMatchmakingTicket", "multiplayer-LeaveLobby", "multiplayer-LeaveLobbyAsServer", "multiplayer-ListArchivedMultiplayerServers", "multiplayer-ListAssetSummaries", "multiplayer-ListBuildAliases", "multiplayer-ListBuildSummariesV2", "multiplayer-ListCertificateSummaries", "multiplayer-ListContainerImageTags", "multiplayer-ListContainerImages", "multiplayer-ListMatchmakingQueues", "multiplayer-ListMatchmakingTicketsForPlayer", "multiplayer-ListMultiplayerServers", "multiplayer-ListPartyQosServers", "multiplayer-ListQosServersForTitle", "multiplayer-ListServerBackfillTicketsForPlayer", "multiplayer-ListTitleMultiplayerServersQuotaChanges", "multiplayer-ListVirtualMachineSummaries", "multiplayer-RemoveMatchmakingQueue", "multiplayer-RemoveMember", "multiplayer-RequestMultiplayerServer", "multiplayer-RequestPartyService", "multiplayer-RolloverContainerRegistryCredentials", "multiplayer-SetMatchmakingQueue", "multiplayer-ShutdownMultiplayerServer", "multiplayer-SubscribeToLobbyResource", "multiplayer-SubscribeToMatchmakingResource", "multiplayer-UnsubscribeFromLobbyResource", "multiplayer-UnsubscribeFromMatchmakingResource", "multiplayer-UntagContainerImage", "multiplayer-UpdateBuildAlias", "multiplayer-UpdateBuildName", "multiplayer-UpdateBuildRegion", "multiplayer-UpdateBuildRegions", "multiplayer-UpdateLobby", "multiplayer-UpdateLobbyAsServer", "multiplayer-UploadCertificate" ] }, { "id": "PlayFabPostmanSDK-profilesFolder", "name": "profiles", "description": "PlayFab profiles API.", "order": [ "profiles-GetGlobalPolicy", "profiles-GetProfile", "profiles-GetProfiles", "profiles-GetTitlePlayersFromMasterPlayerAccountIds", "profiles-GetTitlePlayersFromXboxLiveIDs", "profiles-SetGlobalPolicy", "profiles-SetProfileLanguage", "profiles-SetProfilePolicy" ] } ], "requests": [ { "id": "admin-AbortTaskInstance", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/AbortTaskInstance?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AbortTaskInstance", "description": "Abort an ongoing task instance.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/aborttaskinstance\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"TaskInstanceId\": ID of a task instance that is being aborted.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"TaskInstanceId\": \"E52531B47B1761C7-4\"\n}" }, { "id": "admin-AddLocalizedNews", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/AddLocalizedNews?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddLocalizedNews", "description": "Update news item to include localized version\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addlocalizednews\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Body\": Localized body text of the news.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Language\": Language of the news item.\n\n\"NewsId\": Unique id of the updated news item.\n\n\"Title\": Localized title (headline) of the news item.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"NewsId\": \"74623b12-6c80-ee4b-7c3b-58e638aa62bd\",\n \"Language\": \"en\",\n \"Title\": \"News of the Day\",\n \"Body\": \"We have a new object to buy!\"\n}" }, { "id": "admin-AddNews", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/AddNews?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddNews", "description": "Adds a new news item to the title's news feed\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addnews\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Body\": Default body text of the news.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Timestamp\": Time this news was published. If not set, defaults to now.\n\n\"Title\": Default title (headline) of the news item.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Timestamp\": \"2014-04-06T00:00:00Z\",\n \"Title\": \"News of the Day\",\n \"Body\": \"We have a new object to buy!\"\n}" }, { "id": "admin-AddPlayerTag", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/AddPlayerTag?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddPlayerTag", "description": "Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/playstream/addplayertag\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"TagName\": Unique tag for player profile.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"TagName\": \"MostKilled\"\n}" }, { "id": "admin-AddUserVirtualCurrency", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/AddUserVirtualCurrency?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddUserVirtualCurrency", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increments the specified virtual currency by the stated amount\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/adduservirtualcurrency\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Amount\": Amount to be added to the user balance of the specified virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase over this value will be discarded.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": PlayFab unique identifier of the user whose virtual currency balance is to be increased.\n\n\"VirtualCurrency\": Name of the virtual currency which is to be incremented.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"VirtualCurrency\": \"GC\",\n \"Amount\": 100\n}" }, { "id": "admin-AddVirtualCurrencyTypes", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/AddVirtualCurrencyTypes?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddVirtualCurrencyTypes", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ 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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/addvirtualcurrencytypes\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"VirtualCurrencies\": List of virtual currencies and their initial deposits (the amount a user is granted when signing in for the first time) to the title\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"VirtualCurrencies\": [\n {\n \"CurrencyCode\": \"CC\",\n \"DisplayName\": \"Chump Coins\",\n \"InitialDeposit\": 100,\n \"RechargeRate\": 1000,\n \"RechargeMax\": 1000\n },\n {\n \"CurrencyCode\": \"GC\"\n }\n ]\n}" }, { "id": "admin-BanUsers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/BanUsers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "BanUsers", "description": "Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/banusers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Bans\": List of ban requests to be applied. Maximum 100.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Bans\": [\n {\n \"PlayFabId\": \"1679AF5CD04BD838\",\n \"IPAddress\": \"192.168.1.1\",\n \"Reason\": \"You cheated!\",\n \"DurationInHours\": 7\n },\n {\n \"PlayFabId\": \"2329AF5CD04BF513\",\n \"Reason\": \"Caught you using speed hack!\"\n }\n ]\n}" }, { "id": "admin-CheckLimitedEditionItemAvailability", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/CheckLimitedEditionItemAvailability?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CheckLimitedEditionItemAvailability", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Checks the global count for the limited edition item.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/checklimitededitionitemavailability\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Which catalog is being updated. If null, uses the default catalog.\n\n\"ItemId\": The item to check for.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\",\n \"ItemId\": \"FreeHoodie\"\n}" }, { "id": "admin-CreateActionsOnPlayersInSegmentTask", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/CreateActionsOnPlayersInSegmentTask?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateActionsOnPlayersInSegmentTask", "description": "Create an ActionsOnPlayersInSegment task, which iterates through all players in a segment to execute action.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createactionsonplayersinsegmenttask\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Description\": Description the task\n\n\"IsActive\": Whether the schedule is active. Inactive schedule will not trigger task execution.\n\n\"Name\": Name of the task. This is a unique identifier for tasks in the title.\n\n\"Parameter\": Task details related to segment and action\n\n\"Schedule\": Cron expression for the run schedule of the task. The expression should be in UTC.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Name\": \"PushNotificationVIP_Halloween\",\n \"Description\": \"Send push notification to VIP players about Halloween event\",\n \"IsActive\": false,\n \"Parameter\": {\n \"SegmentId\": \"274828AF93F13472\",\n \"Actions\": [\n {\n \"GrantItemContent\": {\n \"CatalogVersion\": \"foo\",\n \"ItemId\": \"bar\",\n \"ItemQuantity\": 1\n }\n }\n ]\n }\n}" }, { "id": "admin-CreateCloudScriptTask", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/CreateCloudScriptTask?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateCloudScriptTask", "description": "Create a CloudScript task, which can run a CloudScript on a schedule.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createcloudscripttask\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Description\": Description the task\n\n\"IsActive\": Whether the schedule is active. Inactive schedule will not trigger task execution.\n\n\"Name\": Name of the task. This is a unique identifier for tasks in the title.\n\n\"Parameter\": Task details related to CloudScript\n\n\"Schedule\": Cron expression for the run schedule of the task. The expression should be in UTC.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Name\": \"EnableWeekdayHappyHour\",\n \"Description\": \"Turn on special pricing for weekday happy hour.\",\n \"Schedule\": \"0 17 * * 1-5\",\n \"IsActive\": false,\n \"Parameter\": {\n \"FunctionName\": \"applyStorePreset\",\n \"Argument\": {\n \"preset\": \"WeekdayHappyHour\"\n }\n }\n}" }, { "id": "admin-CreateInsightsScheduledScalingTask", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/CreateInsightsScheduledScalingTask?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateInsightsScheduledScalingTask", "description": "Create a Insights Scheduled Scaling task, which can scale Insights Performance Units on a schedule\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createinsightsscheduledscalingtask\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Description\": Description the task\n\n\"IsActive\": Whether the schedule is active. Inactive schedule will not trigger task execution.\n\n\"Name\": Name of the task. This is a unique identifier for tasks in the title.\n\n\"Parameter\": Task details related to Insights Scaling\n\n\"Schedule\": Cron expression for the run schedule of the task. The expression should be in UTC.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Name\": \"EnableWeekdayPerformance\",\n \"Description\": \"Scale up Insights Performance Units during weekdays.\",\n \"Schedule\": \"0 0 * * 1-5\",\n \"IsActive\": false,\n \"Parameter\": {\n \"Level\": 3\n }\n}" }, { "id": "admin-CreateOpenIdConnection", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/CreateOpenIdConnection?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateOpenIdConnection", "description": "Registers a relationship between a title and an Open ID Connect provider.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/authentication/createopenidconnection\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ClientId\": The client ID given by the ID provider.\n\n\"ClientSecret\": The client secret given by the ID provider.\n\n\"ConnectionId\": A name for the connection that identifies it within the title.\n\n\"IgnoreNonce\": Ignore 'nonce' claim in identity tokens.\n\n\"IssuerDiscoveryUrl\": The discovery document URL to read issuer information from. This must be the absolute URL to the JSON OpenId Configuration document and must be accessible from the internet. If you don't know it, try your issuer URL followed by \"/.well-known/openid-configuration\". For example, if the issuer is https://example.com, try https://example.com/.well-known/openid-configuration\n\n\"IssuerInformation\": Manually specified information for an OpenID Connect issuer.\n\n\"IssuerOverride\": Override the issuer name for user indexing and lookup.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"ConnectionId\": \"oidconnection1\",\n \"ClientId\": \"example_id_1\",\n \"ClientSecret\": \"example_secret_1\",\n \"IssuerInformation\": {\n \"Issuer\": \"https://issuer.example.com/\",\n \"AuthorizationUrl\": \"https://issuer.example.com/authorize\",\n \"TokenUrl\": \"https://issuer.example.com/oauth2/token\",\n \"JsonWebKeySet\": {\n \"keys\": [\n \"...\"\n ]\n }\n },\n \"IssuerOverride\": \"https://issueroverride.example.com/\",\n \"IgnoreNonce\": true\n}" }, { "id": "admin-CreatePlayerSharedSecret", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/CreatePlayerSharedSecret?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreatePlayerSharedSecret", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/authentication/createplayersharedsecret\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"FriendlyName\": Friendly name for this key\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"FriendlyName\": \"iOS Users\"\n}" }, { "id": "admin-CreatePlayerStatisticDefinition", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/CreatePlayerStatisticDefinition?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreatePlayerStatisticDefinition", "description": "Adds a new player statistic configuration to the title, optionally allowing the developer to specify a reset interval and an aggregation method.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/createplayerstatisticdefinition\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AggregationMethod\": the aggregation method to use in updating the statistic (defaults to last)\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"StatisticName\": unique name of the statistic\n\n\"VersionChangeInterval\": interval at which the values of the statistic for all players are reset (resets begin at the next interval boundary)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"StatisticName\": \"headshots\",\n \"VersionChangeInterval\": \"Never\",\n \"ShouldProvisionLeaderboard\": false\n}" }, { "id": "admin-CreateSegment", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/CreateSegment?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateSegment", "description": "Creates a new player segment by defining the conditions on player properties. Also, create actions to target the player segments for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/segments/createsegment\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"SegmentModel\": Segment model with all of the segment properties data.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"SegmentModel\": \"Object\"\n}" }, { "id": "admin-DeleteContent", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/DeleteContent?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteContent", "description": "Delete a content file from the title. When deleting a file that does not exist, it returns success.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/content/deletecontent\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Key\": Key of the content item to be deleted\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Key\": \"images/sword_icon.png\"\n}" }, { "id": "admin-DeleteMasterPlayerAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/DeleteMasterPlayerAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteMasterPlayerAccount", "description": "Removes a master player account entirely from all titles and deletes all associated data\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayeraccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"MetaData\": Developer created string to identify a user without PlayFab ID\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"MetaData\": \"Identifying info\"\n}" }, { "id": "admin-DeleteMasterPlayerEventData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/DeleteMasterPlayerEventData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteMasterPlayerEventData", "description": "Deletes PlayStream and telemetry event data associated with the master player account from PlayFab storage\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemasterplayereventdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "admin-DeleteMembershipSubscription", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/DeleteMembershipSubscription?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteMembershipSubscription", "description": "Deletes a player's subscription\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletemembershipsubscription\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"MembershipId\": Id of the membership to apply the override expiration date to.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"SubscriptionId\": Id of the subscription that should be deleted from the membership.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"MembershipId\": \"ShieldBonusMembership\",\n \"SubscriptionId\": \"39F6B89A-0F0C-4D96-B12C-BA89543A11A1\",\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "admin-DeleteOpenIdConnection", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/DeleteOpenIdConnection?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteOpenIdConnection", "description": "Removes a relationship between a title and an OpenID Connect provider.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteopenidconnection\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ConnectionId\": unique name of the connection\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"ConnectionId\": \"oidconnection1\"\n}" }, { "id": "admin-DeletePlayer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/DeletePlayer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeletePlayer", "description": "Removes a user's player account from a title and deletes all associated data\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/deleteplayer\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "admin-DeletePlayerSharedSecret", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/DeletePlayerSharedSecret?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeletePlayerSharedSecret", "description": "Deletes an existing Player Shared Secret Key. It may take up to 5 minutes for this delete to be reflected after this API returns.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/authentication/deleteplayersharedsecret\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"SecretKey\": The shared secret key to delete\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"SecretKey\": \"keysaresecret\"\n}" }, { "id": "admin-DeleteSegment", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/DeleteSegment?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteSegment", "description": "Deletes an existing player segment and its associated action(s) for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/segments/deletesegment\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"SegmentId\": Segment id.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"SegmentId\": \"97EF0E9302CBE996\"\n}" }, { "id": "admin-DeleteStore", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/DeleteStore?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteStore", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Deletes an existing virtual item store\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletestore\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": catalog version of the store to delete. If null, uses the default catalog.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"StoreId\": unqiue identifier for the store which is to be deleted\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"StoreId\": \"BonusStore\"\n}" }, { "id": "admin-DeleteTask", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/DeleteTask?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteTask", "description": "Delete a task.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/deletetask\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Identifier\": Specify either the task ID or the name of task to be deleted.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Identifier\": {\n \"Id\": \"E1772FD927D8539D\"\n }\n}" }, { "id": "admin-DeleteTitle", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/DeleteTitle?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteTitle", "description": "Permanently deletes a title and all associated configuration\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/deletetitle\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{}" }, { "id": "admin-DeleteTitleDataOverride", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/DeleteTitleDataOverride?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteTitleDataOverride", "description": "Deletes a specified set of title data overrides.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/deletetitledataoverride\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"OverrideLabel\": Name of the override.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"OverrideLabel\": \"LaunchData\"\n}" }, { "id": "admin-ExportMasterPlayerData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/ExportMasterPlayerData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ExportMasterPlayerData", "description": "Exports all associated data of a master player account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/exportmasterplayerdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "admin-ExportPlayersInSegment", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/ExportPlayersInSegment?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ExportPlayersInSegment", "description": "Starts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which match the segment definition at the time of the API call. Profiles which change while an export is in progress will not be reflected in the results.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/playstream/exportplayersinsegment\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"SegmentId\": Unique identifier of the requested segment.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"SegmentId\": \"ABCDEF1234567890\"\n}" }, { "id": "admin-GetActionsOnPlayersInSegmentTaskInstance", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetActionsOnPlayersInSegmentTaskInstance?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetActionsOnPlayersInSegmentTaskInstance", "description": "Get information about a ActionsOnPlayersInSegment task instance.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getactionsonplayersinsegmenttaskinstance\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"TaskInstanceId\": ID of the requested task instance.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"TaskInstanceId\": \"E52531B47B1761C7-4\"\n}" }, { "id": "admin-GetAllSegments", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetAllSegments?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetAllSegments", "description": "Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/playstream/getallsegments\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{}" }, { "id": "admin-GetCatalogItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetCatalogItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCatalogItems", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getcatalogitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Which catalog is being requested. If null, uses the default catalog.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\"\n}" }, { "id": "admin-GetCloudScriptRevision", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetCloudScriptRevision?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCloudScriptRevision", "description": "Gets the contents and information of a specific Cloud Script revision.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptrevision\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Revision\": Revision number. If left null, defaults to the latest revision\n\n\"Version\": Version number. If left null, defaults to the latest version\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Version\": 1,\n \"Revision\": 3\n}" }, { "id": "admin-GetCloudScriptTaskInstance", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetCloudScriptTaskInstance?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCloudScriptTaskInstance", "description": "Get detail information about a CloudScript task instance.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/getcloudscripttaskinstance\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"TaskInstanceId\": ID of the requested task instance.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"TaskInstanceId\": \"E52531B47B1761C7-4\"\n}" }, { "id": "admin-GetCloudScriptVersions", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetCloudScriptVersions?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCloudScriptVersions", "description": "Lists all the current cloud script versions. For each version, information about the current published and latest revisions is also listed.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/getcloudscriptversions\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{}" }, { "id": "admin-GetContentList", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetContentList?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetContentList", "description": "List all contents of the title and get statistics such as size\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/content/getcontentlist\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Prefix\": Limits the response to keys that begin with the specified prefix. You can use prefixes to list contents under a folder, or for a specified version, etc.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Prefix\": \"2016/1\"\n}" }, { "id": "admin-GetContentUploadUrl", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetContentUploadUrl?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetContentUploadUrl", "description": "Retrieves the pre-signed URL for uploading a content file. A subsequent HTTP PUT to the returned URL uploads the content. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/content/getcontentuploadurl\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ContentType\": A standard MIME type describing the format of the contents. The same MIME type has to be set in the header when uploading the content. If not specified, the MIME type is 'binary/octet-stream' by default.\n\n\"Key\": Key of the content item to upload, usually formatted as a path, e.g. images/a.png\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Key\": \"images/sword_icon.png\",\n \"ContentType\": \"image/png\"\n}" }, { "id": "admin-GetDataReport", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetDataReport?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetDataReport", "description": "Retrieves a download URL for the requested report\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getdatareport\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Day\": Reporting year (UTC)\n\n\"Month\": Reporting month (UTC)\n\n\"ReportName\": Report name\n\n\"Year\": Reporting year (UTC)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"ReportName\": \"PurchaseDataReport\",\n \"Year\": 2014,\n \"Month\": 12,\n \"Day\": 5\n}" }, { "id": "admin-GetPlayedTitleList", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetPlayedTitleList?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayedTitleList", "description": "Get the list of titles that the player has played\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayedtitlelist\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "admin-GetPlayerIdFromAuthToken", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetPlayerIdFromAuthToken?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerIdFromAuthToken", "description": "Gets a player's ID from an auth token.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayeridfromauthtoken\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Token\": The auth token of the player requesting the password reset.\n\n\"TokenType\": The type of auth token of the player requesting the password reset.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Token\": \"3F584AD0EF943E2\",\n \"TokenType\": \"Email\"\n}" }, { "id": "admin-GetPlayerProfile", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetPlayerProfile?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerProfile", "description": "Retrieves the player's profile\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayerprofile\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"ProfileConstraints\": If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager \"Client Profile Options\" tab in the \"Settings\" section.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "admin-GetPlayerSegments", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetPlayerSegments?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerSegments", "description": "List all segments that a player currently belongs to at this moment in time.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersegments\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "admin-GetPlayerSharedSecrets", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetPlayerSharedSecrets?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerSharedSecrets", "description": "Returns all Player Shared Secret Keys including disabled and expired.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/authentication/getplayersharedsecrets\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{}" }, { "id": "admin-GetPlayerStatisticDefinitions", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetPlayerStatisticDefinitions?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerStatisticDefinitions", "description": "Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have a reset interval.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticdefinitions\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{}" }, { "id": "admin-GetPlayerStatisticVersions", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetPlayerStatisticVersions?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerStatisticVersions", "description": "Retrieves the information on the available versions of the specified statistic.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayerstatisticversions\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"StatisticName\": unique name of the statistic\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"StatisticName\": \"headshots\"\n}" }, { "id": "admin-GetPlayerTags", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetPlayerTags?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerTags", "description": "Get all tags with a given Namespace (optional) from a player profile.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayertags\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Namespace\": Optional namespace to filter results by\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Namespace\": \"title.AAA\"\n}" }, { "id": "admin-GetPlayersInSegment", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetPlayersInSegment?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayersInSegment", "description": "Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being called 30 times in one minute. You will be returned an error if you exceed this threshold.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersinsegment\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ContinuationToken\": Continuation token if retrieving subsequent pages of results.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"GetProfilesAsync\": If set to true, the profiles are loaded asynchronously and the response will include a continuation token and approximate profile count until the first batch of profiles is loaded. Use this parameter to help avoid network timeouts.\n\n\"MaxBatchSize\": Maximum is 10,000. The value 0 will prevent loading any profiles and return only the count of profiles matching this segment.\n\n\"SecondsToLive\": Number of seconds to keep the continuation token active. After token expiration it is not possible to continue paging results. Default is 300 (5 minutes). Maximum is 5,400 (90 minutes).\n\n\"SegmentId\": Unique identifier for this segment.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"SegmentId\": \"1337AA00\",\n \"SecondsToLive\": 5,\n \"MaxBatchSize\": 500\n}" }, { "id": "admin-GetPolicy", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetPolicy?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPolicy", "description": "Gets the requested policy.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/authentication/getpolicy\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PolicyName\": The name of the policy to read. Only supported name is 'ApiPolicy'.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PolicyName\": \"ApiPolicy\"\n}" }, { "id": "admin-GetPublisherData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetPublisherData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPublisherData", "description": "Retrieves the key-value store of custom publisher settings\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getpublisherdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Keys\": array of keys to get back data from the Publisher data blob, set by the admin tools\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Keys\": [\n \"color\",\n \"propertyA\"\n ]\n}" }, { "id": "admin-GetRandomResultTables", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetRandomResultTables?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetRandomResultTables", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the random drop table configuration for the title\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getrandomresulttables\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": catalog version to fetch tables from. Use default catalog version if null\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{}" }, { "id": "admin-GetSegmentExport", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetSegmentExport?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetSegmentExport", "description": "Retrieves the result of an export started by ExportPlayersInSegment API. If the ExportPlayersInSegment is successful and complete, this API returns the IndexUrl from which the index file can be downloaded. The index file has a list of urls from which the files containing the player profile data can be downloaded. Otherwise, it returns the current 'State' of the export\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/playstream/getsegmentexport\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ExportId\": Unique identifier of the export for the requested Segment.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"ExportId\": \"ABCDEF1234567890\"\n}" }, { "id": "admin-GetSegments", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetSegments?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetSegments", "description": "Get detail information of a segment and its associated definition(s) and action(s) for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/segments/getsegments\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"SegmentIds\": Segment ids to filter title segments.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"SegmentIds\": [\n \"B05FC8CB558A6570\",\n \"97EF0E9302CBE996\"\n ]\n}" }, { "id": "admin-GetStoreItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetStoreItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetStoreItems", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the set of items defined for the specified store, including all prices defined\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/getstoreitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version to store items from. Use default catalog version if null\n\n\"StoreId\": Unqiue identifier for the store which is being requested.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"StoreId\": \"BonusStore\"\n}" }, { "id": "admin-GetTaskInstances", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetTaskInstances?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTaskInstances", "description": "Query for task instances by task, status, or time range.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettaskinstances\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"StartedAtRangeFrom\": Optional range-from filter for task instances' StartedAt timestamp.\n\n\"StartedAtRangeTo\": Optional range-to filter for task instances' StartedAt timestamp.\n\n\"StatusFilter\": Optional filter for task instances that are of a specific status.\n\n\"TaskIdentifier\": Name or ID of the task whose instances are being queried. If not specified, return all task instances that satisfy conditions set by other filters.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"StatusFilter\": \"Failed\",\n \"StartedAtRangeFrom\": \"2016-08-23T11:00:00Z\"\n}" }, { "id": "admin-GetTasks", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetTasks?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTasks", "description": "Get definition information on a specified task or all tasks within a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/gettasks\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Identifier\": Provide either the task ID or the task name to get a specific task. If not specified, return all defined tasks.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Identifier\": {\n \"Name\": \"EnableDailyHappyHour\"\n }\n}" }, { "id": "admin-GetTitleData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetTitleData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTitleData", "description": "Retrieves the key-value store of custom title settings which can be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitledata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Keys\": Specific keys to search for in the title data (leave null to get all keys)\n\n\"OverrideLabel\": Optional field that specifies the name of an override. This value is ignored when used by the game client; otherwise, the overrides are applied automatically to the title data.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Keys\": [\n \"color\",\n \"propertyA\"\n ]\n}" }, { "id": "admin-GetTitleInternalData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetTitleInternalData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTitleInternalData", "description": "Retrieves the key-value store of custom title settings which cannot be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/gettitleinternaldata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Keys\": Specific keys to search for in the title data (leave null to get all keys)\n\n\"OverrideLabel\": Optional field that specifies the name of an override. This value is ignored when used by the game client; otherwise, the overrides are applied automatically to the title data.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Keys\": [\n \"color\",\n \"propertyA\"\n ]\n}" }, { "id": "admin-GetUserAccountInfo", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetUserAccountInfo?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserAccountInfo", "description": "Retrieves the relevant details for a specified user, based upon a match against a supplied unique identifier\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuseraccountinfo\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Email\": User email address attached to their account\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"TitleDisplayName\": Title specific username to match against existing user accounts\n\n\"Username\": PlayFab username for the account (3-20 characters)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"IgnoreMissingTitleActivation\": false\n}" }, { "id": "admin-GetUserBans", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetUserBans?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserBans", "description": "Gets all bans for a user.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/getuserbans\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "admin-GetUserData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetUserData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserData", "description": "Retrieves the title-specific custom data for the user which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}" }, { "id": "admin-GetUserInternalData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetUserInternalData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserInternalData", "description": "Retrieves the title-specific custom data for the user which cannot be accessed by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserinternaldata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}" }, { "id": "admin-GetUserInventory", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetUserInventory?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserInventory", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified user's current inventory of virtual goods\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/getuserinventory\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "admin-GetUserPublisherData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetUserPublisherData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserPublisherData", "description": "Retrieves the publisher-specific custom data for the user which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}" }, { "id": "admin-GetUserPublisherInternalData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetUserPublisherInternalData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserPublisherInternalData", "description": "Retrieves the publisher-specific custom data for the user which cannot be accessed by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherinternaldata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}" }, { "id": "admin-GetUserPublisherReadOnlyData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetUserPublisherReadOnlyData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserPublisherReadOnlyData", "description": "Retrieves the publisher-specific custom data for the user which can only be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserpublisherreadonlydata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}" }, { "id": "admin-GetUserReadOnlyData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GetUserReadOnlyData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserReadOnlyData", "description": "Retrieves the title-specific custom data for the user which can only be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getuserreadonlydata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}" }, { "id": "admin-GrantItemsToUsers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/GrantItemsToUsers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GrantItemsToUsers", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the specified items to the specified user inventories\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/grantitemstousers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version from which items are to be granted.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ItemGrants\": Array of items to grant and the users to whom the items are to be granted.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\",\n \"ItemGrants\": [\n {\n \"PlayFabId\": \"20394883\",\n \"ItemId\": \"shield_level_1\",\n \"Annotation\": \"Entered Level 2\"\n },\n {\n \"PlayFabId\": \"20394883\",\n \"ItemId\": \"shield_level_2\",\n \"Annotation\": \"Entered Level 2\",\n \"Data\": {\n \"Equipped\": \"True\",\n \"Slot\": \"Head\"\n }\n }\n ]\n}" }, { "id": "admin-IncrementLimitedEditionItemAvailability", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/IncrementLimitedEditionItemAvailability?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "IncrementLimitedEditionItemAvailability", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increases the global count for the given scarce resource.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/incrementlimitededitionitemavailability\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Amount\": Amount to increase availability by.\n\n\"CatalogVersion\": Which catalog is being updated. If null, uses the default catalog.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ItemId\": The item which needs more availability.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\",\n \"ItemId\": \"FreeHoodie\",\n \"Amount\": 50\n}" }, { "id": "admin-IncrementPlayerStatisticVersion", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/IncrementPlayerStatisticVersion?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "IncrementPlayerStatisticVersion", "description": "Resets the indicated statistic, removing all player entries for it and backing up the old values.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/incrementplayerstatisticversion\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"StatisticName\": unique name of the statistic\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"StatisticName\": \"headshots\"\n}" }, { "id": "admin-ListOpenIdConnection", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/ListOpenIdConnection?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListOpenIdConnection", "description": "Retrieves a list of all Open ID Connect providers registered to a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/authentication/listopenidconnection\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{}" }, { "id": "admin-ListVirtualCurrencyTypes", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/ListVirtualCurrencyTypes?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListVirtualCurrencyTypes", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retuns the list of all defined virtual currencies for the title\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/listvirtualcurrencytypes\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{}" }, { "id": "admin-RefundPurchase", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/RefundPurchase?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RefundPurchase", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Attempts to process an order refund through the original real money payment provider.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/refundpurchase\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"OrderId\": Unique order ID for the purchase in question.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"Reason\": The Reason parameter should correspond with the payment providers reason field, if they require one such as Facebook. In the case of Facebook this must match one of their refund or dispute resolution enums (See: https://developers.facebook.com/docs/payments/implementation-guide/handling-disputes-refunds)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"OrderId\": \"B456AE0\",\n \"Reason\": \"Customer Request\"\n}" }, { "id": "admin-RemovePlayerTag", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/RemovePlayerTag?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemovePlayerTag", "description": "Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/playstream/removeplayertag\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"TagName\": Unique tag for player profile.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"TagName\": \"MostKilled\"\n}" }, { "id": "admin-RemoveVirtualCurrencyTypes", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/RemoveVirtualCurrencyTypes?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemoveVirtualCurrencyTypes", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Removes one or more virtual currencies from the set defined for the title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/removevirtualcurrencytypes\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"VirtualCurrencies\": List of virtual currencies to delete\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"VirtualCurrencies\": [\n {\n \"CurrencyCode\": \"CC\"\n },\n {\n \"CurrencyCode\": \"GC\"\n }\n ]\n}" }, { "id": "admin-ResetCharacterStatistics", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/ResetCharacterStatistics?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ResetCharacterStatistics", "description": "Completely removes all statistics for the specified character, for the current game\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/characters/resetcharacterstatistics\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\"\n}" }, { "id": "admin-ResetPassword", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/ResetPassword?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ResetPassword", "description": "Reset a player's password for a given title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/resetpassword\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Password\": The new password for the player.\n\n\"Token\": The token of the player requesting the password reset.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Token\": \"2B584FA1DF645E4\",\n \"Password\": \"ExampleSecret@r\"\n}" }, { "id": "admin-ResetUserStatistics", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/ResetUserStatistics?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ResetUserStatistics", "description": "Completely removes all statistics for the specified user, for the current game\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resetuserstatistics\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "admin-ResolvePurchaseDispute", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/ResolvePurchaseDispute?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ResolvePurchaseDispute", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Attempts to resolve a dispute with the original order's payment provider.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/resolvepurchasedispute\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"OrderId\": Unique order ID for the purchase in question.\n\n\"Outcome\": Enum for the desired purchase result state after notifying the payment provider. Valid values are Revoke, Reinstate and Manual. Manual will cause no change to the order state.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"Reason\": The Reason parameter should correspond with the payment providers reason field, if they require one such as Facebook. In the case of Facebook this must match one of their refund or dispute resolution enums (See: https://developers.facebook.com/docs/payments/implementation-guide/handling-disputes-refunds)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"OrderId\": \"B456AE0\",\n \"Reason\": \"Customer Request\",\n \"Outcome\": \"Reinstate\"\n}" }, { "id": "admin-RevokeAllBansForUser", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/RevokeAllBansForUser?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RevokeAllBansForUser", "description": "Revoke all active bans for a user.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokeallbansforuser\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "admin-RevokeBans", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/RevokeBans?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RevokeBans", "description": "Revoke all active bans specified with BanId.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokebans\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BanIds\": Ids of the bans to be revoked. Maximum 100.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"BanIds\": [\n \"E0B5FF89542D413C\",\n \"EF43FF89542G1546\"\n ]\n}" }, { "id": "admin-RevokeInventoryItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/RevokeInventoryItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RevokeInventoryItem", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access to an item in a user's inventory\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"ItemInstanceId\": Unique PlayFab assigned instance identifier of the item\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"ItemInstanceId\": \"2048583045\"\n}" }, { "id": "admin-RevokeInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/RevokeInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RevokeInventoryItems", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access for up to 25 items across multiple users and characters.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Items\": Array of player items to revoke, between 1 and 25 items.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Items\": [\n {\n \"PlayFabId\": \"203945882\",\n \"ItemInstanceId\": \"2048583045\"\n }\n ]\n}" }, { "id": "admin-RunTask", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/RunTask?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RunTask", "description": "Run a task immediately regardless of its schedule.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/runtask\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Identifier\": Provide either the task ID or the task name to run a task.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Identifier\": {\n \"Id\": \"E1772FD927D8539D\"\n }\n}" }, { "id": "admin-SendAccountRecoveryEmail", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/SendAccountRecoveryEmail?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SendAccountRecoveryEmail", "description": "Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password.If an account recovery email template ID is provided, an email using the custom email template will be used.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/sendaccountrecoveryemail\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Email\": User email address attached to their account\n\n\"EmailTemplateId\": The email template id of the account recovery email template to send.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Email\": \"assignedemail@here.com\",\n \"EmailTemplateId\": \"D53AB15D8F12E330\"\n}" }, { "id": "admin-SetCatalogItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/SetCatalogItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetCatalogItems", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Creates the catalog configuration of all virtual goods for the specified catalog version\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setcatalogitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Catalog\": Array of catalog items to be submitted. Note that while CatalogItem has a parameter for CatalogVersion, it is not required and ignored in this call.\n\n\"CatalogVersion\": Which catalog is being updated. If null, uses the default catalog.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"SetAsDefaultCatalog\": Should this catalog be set as the default catalog. Defaults to true. If there is currently no default catalog, this will always set it.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\",\n \"Catalog\": [\n {\n \"ItemId\": \"shield_level_5\",\n \"ItemClass\": \"shields\",\n \"DisplayName\": \"Level 5 Shield\",\n \"Description\": \"Strong defense against projectile attacks\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199,\n \"GV\": 25\n },\n \"RealCurrencyPrices\": {\n \"GBP\": 149,\n \"EUR\": 169\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"energy_boost_1\",\n \"ItemClass\": \"boosts\",\n \"DisplayName\": \"Energy Drink Six-Pack\",\n \"Description\": \"Get a quick burst of energy whenever you need it\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199,\n \"GV\": 25\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_1\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 1\",\n \"Description\": \"Item 1 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_2\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 2\",\n \"Description\": \"Item 2 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_3\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 3\",\n \"Description\": \"Item 3 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_4\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 4\",\n \"Description\": \"Item 4 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"granted_item_a\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Granted Item A\",\n \"Description\": \"Bonus item granted for free once the full set of 4 Grant Set items are collected\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"consumable_item_1\",\n \"ItemClass\": \"Consumables\",\n \"DisplayName\": \"Consumable Item 1\",\n \"Description\": \"Item demonstrating usage-based consumables\",\n \"VirtualCurrencyPrices\": {\n \"GV\": 500\n },\n \"Consumable\": {\n \"UsageCount\": 3\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"consumable_item_2\",\n \"ItemClass\": \"Consumables\",\n \"DisplayName\": \"Consumable Item 2\",\n \"Description\": \"Item demonstrating time-based consumables\",\n \"VirtualCurrencyPrices\": {\n \"GV\": 750\n },\n \"Consumable\": {\n \"UsagePeriod\": 3600,\n \"UsagePeriodGroup\": \"usage_group_1\"\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_bundle_item_1\",\n \"ItemClass\": \"Bundles\",\n \"DisplayName\": \"Bundled Item 1\",\n \"Description\": \"Item which is added to the user inventory as part of a bundle\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_bundle_item_2\",\n \"ItemClass\": \"Bundles\",\n \"DisplayName\": \"Bundled Item 2\",\n \"Description\": \"Item which is added to the user inventory as part of a bundle\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_bundle_1\",\n \"ItemClass\": \"Bundles\",\n \"DisplayName\": \"Item bundle 1\",\n \"Description\": \"Item which, when added to the user inventory, also adds other bundled items\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 599\n },\n \"Bundle\": {\n \"BundledItems\": [\n \"sub_bundle_item_1\",\n \"sub_bundle_item_2\"\n ],\n \"BundledResultTables\": [\n \"random_result_1\"\n ],\n \"BundledVirtualCurrencies\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"key_item_1\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Key Item 1\",\n \"Description\": \"Key used to unlock Container 1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_container_item_1\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Container Item 1\",\n \"Description\": \"Item which is added to the user inventory as part of opening a container\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_container_item_2\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Container Item 2\",\n \"Description\": \"Item which is added to the user inventory as part of opening a container\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_container_1\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Item Container 1\",\n \"Description\": \"Item which, when opened with Key Item 1, also adds the items it holds to the user inventory\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 499\n },\n \"Consumable\": {\n \"UsageCount\": 1\n },\n \"Container\": {\n \"KeyItemId\": \"key_item_1\",\n \"ItemContents\": [\n \"sub_container_item_1\",\n \"sub_container_item_2\"\n ],\n \"ResultTableContents\": [\n \"random_result_1\"\n ],\n \"VirtualCurrencyContents\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_container_2\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Item Container 2\",\n \"Description\": \"Item which, when opened (no key needed), adds the items it holds to the user inventory\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 99\n },\n \"Consumable\": {\n \"UsageCount\": 1\n },\n \"Container\": {\n \"VirtualCurrencyContents\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"starterpack_1\",\n \"ItemClass\": \"starterpacks\",\n \"DisplayName\": \"Super Starter Pack\",\n \"Description\": \"Everything you need to get started fast track at the right price\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n }\n ]\n}" }, { "id": "admin-SetMembershipOverride", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/SetMembershipOverride?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetMembershipOverride", "description": "Sets the override expiration for a membership subscription\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/setmembershipoverride\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExpirationTime\": Expiration time for the membership in DateTime format, will override any subscription expirations.\n\n\"MembershipId\": Id of the membership to apply the override expiration date to.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"ExpirationTime\": \"2014-04-06T00:00:00Z\",\n \"MembershipId\": \"ShieldBonusMembership\",\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "admin-SetPlayerSecret", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/SetPlayerSecret?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetPlayerSecret", "description": "Sets or resets the player's secret. Player secrets are used to sign API requests.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/authentication/setplayersecret\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayerSecret\": \"ExampleSecret\",\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "admin-SetPublishedRevision", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/SetPublishedRevision?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetPublishedRevision", "description": "Sets the currently published revision of a title Cloud Script\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/setpublishedrevision\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Revision\": Revision to make the current published revision\n\n\"Version\": Version number\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Version\": 1,\n \"Revision\": 3\n}" }, { "id": "admin-SetPublisherData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/SetPublisherData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetPublisherData", "description": "Updates the key-value store of custom publisher settings\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/shared-group-data/setpublisherdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Key\": key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.\n\n\"Value\": new value to set. Set to null to remove a value\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Key\": \"Running Speed\",\n \"Value\": \"1.03\"\n}" }, { "id": "admin-SetStoreItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/SetStoreItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetStoreItems", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Sets all the items in one virtual store\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setstoreitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version of the store to update. If null, uses the default catalog.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"MarketingData\": Additional data about the store\n\n\"Store\": Array of store items - references to catalog items, with specific pricing - to be added\n\n\"StoreId\": Unique identifier for the store which is to be updated\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"StoreId\": \"BonusStore\",\n \"Store\": [\n {\n \"ItemId\": \"shield_level_5\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 180,\n \"GV\": 20\n },\n \"RealCurrencyPrices\": {\n \"GBP\": 100\n }\n },\n {\n \"ItemId\": \"energy_boost_1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 250,\n \"GV\": 30\n }\n },\n {\n \"ItemId\": \"starterpack_1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 399\n }\n }\n ]\n}" }, { "id": "admin-SetTitleData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/SetTitleData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetTitleData", "description": "Creates and updates the key-value store of custom title settings which can be read by the client. For example, a developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths, movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new build. \n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Key\": key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.\n\n\"Value\": new value to set. Set to null to remove a value\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Key\": \"Running Speed\",\n \"Value\": \"1.03\"\n}" }, { "id": "admin-SetTitleDataAndOverrides", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/SetTitleDataAndOverrides?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetTitleDataAndOverrides", "description": "Set and delete key-value pairs in a title data override instance.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitledataandoverrides\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"KeyValues\": List of titleData key-value pairs to set/delete. Use an empty value to delete an existing key; use a non-empty value to create/update a key.\n\n\"OverrideLabel\": Name of the override.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"OverrideLabel\": \"Holiday title data\",\n \"TitleId\": \"{{TitleId}}\",\n \"KeyValues\": [\n {\n \"Key\": \"Running Speed\",\n \"Value\": \"1.03\"\n },\n {\n \"Key\": \"Walking Speed\",\n \"Value\": \"0.05\"\n }\n ]\n}" }, { "id": "admin-SetTitleInternalData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/SetTitleInternalData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetTitleInternalData", "description": "Updates the key-value store of custom title settings which cannot be read by the client. These values can be used to tweak settings used by game servers and Cloud Scripts without the need to update and re-deploy. \n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/settitleinternaldata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Key\": key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.\n\n\"Value\": new value to set. Set to null to remove a value\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Key\": \"Running Speed\",\n \"Value\": \"1.03\"\n}" }, { "id": "admin-SetupPushNotification", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/SetupPushNotification?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetupPushNotification", "description": "Sets the Amazon Resource Name (ARN) for iOS and Android push notifications. Documentation on the exact restrictions can be found at: http://docs.aws.amazon.com/sns/latest/api/API_CreatePlatformApplication.html. Currently, Amazon device Messaging is not supported.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/setuppushnotification\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Credential\": Credential is the Private Key for APNS/APNS_SANDBOX, and the API Key for GCM\n\n\"Key\": for APNS, this is the PlatformPrincipal (SSL Certificate)\n\n\"Name\": This field is deprecated and any usage of this will cause the API to fail.\n\n\"OverwriteOldARN\": replace any existing ARN with the newly generated one. If this is set to false, an error will be returned if notifications have already setup for this platform.\n\n\"Platform\": supported notification platforms are Apple Push Notification Service (APNS and APNS_SANDBOX) for iOS and Google Cloud Messaging (GCM) for Android\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Name\": \"My Game\",\n \"Platform\": \"APNS_SANDBOX\",\n \"Key\": \"MyKey123\",\n \"Credential\": \"MyCredentialsXYZ\",\n \"OverwriteOldARN\": false\n}" }, { "id": "admin-SubtractUserVirtualCurrency", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/SubtractUserVirtualCurrency?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SubtractUserVirtualCurrency", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Decrements the specified virtual currency by the stated amount\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/subtractuservirtualcurrency\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Amount\": Amount to be subtracted from the user balance of the specified virtual currency.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": PlayFab unique identifier of the user whose virtual currency balance is to be decreased.\n\n\"VirtualCurrency\": Name of the virtual currency which is to be decremented.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"VirtualCurrency\": \"GC\",\n \"Amount\": 100\n}" }, { "id": "admin-UpdateBans", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateBans?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateBans", "description": "Updates information of a list of existing bans specified with Ban Ids.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/updatebans\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Bans\": List of bans to be updated. Maximum 100.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Bans\": [\n {\n \"BanId\": \"E0B5FF89542D413C\",\n \"Permanent\": true,\n \"Active\": true\n },\n {\n \"BanId\": \"EF43FF89542G1546\",\n \"Reason\": \"Royal pardon\",\n \"Expires\": \"2016-07-04T00:00:00Z\"\n }\n ]\n}" }, { "id": "admin-UpdateCatalogItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateCatalogItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateCatalogItems", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates the catalog configuration for virtual goods in the specified catalog version\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatecatalogitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Catalog\": Array of catalog items to be submitted. Note that while CatalogItem has a parameter for CatalogVersion, it is not required and ignored in this call.\n\n\"CatalogVersion\": Which catalog is being updated. If null, uses the default catalog.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"SetAsDefaultCatalog\": Should this catalog be set as the default catalog. Defaults to true. If there is currently no default catalog, this will always set it.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\",\n \"Catalog\": [\n {\n \"ItemId\": \"shield_level_5\",\n \"ItemClass\": \"shields\",\n \"DisplayName\": \"Level 5 Shield\",\n \"Description\": \"Strong defense against projectile attacks\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199,\n \"GV\": 25\n },\n \"RealCurrencyPrices\": {\n \"GBP\": 149,\n \"EUR\": 169\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"energy_boost_1\",\n \"ItemClass\": \"boosts\",\n \"DisplayName\": \"Energy Drink Six-Pack\",\n \"Description\": \"Get a quick burst of energy whenever you need it\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199,\n \"GV\": 25\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_1\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 1\",\n \"Description\": \"Item 1 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_2\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 2\",\n \"Description\": \"Item 2 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_3\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 3\",\n \"Description\": \"Item 3 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"required_item_for_grant_a_4\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Grant Set Item 4\",\n \"Description\": \"Item 4 from the set of items needed to get Granted Item A for free\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 249,\n \"GV\": 1500\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"granted_item_a\",\n \"ItemClass\": \"sets\",\n \"DisplayName\": \"Granted Item A\",\n \"Description\": \"Bonus item granted for free once the full set of 4 Grant Set items are collected\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"consumable_item_1\",\n \"ItemClass\": \"Consumables\",\n \"DisplayName\": \"Consumable Item 1\",\n \"Description\": \"Item demonstrating usage-based consumables\",\n \"VirtualCurrencyPrices\": {\n \"GV\": 500\n },\n \"Consumable\": {\n \"UsageCount\": 3\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"consumable_item_2\",\n \"ItemClass\": \"Consumables\",\n \"DisplayName\": \"Consumable Item 2\",\n \"Description\": \"Item demonstrating time-based consumables\",\n \"VirtualCurrencyPrices\": {\n \"GV\": 750\n },\n \"Consumable\": {\n \"UsagePeriod\": 3600,\n \"UsagePeriodGroup\": \"usage_group_1\"\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_bundle_item_1\",\n \"ItemClass\": \"Bundles\",\n \"DisplayName\": \"Bundled Item 1\",\n \"Description\": \"Item which is added to the user inventory as part of a bundle\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_bundle_item_2\",\n \"ItemClass\": \"Bundles\",\n \"DisplayName\": \"Bundled Item 2\",\n \"Description\": \"Item which is added to the user inventory as part of a bundle\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_bundle_1\",\n \"ItemClass\": \"Bundles\",\n \"DisplayName\": \"Item bundle 1\",\n \"Description\": \"Item which, when added to the user inventory, also adds other bundled items\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 599\n },\n \"Bundle\": {\n \"BundledItems\": [\n \"sub_bundle_item_1\",\n \"sub_bundle_item_2\"\n ],\n \"BundledResultTables\": [\n \"random_result_1\"\n ],\n \"BundledVirtualCurrencies\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"key_item_1\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Key Item 1\",\n \"Description\": \"Key used to unlock Container 1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 199\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_container_item_1\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Container Item 1\",\n \"Description\": \"Item which is added to the user inventory as part of opening a container\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"sub_container_item_2\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Container Item 2\",\n \"Description\": \"Item which is added to the user inventory as part of opening a container\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_container_1\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Item Container 1\",\n \"Description\": \"Item which, when opened with Key Item 1, also adds the items it holds to the user inventory\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 499\n },\n \"Consumable\": {\n \"UsageCount\": 1\n },\n \"Container\": {\n \"KeyItemId\": \"key_item_1\",\n \"ItemContents\": [\n \"sub_container_item_1\",\n \"sub_container_item_2\"\n ],\n \"ResultTableContents\": [\n \"random_result_1\"\n ],\n \"VirtualCurrencyContents\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"item_container_2\",\n \"ItemClass\": \"Containers\",\n \"DisplayName\": \"Item Container 2\",\n \"Description\": \"Item which, when opened (no key needed), adds the items it holds to the user inventory\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 99\n },\n \"Consumable\": {\n \"UsageCount\": 1\n },\n \"Container\": {\n \"VirtualCurrencyContents\": {\n \"GV\": 1000\n }\n },\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n },\n {\n \"ItemId\": \"starterpack_1\",\n \"ItemClass\": \"starterpacks\",\n \"DisplayName\": \"Super Starter Pack\",\n \"Description\": \"Everything you need to get started fast track at the right price\",\n \"CanBecomeCharacter\": false,\n \"IsStackable\": false,\n \"IsTradable\": false,\n \"IsLimitedEdition\": false,\n \"InitialLimitedEditionCount\": 0\n }\n ]\n}" }, { "id": "admin-UpdateCloudScript", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateCloudScript?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateCloudScript", "description": "Creates a new Cloud Script revision and uploads source code to it. Note that at this time, only one file should be submitted in the revision.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/updatecloudscript\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"DeveloperPlayFabId\": PlayFab user ID of the developer initiating the request.\n\n\"Files\": List of Cloud Script files to upload to create the new revision. Must have at least one file.\n\n\"Publish\": Immediately publish the new revision\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"CustomTags\": \"String\",\n \"DeveloperPlayFabId\": \"String\",\n \"Files\": \"Object\",\n \"Publish\": \"Boolean\"\n}" }, { "id": "admin-UpdateOpenIdConnection", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateOpenIdConnection?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateOpenIdConnection", "description": "Modifies data and credentials for an existing relationship between a title and an Open ID Connect provider\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateopenidconnection\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ClientId\": The client ID given by the ID provider.\n\n\"ClientSecret\": The client secret given by the ID provider.\n\n\"ConnectionId\": A name for the connection that identifies it within the title.\n\n\"IgnoreNonce\": Ignore 'nonce' claim in identity tokens.\n\n\"IssuerDiscoveryUrl\": The issuer URL or discovery document URL to read issuer information from\n\n\"IssuerInformation\": Manually specified information for an OpenID Connect issuer.\n\n\"IssuerOverride\": Override the issuer name for user indexing and lookup.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"ConnectionId\": \"oidconnection1\",\n \"ClientId\": \"example_id_1\",\n \"ClientSecret\": \"new_example_secret\",\n \"IssuerInformation\": {\n \"Issuer\": \"https://issuer.example.com/\",\n \"AuthorizationUrl\": \"https://issuer.example.com/authorize\",\n \"TokenUrl\": \"https://issuer.example.com/oauth2/token\",\n \"JsonWebKeySet\": {\n \"keys\": [\n \"...\"\n ]\n }\n },\n \"IssuerOverride\": \"https://issueroverride.example.com/\"\n}" }, { "id": "admin-UpdatePlayerSharedSecret", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdatePlayerSharedSecret?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdatePlayerSharedSecret", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateplayersharedsecret\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Disabled\": Disable or Enable this key\n\n\"FriendlyName\": Friendly name for this key\n\n\"SecretKey\": The shared secret key to update\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"SecretKey\": \"keysaresecret\",\n \"FriendlyName\": \"XBox Users\",\n \"Disabled\": false\n}" }, { "id": "admin-UpdatePlayerStatisticDefinition", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdatePlayerStatisticDefinition?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdatePlayerStatisticDefinition", "description": "Updates a player statistic configuration for the title, optionally allowing the developer to specify a reset interval.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayerstatisticdefinition\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AggregationMethod\": the aggregation method to use in updating the statistic (defaults to last)\n\n\"StatisticName\": unique name of the statistic\n\n\"VersionChangeInterval\": interval at which the values of the statistic for all players are reset (changes are effective at the next occurance of the new interval boundary)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"StatisticName\": \"headshots\",\n \"VersionChangeInterval\": \"Day\",\n \"ShouldProvisionLeaderboard\": false\n}" }, { "id": "admin-UpdatePolicy", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdatePolicy?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdatePolicy", "description": "Changes a policy for a title\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/authentication/updatepolicy\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"OverwritePolicy\": Whether to overwrite or append to the existing policy.\n\n\"PolicyName\": The name of the policy being updated. Only supported name is 'ApiPolicy'\n\n\"PolicyVersion\": Version of the policy to update. Must be the latest (as returned by GetPolicy).\n\n\"Statements\": The new statements to include in the policy.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PolicyName\": \"ApiPolicy\",\n \"Statements\": [\n {\n \"Resource\": \"pfrn:api--*\",\n \"Action\": \"*\",\n \"Effect\": \"Allow\",\n \"Principal\": \"*\",\n \"Comment\": \"The default allow all policy\"\n },\n {\n \"Resource\": \"pfrn:api--/Client/ConfirmPurchase\",\n \"Action\": \"*\",\n \"Effect\": \"Allow\",\n \"Principal\": \"*\",\n \"Comment\": \"This statement allows only request to ConfirmPurchase\"\n }\n ],\n \"OverwritePolicy\": false,\n \"PolicyVersion\": 0\n}" }, { "id": "admin-UpdateRandomResultTables", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateRandomResultTables?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateRandomResultTables", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates the random drop table configuration for the title\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updaterandomresulttables\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": which catalog is being updated. If null, update the current default catalog version\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Tables\": array of random result tables to make available (Note: specifying an existing TableId will result in overwriting that table, while any others will be added to the available set)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Tables\": [\n {\n \"TableId\": \"DropTable 1\",\n \"Nodes\": [\n {\n \"ResultItemType\": \"ItemId\",\n \"ResultItem\": \"Gold Crown 1\",\n \"Weight\": 20\n },\n {\n \"ResultItemType\": \"ItemId\",\n \"ResultItem\": \"Magic Sword 3\",\n \"Weight\": 50\n },\n {\n \"ResultItemType\": \"ItemId\",\n \"ResultItem\": \"Clear Shield 3\",\n \"Weight\": 70\n }\n ]\n }\n ]\n}" }, { "id": "admin-UpdateSegment", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateSegment?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateSegment", "description": "Updates an existing player segment and its associated definition(s) and action(s) for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/segments/updatesegment\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"SegmentModel\": Segment model with all of the segment properties data.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"SegmentModel\": \"Object\"\n}" }, { "id": "admin-UpdateStoreItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateStoreItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateStoreItems", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates an existing virtual item store with new or modified items\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/title-wide-data-management/updatestoreitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version of the store to update. If null, uses the default catalog.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"MarketingData\": Additional data about the store\n\n\"Store\": Array of store items - references to catalog items, with specific pricing - to be added\n\n\"StoreId\": Unique identifier for the store which is to be updated\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"StoreId\": \"BonusStore\",\n \"Store\": [\n {\n \"ItemId\": \"shield_level_5\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 180,\n \"GV\": 20\n },\n \"RealCurrencyPrices\": {\n \"GBP\": 100\n }\n },\n {\n \"ItemId\": \"energy_boost_1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 250,\n \"GV\": 30\n }\n },\n {\n \"ItemId\": \"starterpack_1\",\n \"VirtualCurrencyPrices\": {\n \"RM\": 399\n }\n }\n ]\n}" }, { "id": "admin-UpdateTask", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateTask?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateTask", "description": "Update an existing task.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/updatetask\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Description\": Description the task\n\n\"Identifier\": Specify either the task ID or the name of the task to be updated.\n\n\"IsActive\": Whether the schedule is active. Inactive schedule will not trigger task execution.\n\n\"Name\": Name of the task. This is a unique identifier for tasks in the title.\n\n\"Parameter\": Parameter object specific to the task type. See each task type's create API documentation for details.\n\n\"Schedule\": Cron expression for the run schedule of the task. The expression should be in UTC.\n\n\"Type\": Task type.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"Identifier\": {\n \"Name\": \"PushEventNotificationVIP_Halloween\"\n },\n \"Name\": \"PushEventNotificationVIP_Thanksgiving\",\n \"Description\": \"Send push notification to VIP about Thanksgiving event\",\n \"IsActive\": false,\n \"Type\": \"ActionsOnPlayerSegment\",\n \"Parameter\": {\n \"SegmentId\": \"E2B0F9C19B02D796\",\n \"Actions\": [\n {\n \"GrantItemContent\": {\n \"CatalogVersion\": \"foo\",\n \"ItemId\": \"bar\",\n \"ItemQuantity\": 1\n }\n }\n ]\n }\n}" }, { "id": "admin-UpdateUserData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateUserData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserData", "description": "Updates the title-specific custom data for the user which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys written in this request. Defaults to \"private\" if not set.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "admin-UpdateUserInternalData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateUserInternalData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserInternalData", "description": "Updates the title-specific custom data for the user which cannot be accessed by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserinternaldata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n }\n}" }, { "id": "admin-UpdateUserPublisherData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateUserPublisherData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserPublisherData", "description": "Updates the publisher-specific custom data for the user which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys written in this request. Defaults to \"private\" if not set.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "admin-UpdateUserPublisherInternalData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateUserPublisherInternalData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserPublisherInternalData", "description": "Updates the publisher-specific custom data for the user which cannot be accessed by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherinternaldata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n }\n}" }, { "id": "admin-UpdateUserPublisherReadOnlyData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateUserPublisherReadOnlyData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserPublisherReadOnlyData", "description": "Updates the publisher-specific custom data for the user which can only be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserpublisherreadonlydata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys written in this request. Defaults to \"private\" if not set.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "admin-UpdateUserReadOnlyData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateUserReadOnlyData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserReadOnlyData", "description": "Updates the title-specific custom data for the user which can only be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateuserreadonlydata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys written in this request. Defaults to \"private\" if not set.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "admin-UpdateUserTitleDisplayName", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Admin/UpdateUserTitleDisplayName?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserTitleDisplayName", "description": "Updates the title specific display name for a user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/admin/account-management/updateusertitledisplayname\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"DisplayName\": New title display name for the user - must be between 3 and 25 characters\n\n\"PlayFabId\": PlayFab unique identifier of the user whose title specific display name is to be changed\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-adminFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"DisplayName\": \"New Display Name\"\n}" }, { "id": "client-AcceptTrade", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/AcceptTrade?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AcceptTrade", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/trading/accepttrade\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AcceptedInventoryInstanceIds\": Items from the accepting player's inventory in exchange for the offered items in the trade. In the case of a gift, this will be null.\n\n\"OfferingPlayerId\": Player who opened the trade.\n\n\"TradeId\": Trade identifier.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"OfferingPlayerId\": \"CD803BF233CE76CC\",\n \"TradeId\": \"D819CEC225EA9948C351\",\n \"AcceptedInventoryInstanceIds\": [\n \"95C1797ADDAC24DC0383\",\n \"0F7793DF55CCEAF21B84\"\n ]\n}" }, { "id": "client-AddFriend", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/AddFriend?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddFriend", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/addfriend\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"FriendEmail\": Email address of the user to attempt to add to the local user's friend list.\n\n\"FriendPlayFabId\": PlayFab identifier of the user to attempt to add to the local user's friend list.\n\n\"FriendTitleDisplayName\": Title-specific display name of the user to attempt to add to the local user's friend list.\n\n\"FriendUsername\": PlayFab username of the user to attempt to add to the local user's friend list.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"FriendPlayFabId\": \"29837799\"\n}" }, { "id": "client-AddGenericID", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/AddGenericID?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddGenericID", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/addgenericid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"GenericId\": Generic service identifier to add to the player account.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"GenericId\": {\n \"ServiceName\": \"BigBizSocial\",\n \"UserId\": \"1234567890\"\n }\n}" }, { "id": "client-AddOrUpdateContactEmail", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/AddOrUpdateContactEmail?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddOrUpdateContactEmail", "description": "Adds or updates a contact email to the player's profile.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/addorupdatecontactemail\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EmailAddress\": The new contact email to associate with the player.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"EmailAddress\": \"theuser@domain.com\"\n}" }, { "id": "client-AddSharedGroupMembers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/AddSharedGroupMembers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddSharedGroupMembers", "description": "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 can add new members. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/addsharedgroupmembers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabIds\": An array of unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"SharedGroupId\": Unique identifier for the shared group.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"SharedGroupId\": \"Clan Data\",\n \"PlayFabIds\": [\n \"D984A64B832\",\n \"F74A523E1562\"\n ]\n}" }, { "id": "client-AddUserVirtualCurrency", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/AddUserVirtualCurrency?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddUserVirtualCurrency", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increments the user's balance of the specified virtual currency by the stated amount\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-item-management/adduservirtualcurrency\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Amount\": Amount to be added to the user balance of the specified virtual currency.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"VirtualCurrency\": Name of the virtual currency which is to be incremented.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"VirtualCurrency\": \"GC\",\n \"Amount\": 100\n}" }, { "id": "client-AddUsernamePassword", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/AddUsernamePassword?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddUsernamePassword", "description": "Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/addusernamepassword\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Email\": User email address attached to their account\n\n\"Password\": Password for the PlayFab account (6-100 characters)\n\n\"Username\": PlayFab username for the account (3-20 characters)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Username\": \"theuser\",\n \"Email\": \"me@here.com\",\n \"Password\": \"ExampleSecret\"\n}" }, { "id": "client-AndroidDevicePushNotificationRegistration", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/AndroidDevicePushNotificationRegistration?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AndroidDevicePushNotificationRegistration", "description": "Registers the Android device to receive push notifications\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/androiddevicepushnotificationregistration\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ConfirmationMessage\": Message to display when confirming push notification.\n\n\"DeviceToken\": Registration ID provided by the Google Cloud Messaging service when the title registered to receive push notifications (see the GCM documentation, here: http://developer.android.com/google/gcm/client.html).\n\n\"SendPushNotificationConfirmation\": If true, send a test push message immediately after sucessful registration. Defaults to false.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"DeviceToken\": \"59872d98fa632brn8hg3770\",\n \"SendPushNotificationConfirmation\": true,\n \"ConfirmationMessage\": \"Welcome to PlayFab!\"\n}" }, { "id": "client-AttributeInstall", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/AttributeInstall?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AttributeInstall", "description": "Attributes an install for advertisment.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/advertising/attributeinstall\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Adid\": The adid for this device.\n\n\"Idfa\": The IdentifierForAdvertisers for iOS Devices.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Idfa\": \"11098810\"\n}" }, { "id": "client-CancelTrade", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/CancelTrade?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CancelTrade", "description": "Cancels an open trade (one that has not yet been accepted or cancelled). Note that only the player who created the trade can cancel it via this API call, to prevent griefing of the trade system (cancelling trades in order to prevent other players from accepting them, for trades that can be claimed by more than one player).\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/trading/canceltrade\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"TradeId\": Trade identifier.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"TradeId\": \"D819CEC225EA9948C351\"\n}" }, { "id": "client-ConfirmPurchase", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/ConfirmPurchase?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ConfirmPurchase", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Confirms with the payment provider that the purchase was approved (if applicable) and adjusts inventory and virtual currency balances as appropriate\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-item-management/confirmpurchase\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"OrderId\": Purchase order identifier returned from StartPurchase.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"OrderId\": \"8853591446005860822\"\n}" }, { "id": "client-ConsumeItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/ConsumeItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ConsumeItem", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-item-management/consumeitem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"ConsumeCount\": Number of uses to consume from the item.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ItemInstanceId\": Unique instance identifier of the item to be consumed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ItemInstanceId\": \"94585729\",\n \"ConsumeCount\": 1\n}" }, { "id": "client-ConsumeMicrosoftStoreEntitlements", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/ConsumeMicrosoftStoreEntitlements?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ConsumeMicrosoftStoreEntitlements", "description": "Grants the player's current entitlements from Microsoft Store's Collection API\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumemicrosoftstoreentitlements\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version to use\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"MarketplaceSpecificData\": Marketplace specific payload containing details to fetch in app purchase transactions\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"MarketplaceSpecificData\": {\n \"XboxToken\": \"XBL3.0 x=1981989841;akljdlkafdknad\",\n \"userId\": \"46239871\",\n \"collectionsMsIdKey\": \"MicrosoftStoreIdKey\"\n },\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\"\n}" }, { "id": "client-ConsumePS5Entitlements", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/ConsumePS5Entitlements?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ConsumePS5Entitlements", "description": "Checks for any new consumable entitlements. If any are found, they are consumed (if they're consumables) and added as PlayFab items\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumeps5entitlements\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version to use\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"MarketplaceSpecificData\": Marketplace specific payload containing details to fetch in app purchase transactions\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"MarketplaceSpecificData\": {\n \"ServiceLabel\": \"1\"\n },\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\"\n}" }, { "id": "client-ConsumePSNEntitlements", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/ConsumePSNEntitlements?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ConsumePSNEntitlements", "description": "Checks for any new consumable entitlements. If any are found, they are consumed and added as PlayFab items\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumepsnentitlements\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Which catalog to match granted entitlements against. If null, defaults to title default catalog\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ServiceLabel\": Id of the PlayStation :tm: Network service label to consume entitlements from\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ServiceLabel\": 1\n}" }, { "id": "client-ConsumeXboxEntitlements", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/ConsumeXboxEntitlements?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ConsumeXboxEntitlements", "description": "Grants the player's current entitlements from Xbox Live, consuming all availble 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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/consumexboxentitlements\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version to use\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"XboxToken\": Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(\"POST\", \"https://playfabapi.com/\", \"\").\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"XboxToken\": \"XBL3.0 x=1981989841;akljdlkafdknad\",\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\"\n}" }, { "id": "client-CreateSharedGroup", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/CreateSharedGroup?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateSharedGroup", "description": "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, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/createsharedgroup\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"SharedGroupId\": Unique identifier for the shared group (a random identifier will be assigned, if one is not specified).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"SharedGroupId\": \"Clan Data\"\n}" }, { "id": "client-ExecuteCloudScript", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/ExecuteCloudScript?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ExecuteCloudScript", "description": "Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The PlayFab ID is the entity ID of the player's master_player_account entity.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/server-side-cloud-script/executecloudscript\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"FunctionName\": The name of the CloudScript function to execute\n\n\"FunctionParameter\": Object that is passed in to the function as the first argument\n\n\"GeneratePlayStreamEvent\": Generate a 'player_executed_cloudscript' PlayStream event containing the results of the function execution and other contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.\n\n\"RevisionSelection\": Option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live' executes the current live, published revision, and 'Specific' executes the specified revision. The default value is 'Specific', if the SpeificRevision parameter is specified, otherwise it is 'Live'.\n\n\"SpecificRevision\": The specivic revision to execute, when RevisionSelection is set to 'Specific'\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"FunctionName\": \"levelCompleted\",\n \"FunctionParameter\": {\n \"level\": 3,\n \"points\": 400\n },\n \"RevisionSelection\": \"Live\",\n \"GeneratePlayStreamEvent\": true\n}" }, { "id": "client-GetAccountInfo", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetAccountInfo?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetAccountInfo", "description": "Retrieves the user's PlayFab account details\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getaccountinfo\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Email\": User email address for the account to find (if no Username is specified).\n\n\"PlayFabId\": Unique PlayFab identifier of the user whose info is being requested. Optional, defaults to the authenticated user if no other lookup identifier set.\n\n\"TitleDisplayName\": Title-specific username for the account to find (if no Email is set). Note that if the non-unique Title Display Names option is enabled for the title, attempts to look up users by Title Display Name will always return AccountNotFound.\n\n\"Username\": PlayFab Username for the account to find (if no PlayFabId is specified).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "client-GetAdPlacements", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetAdPlacements?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetAdPlacements", "description": "Returns a list of ad placements and a reward for each\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/advertising/getadplacements\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AppId\": The current AppId to use\n\n\"Identifier\": Using the name or unique identifier, filter the result for get a specific placement.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"AppId\": \"A12784B\",\n \"Identifier\": {\n \"Name\": \"PowerBonusInterstitial\"\n }\n}" }, { "id": "client-GetAllUsersCharacters", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetAllUsersCharacters?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetAllUsersCharacters", "description": "Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/characters/getalluserscharacters\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "client-GetCatalogItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetCatalogItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCatalogItems", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getcatalogitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Which catalog is being requested. If null, uses the default catalog.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\"\n}" }, { "id": "client-GetCharacterData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetCharacterData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCharacterData", "description": "Retrieves the title-specific custom data for the character which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ]\n}" }, { "id": "client-GetCharacterInventory", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetCharacterInventory?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCharacterInventory", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified character's current inventory of virtual goods\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getcharacterinventory\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Used to limit results to only those from a specific catalog version.\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CharacterId\": \"{{CharacterId}}\",\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\"\n}" }, { "id": "client-GetCharacterLeaderboard", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetCharacterLeaderboard?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCharacterLeaderboard", "description": "Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterleaderboard\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"MaxResultsCount\": Maximum number of entries to retrieve. Default 10, maximum 100.\n\n\"StartPosition\": First entry in the leaderboard to be retrieved.\n\n\"StatisticName\": Unique identifier for the title-specific statistic for the leaderboard.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CharacterType\": \"blue_warrior\",\n \"StatisticName\": \"Kills\",\n \"StartPosition\": 0,\n \"MaxResultsCount\": 20\n}" }, { "id": "client-GetCharacterReadOnlyData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetCharacterReadOnlyData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCharacterReadOnlyData", "description": "Retrieves the title-specific custom data for the character which can only be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/character-data/getcharacterreadonlydata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ]\n}" }, { "id": "client-GetCharacterStatistics", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetCharacterStatistics?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCharacterStatistics", "description": "Retrieves the details of all title-specific statistics for the user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/characters/getcharacterstatistics\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CharacterId\": \"{{CharacterId}}\"\n}" }, { "id": "client-GetContentDownloadUrl", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetContentDownloadUrl?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetContentDownloadUrl", "description": "This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/content/getcontentdownloadurl\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"HttpMethod\": HTTP method to fetch item - GET or HEAD. Use HEAD when only fetching metadata. Default is GET.\n\n\"Key\": Key of the content item to fetch, usually formatted as a path, e.g. images/a.png\n\n\"ThruCDN\": True to download through CDN. CDN provides higher download bandwidth and lower latency. However, if you want the latest, non-cached version of the content during development, set this to false. Default is true.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Key\": \"images/sword_icon.png\"\n}" }, { "id": "client-GetFriendLeaderboard", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetFriendLeaderboard?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetFriendLeaderboard", "description": "Retrieves a list of ranked friends of the current player for the given statistic, starting from the indicated point in the leaderboard\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboard\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExternalPlatformFriends\": Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a comma-separated list of platforms.\n\n\"MaxResultsCount\": Maximum number of entries to retrieve. Default 10, maximum 100.\n\n\"ProfileConstraints\": If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager \"Client Profile Options\" tab in the \"Settings\" section.\n\n\"StartPosition\": Position in the leaderboard to start this listing (defaults to the first entry).\n\n\"StatisticName\": Statistic used to rank friends for this leaderboard.\n\n\"Version\": The version of the leaderboard to get.\n\n\"XboxToken\": Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"StatisticName\": \"Kills\",\n \"StartPosition\": 1258,\n \"MaxResultsCount\": 20,\n \"ExternalPlatformFriends\": \"Facebook, Xbox, Psn\"\n}" }, { "id": "client-GetFriendLeaderboardAroundPlayer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetFriendLeaderboardAroundPlayer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetFriendLeaderboardAroundPlayer", "description": "Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab user. If PlayFabId is empty or null will return currently logged in user.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getfriendleaderboardaroundplayer\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExternalPlatformFriends\": Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a comma-separated list of platforms.\n\n\"MaxResultsCount\": Maximum number of entries to retrieve. Default 10, maximum 100.\n\n\"PlayFabId\": PlayFab unique identifier of the user to center the leaderboard around. If null will center on the logged in user.\n\n\"ProfileConstraints\": If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager \"Client Profile Options\" tab in the \"Settings\" section.\n\n\"StatisticName\": Statistic used to rank players for this leaderboard.\n\n\"Version\": The version of the leaderboard to get.\n\n\"XboxToken\": Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"StatisticName\": \"Kills\",\n \"MaxResultsCount\": 20,\n \"ExternalPlatformFriends\": \"None\"\n}" }, { "id": "client-GetFriendsList", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetFriendsList?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetFriendsList", "description": "Retrieves the current friend list for the local user, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/getfriendslist\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExternalPlatformFriends\": Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a comma-separated list of platforms.\n\n\"ProfileConstraints\": If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager \"Client Profile Options\" tab in the \"Settings\" section.\n\n\"XboxToken\": Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ExternalPlatformFriends\": \"Steam\"\n}" }, { "id": "client-GetLeaderboard", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetLeaderboard?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetLeaderboard", "description": "Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboard\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"MaxResultsCount\": Maximum number of entries to retrieve. Default 10, maximum 100.\n\n\"ProfileConstraints\": If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager \"Client Profile Options\" tab in the \"Settings\" section.\n\n\"StartPosition\": Position in the leaderboard to start this listing (defaults to the first entry).\n\n\"StatisticName\": Statistic used to rank players for this leaderboard.\n\n\"Version\": The version of the leaderboard to get.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"StatisticName\": \"Kills\",\n \"StartPosition\": 0,\n \"MaxResultsCount\": 20\n}" }, { "id": "client-GetLeaderboardAroundCharacter", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetLeaderboardAroundCharacter?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetLeaderboardAroundCharacter", "description": "Retrieves a list of ranked characters for the given statistic, centered on the requested Character ID\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardaroundcharacter\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character on which to center the leaderboard.\n\n\"MaxResultsCount\": Maximum number of entries to retrieve. Default 10, maximum 100.\n\n\"StatisticName\": Unique identifier for the title-specific statistic for the leaderboard.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"StatisticName\": \"Kills\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"MaxResultsCount\": 20\n}" }, { "id": "client-GetLeaderboardAroundPlayer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetLeaderboardAroundPlayer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetLeaderboardAroundPlayer", "description": "Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or null will return currently logged in user.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getleaderboardaroundplayer\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"MaxResultsCount\": Maximum number of entries to retrieve. Default 10, maximum 100.\n\n\"PlayFabId\": PlayFab unique identifier of the user to center the leaderboard around. If null will center on the logged in user.\n\n\"ProfileConstraints\": If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager \"Client Profile Options\" tab in the \"Settings\" section.\n\n\"StatisticName\": Statistic used to rank players for this leaderboard.\n\n\"Version\": The version of the leaderboard to get.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"StatisticName\": \"Kills\",\n \"MaxResultsCount\": 20\n}" }, { "id": "client-GetLeaderboardForUserCharacters", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetLeaderboardForUserCharacters?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetLeaderboardForUserCharacters", "description": "Retrieves a list of all of the user's characters for the given statistic.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/characters/getleaderboardforusercharacters\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"StatisticName\": Unique identifier for the title-specific statistic for the leaderboard.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"StatisticName\": \"Kills\"\n}" }, { "id": "client-GetPaymentToken", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPaymentToken?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPaymentToken", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ For payments flows where the provider requires playfab (the fulfiller) to initiate the transaction, but the client completes the rest of the flow. In the Xsolla case, the token returned here will be passed to Xsolla by the client to create a cart. Poll GetPurchase using the returned OrderId once you've completed the payment.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpaymenttoken\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"TokenProvider\": The name of service to provide the payment token. Allowed Values are: xsolla\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"TokenProvider\": \"xsolla\"\n}" }, { "id": "client-GetPhotonAuthenticationToken", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPhotonAuthenticationToken?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPhotonAuthenticationToken", "description": "Gets a Photon custom authentication token that can be used to securely join the player into a Photon room. See https://docs.microsoft.com/gaming/playfab/features/multiplayer/photon/quickstart for more details.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/getphotonauthenticationtoken\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PhotonApplicationId\": The Photon applicationId for the game you wish to log into.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"PhotonApplicationId\": \"acaa26f3-fcdb-4af4-8c76-3a3d4dd3066f\"\n}" }, { "id": "client-GetPlayFabIDsFromFacebookIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayFabIDsFromFacebookIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromFacebookIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"FacebookIDs\": Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"FacebookIDs\": [\n \"857498576495\",\n \"759374651209\"\n ]\n}" }, { "id": "client-GetPlayFabIDsFromFacebookInstantGamesIds", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayFabIDsFromFacebookInstantGamesIds?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromFacebookInstantGamesIds", "description": "Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Game identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookinstantgamesids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"FacebookInstantGamesIds\": Array of unique Facebook Instant Games identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 25 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"FacebookInstantGamesIds\": [\n \"1114685845316172\",\n \"1114685845316173\"\n ]\n}" }, { "id": "client-GetPlayFabIDsFromGameCenterIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayFabIDsFromGameCenterIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromGameCenterIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player Identifier).\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgamecenterids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"GameCenterIDs\": Array of unique Game Center identifiers (the Player Identifier) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"GameCenterIDs\": [\n \"857498576495\",\n \"759374651209\"\n ]\n}" }, { "id": "client-GetPlayFabIDsFromGenericIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayFabIDsFromGenericIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromGenericIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgenericids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"GenericIDs\": Array of unique generic service identifiers for which the title needs to get PlayFab identifiers. Currently limited to a maximum of 10 in a single request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"GenericIDs\": [\n {\n \"ServiceName\": \"BigBizSocial\",\n \"UserId\": \"1234567890\"\n },\n {\n \"ServiceName\": \"VeeCeeMe\",\n \"UserId\": \"og5igh85gf43gf\"\n }\n ]\n}" }, { "id": "client-GetPlayFabIDsFromGoogleIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayFabIDsFromGoogleIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromGoogleIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as \"id\" in the Google+ People API calls.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"GoogleIDs\": Array of unique Google identifiers (Google+ user IDs) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"GoogleIDs\": [\n \"857498576495\",\n \"759374651209\"\n ]\n}" }, { "id": "client-GetPlayFabIDsFromGooglePlayGamesPlayerIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayFabIDsFromGooglePlayGamesPlayerIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromGooglePlayGamesPlayerIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of Google Play Games identifiers. The Google Play Games identifiers are the IDs for the user accounts, available as \"playerId\" in the Google Play Games Services - Players API calls.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromgoogleplaygamesplayerids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"GooglePlayGamesPlayerIDs\": Array of unique Google Play Games identifiers (Google+ user IDs) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"GooglePlayGamesPlayerIDs\": [\n \"857498576495\",\n \"759374651209\"\n ]\n}" }, { "id": "client-GetPlayFabIDsFromKongregateIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayFabIDsFromKongregateIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromKongregateIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available as \"user_id\" from the Kongregate API methods(ex: http://developers.kongregate.com/docs/client/getUserId).\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromkongregateids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"KongregateIDs\": Array of unique Kongregate identifiers (Kongregate's user_id) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"KongregateIDs\": [\n \"857498576495\",\n \"759374651209\"\n ]\n}" }, { "id": "client-GetPlayFabIDsFromNintendoServiceAccountIds", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayFabIDsFromNintendoServiceAccountIds?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromNintendoServiceAccountIds", "description": "Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoserviceaccountids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"NintendoAccountIds\": Array of unique Nintendo Switch Account identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"NintendoAccountIds\": [\n \"526f79204261747478\",\n \"526f79204261747479\"\n ]\n}" }, { "id": "client-GetPlayFabIDsFromNintendoSwitchDeviceIds", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayFabIDsFromNintendoSwitchDeviceIds?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromNintendoSwitchDeviceIds", "description": "Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoswitchdeviceids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"NintendoSwitchDeviceIds\": Array of unique Nintendo Switch Device identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"NintendoSwitchDeviceIds\": [\n \"526f79204261747478\",\n \"526f79204261747479\"\n ]\n}" }, { "id": "client-GetPlayFabIDsFromPSNAccountIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayFabIDsFromPSNAccountIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromPSNAccountIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnaccountids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IssuerId\": Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment.\n\n\"PSNAccountIDs\": Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"PSNAccountIDs\": [\n \"857498576495\",\n \"759374651209\"\n ]\n}" }, { "id": "client-GetPlayFabIDsFromPSNOnlineIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayFabIDsFromPSNOnlineIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromPSNOnlineIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnonlineids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IssuerId\": Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment.\n\n\"PSNOnlineIDs\": Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"PSNOnlineIDs\": [\n \"857555576495\",\n \"759345551209\"\n ]\n}" }, { "id": "client-GetPlayFabIDsFromSteamIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayFabIDsFromSteamIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromSteamIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"SteamStringIDs\": Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"SteamStringIDs\": [\n \"857498576495\",\n \"759374651209\"\n ]\n}" }, { "id": "client-GetPlayFabIDsFromTwitchIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayFabIDsFromTwitchIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromTwitchIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as \"_id\" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromtwitchids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"TwitchIds\": Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"TwitchIds\": [\n \"127168541\",\n \"88315720\"\n ]\n}" }, { "id": "client-GetPlayFabIDsFromXboxLiveIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayFabIDsFromXboxLiveIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromXboxLiveIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromxboxliveids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Sandbox\": The ID of Xbox Live sandbox.\n\n\"XboxLiveAccountIDs\": Array of unique Xbox Live account identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"XboxLiveAccountIDs\": [\n \"857498576495\",\n \"759374651209\"\n ],\n \"Sandbox\": \"RETAIL\"\n}" }, { "id": "client-GetPlayerCombinedInfo", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayerCombinedInfo?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerCombinedInfo", "description": "Retrieves all of the user's different kinds of info.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayercombinedinfo\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayFabId\": PlayFabId of the user whose data will be returned. If not filled included, we return the data for the calling player. \n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"InfoRequestParameters\": {\n \"GetUserAccountInfo\": true,\n \"GetUserInventory\": false,\n \"GetUserVirtualCurrency\": true,\n \"GetUserData\": true,\n \"UserDataKeys\": [\n \"preferences\",\n \"progress\"\n ],\n \"GetUserReadOnlyData\": false,\n \"GetCharacterInventories\": false,\n \"GetCharacterList\": false,\n \"GetTitleData\": false,\n \"GetPlayerStatistics\": false,\n \"GetPlayerProfile\": false\n }\n}" }, { "id": "client-GetPlayerProfile", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayerProfile?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerProfile", "description": "Retrieves the player's profile\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayerprofile\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"ProfileConstraints\": If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager \"Client Profile Options\" tab in the \"Settings\" section.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "client-GetPlayerSegments", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayerSegments?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerSegments", "description": "List all segments that a player currently belongs to at this moment in time.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayersegments\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-GetPlayerStatisticVersions", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayerStatisticVersions?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerStatisticVersions", "description": "Retrieves the information on the available versions of the specified statistic.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatisticversions\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"StatisticName\": unique name of the statistic\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"StatisticName\": \"headshots\"\n}" }, { "id": "client-GetPlayerStatistics", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayerStatistics?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerStatistics", "description": "Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local player.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayerstatistics\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"StatisticNames\": statistics to return (current version will be returned for each)\n\n\"StatisticNameVersions\": statistics to return, if StatisticNames is not set (only statistics which have a version matching that provided will be returned)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"StatisticNames\": [\n \"Points\",\n \"Wins\"\n ]\n}" }, { "id": "client-GetPlayerTags", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayerTags?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerTags", "description": "Get all tags with a given Namespace (optional) from a player profile.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/playstream/getplayertags\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Namespace\": Optional namespace to filter results by\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Namespace\": \"title.AAA\"\n}" }, { "id": "client-GetPlayerTrades", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPlayerTrades?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerTrades", "description": "Gets all trades the player has either opened or accepted, optionally filtered by trade status.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/trading/getplayertrades\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"StatusFilter\": Returns only trades with the given status. If null, returns all trades.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"StatusFilter\": \"Filled\"\n}" }, { "id": "client-GetPublisherData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPublisherData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPublisherData", "description": "Retrieves the key-value store of custom publisher settings\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getpublisherdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Keys\": array of keys to get back data from the Publisher data blob, set by the admin tools\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Keys\": [\n \"color\",\n \"propertyA\"\n ]\n}" }, { "id": "client-GetPurchase", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetPurchase?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPurchase", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves a purchase along with its current PlayFab status. Returns inventory items from the purchase that are still active.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getpurchase\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"OrderId\": Purchase order identifier.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"OrderId\": \"8853591446005860822\"\n}" }, { "id": "client-GetSharedGroupData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetSharedGroupData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetSharedGroupData", "description": "Retrieves data stored in a shared group object, as well as the list of members in the group. Non-members of the group may use this to retrieve group data, including membership, but they will not receive data for keys marked as private. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/getsharedgroupdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"GetMembers\": If true, return the list of all members of the shared group.\n\n\"Keys\": Specific keys to retrieve from the shared group (if not specified, all keys will be returned, while an empty array indicates that no keys should be returned).\n\n\"SharedGroupId\": Unique identifier for the shared group.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"SharedGroupId\": \"Clan Data\",\n \"Keys\": [\n \"ClanKills\",\n \"LastClanUpdate\"\n ],\n \"GetMembers\": true\n}" }, { "id": "client-GetStoreItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetStoreItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetStoreItems", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the set of items defined for the specified store, including all prices defined\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/getstoreitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version to store items from. Use default catalog version if null\n\n\"StoreId\": Unqiue identifier for the store which is being requested.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"StoreId\": \"BonusStore\"\n}" }, { "id": "client-GetTime", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetTime?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTime", "description": "Retrieves the current server time\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettime\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-GetTitleData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetTitleData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTitleData", "description": "Retrieves the key-value store of custom title settings\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitledata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Keys\": Specific keys to search for in the title data (leave null to get all keys)\n\n\"OverrideLabel\": Optional field that specifies the name of an override. This value is ignored when used by the game client; otherwise, the overrides are applied automatically to the title data.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Keys\": [\n \"color\",\n \"propertyA\"\n ]\n}" }, { "id": "client-GetTitleNews", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetTitleNews?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTitleNews", "description": "Retrieves the title news feed, as configured in the developer portal\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/title-wide-data-management/gettitlenews\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Count\": Limits the results to the last n entries. Defaults to 10 if not set.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Count\": 25\n}" }, { "id": "client-GetTitlePublicKey", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetTitlePublicKey?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTitlePublicKey", "description": "Returns the title's base 64 encoded RSA CSP blob.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/gettitlepublickey\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\n\"TitleSharedSecret\": The shared secret key for this title\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"TitleId\": \"{{TitleId}}\",\n \"TitleSharedSecret\": \"ExampleSecret\"\n}" }, { "id": "client-GetTradeStatus", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetTradeStatus?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTradeStatus", "description": "Gets the current status of an existing trade.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/trading/gettradestatus\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"OfferingPlayerId\": Player who opened trade.\n\n\"TradeId\": Trade identifier as returned by OpenTradeOffer.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"OfferingPlayerId\": \"CD803BF233CE76CC\",\n \"TradeId\": \"D819CEC225EA9948C351\"\n}" }, { "id": "client-GetUserData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetUserData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserData", "description": "Retrieves the title-specific custom data for the user which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": List of unique keys to load from.\n\n\"PlayFabId\": Unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set. When specified to a PlayFab id of another player, then this will only return public keys for that account.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ]\n}" }, { "id": "client-GetUserInventory", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetUserInventory?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserInventory", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the user's current inventory of virtual goods\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-item-management/getuserinventory\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-GetUserPublisherData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetUserPublisherData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserPublisherData", "description": "Retrieves the publisher-specific custom data for the user which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": List of unique keys to load from.\n\n\"PlayFabId\": Unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set. When specified to a PlayFab id of another player, then this will only return public keys for that account.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ]\n}" }, { "id": "client-GetUserPublisherReadOnlyData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetUserPublisherReadOnlyData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserPublisherReadOnlyData", "description": "Retrieves the publisher-specific custom data for the user which can only be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserpublisherreadonlydata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": List of unique keys to load from.\n\n\"PlayFabId\": Unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set. When specified to a PlayFab id of another player, then this will only return public keys for that account.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ]\n}" }, { "id": "client-GetUserReadOnlyData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GetUserReadOnlyData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserReadOnlyData", "description": "Retrieves the title-specific custom data for the user which can only be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getuserreadonlydata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": List of unique keys to load from.\n\n\"PlayFabId\": Unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set. When specified to a PlayFab id of another player, then this will only return public keys for that account.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ]\n}" }, { "id": "client-GrantCharacterToUser", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/GrantCharacterToUser?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GrantCharacterToUser", "description": "Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/characters/grantcharactertouser\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version from which items are to be granted.\n\n\"CharacterName\": Non-unique display name of the character being granted (1-40 characters in length).\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ItemId\": Catalog item identifier of the item in the user's inventory that corresponds to the character in the catalog to be created.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\",\n \"ItemId\": \"Blue Warrior\",\n \"CharacterName\": \"FighterDude\"\n}" }, { "id": "client-LinkAndroidDeviceID", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkAndroidDeviceID?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkAndroidDeviceID", "description": "Links the Android device identifier to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linkandroiddeviceid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AndroidDevice\": Specific model of the user's device.\n\n\"AndroidDeviceId\": Android device identifier for the user's device.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the device, unlink the other user and re-link.\n\n\"OS\": Specific Operating System version for the user's device.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"AndroidDeviceId\": \"526f79204261747479\",\n \"OS\": \"5.0\",\n \"AndroidDevice\": \"Nexus 6\"\n}" }, { "id": "client-LinkApple", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkApple?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkApple", "description": "Links the Apple account associated with the token to the user's PlayFab account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linkapple\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to a specific Apple account, unlink the other user and re-link.\n\n\"IdentityToken\": The JSON Web token (JWT) returned by Apple after login. Represented as the identityToken field in the authorization credential payload. Used to validate the request and find the user ID (Apple subject) to link with.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"IdentityToken\": \"eyJraWQi...\"\n}" }, { "id": "client-LinkCustomID", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkCustomID?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkCustomID", "description": "Links the custom identifier, generated by the title, to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linkcustomid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomId\": Custom unique identifier for the user, generated by the title.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the custom ID, unlink the other user and re-link.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CustomId\": \"67AB-5397-CC54-EA31\"\n}" }, { "id": "client-LinkFacebookAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkFacebookAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkFacebookAccount", "description": "Links the Facebook account associated with the provided Facebook access token to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AccessToken\": Unique identifier from Facebook for the user.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the account, unlink the other user and re-link.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"AccessToken\": \"FaceAccessTokenID\"\n}" }, { "id": "client-LinkFacebookInstantGamesId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkFacebookInstantGamesId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkFacebookInstantGamesId", "description": "Links the Facebook Instant Games Id to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linkfacebookinstantgamesid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"FacebookInstantGamesSignature\": Facebook Instant Games signature for the user.\n\n\"ForceLink\": If another user is already linked to the Facebook Instant Games ID, unlink the other user and re-link.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"FacebookInstantGamesSignature\": \"abcdef\"\n}" }, { "id": "client-LinkGameCenterAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkGameCenterAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkGameCenterAccount", "description": "Links the Game Center account associated with the provided Game Center ID to the user's PlayFab account. Logging in with a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgamecenteraccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the account, unlink the other user and re-link. If the current user is already linked, link both accounts\n\n\"GameCenterId\": Game Center identifier for the player account to be linked.\n\n\"PublicKeyUrl\": The URL for the public encryption key that will be used to verify the signature.\n\n\"Salt\": A random value used to compute the hash and keep it randomized.\n\n\"Signature\": The verification signature of the authentication payload.\n\n\"Timestamp\": The integer representation of date and time that the signature was created on. PlayFab will reject authentication signatures not within 10 minutes of the server's current time.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"GameCenterId\": \"2998h2998f0b000d0993\"\n}" }, { "id": "client-LinkGoogleAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkGoogleAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkGoogleAccount", "description": "Links the currently signed-in user account to their Google account, using their Google account credentials\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the account, unlink the other user and re-link. If the current user is already linked, link both accounts\n\n\"ServerAuthCode\": Server authentication code obtained on the client by calling getServerAuthCode() (https://developers.google.com/identity/sign-in/android/offline-access) from Google Play for the user.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ServerAuthCode\": \"4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#\"\n}" }, { "id": "client-LinkGooglePlayGamesServicesAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkGooglePlayGamesServicesAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkGooglePlayGamesServicesAccount", "description": "Links the currently signed-in user account to their Google Play Games account, using their Google Play Games account credentials\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linkgoogleplaygamesservicesaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the account, unlink the other user and re-link. If the current user is already linked, link both accounts\n\n\"ServerAuthCode\": OAuth 2.0 server authentication code obtained on the client by calling the requestServerSideAccess() (https://developers.google.com/games/services/android/signin) Google Play Games client API.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ServerAuthCode\": \"4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#\"\n}" }, { "id": "client-LinkIOSDeviceID", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkIOSDeviceID?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkIOSDeviceID", "description": "Links the vendor-specific iOS device identifier to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linkiosdeviceid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"DeviceId\": Vendor-specific iOS identifier for the user's device.\n\n\"DeviceModel\": Specific model of the user's device.\n\n\"ForceLink\": If another user is already linked to the device, unlink the other user and re-link.\n\n\"OS\": Specific Operating System version for the user's device.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"DeviceId\": \"29848d9bh8900a0b003\",\n \"OS\": \"7.11\",\n \"DeviceModel\": \"Iphone 5s\"\n}" }, { "id": "client-LinkKongregate", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkKongregate?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkKongregate", "description": "Links the Kongregate identifier to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linkkongregate\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AuthTicket\": Valid session auth ticket issued by Kongregate\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the account, unlink the other user and re-link.\n\n\"KongregateId\": Numeric user ID assigned by Kongregate\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"KongregateId\": \"457332\",\n \"AuthTicket\": \"{123-456-78931212}\"\n}" }, { "id": "client-LinkNintendoServiceAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkNintendoServiceAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkNintendoServiceAccount", "description": "Links the Nintendo account associated with the token to the user's PlayFab account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoserviceaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to a specific Nintendo Switch account, unlink the other user and re-link.\n\n\"IdentityToken\": The JSON Web token (JWT) returned by Nintendo after login. Used to validate the request and find the user ID (Nintendo Switch subject) to link with.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"IdentityToken\": \"eyJraWQi...\"\n}" }, { "id": "client-LinkNintendoSwitchDeviceId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkNintendoSwitchDeviceId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkNintendoSwitchDeviceId", "description": "Links the NintendoSwitchDeviceId to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linknintendoswitchdeviceid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the Nintendo Switch Device ID, unlink the other user and re-link.\n\n\"NintendoSwitchDeviceId\": Nintendo Switch unique identifier for the user's device.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"NintendoSwitchDeviceId\": \"526f79204261747479\"\n}" }, { "id": "client-LinkOpenIdConnect", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkOpenIdConnect?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkOpenIdConnect", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linkopenidconnect\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ConnectionId\": A name that identifies which configured OpenID Connect provider relationship to use. Maximum 100 characters.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to a specific OpenId Connect user, unlink the other user and re-link.\n\n\"IdToken\": The JSON Web token (JWT) returned by the identity provider after login. Represented as the id_token field in the identity provider's response. Used to validate the request and find the user ID (OpenID Connect subject) to link with.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ConnectionId\": \"exampleprovider\",\n \"IdToken\": \"eyJraWQi...\"\n}" }, { "id": "client-LinkPSNAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkPSNAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkPSNAccount", "description": "Links the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linkpsnaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AuthCode\": Authentication code provided by the PlayStation :tm: Network.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the account, unlink the other user and re-link.\n\n\"IssuerId\": Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment.\n\n\"RedirectUri\": Redirect URI supplied to PlayStation :tm: Network when requesting an auth code\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"AuthCode\": \"LKJDG7DDE\",\n \"RedirectUri\": \"orbis://games\"\n}" }, { "id": "client-LinkSteamAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkSteamAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkSteamAccount", "description": "Links the Steam account associated with the provided Steam authentication ticket to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linksteamaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the account, unlink the other user and re-link.\n\n\"SteamTicket\": Authentication token for the user, returned as a byte array from Steam, and converted to a string (for example, the byte 0x08 should become \"08\").\n\n\"TicketIsServiceSpecific\": True if ticket was generated using ISteamUser::GetAuthTicketForWebAPI() using \"AzurePlayFab\" as the identity string. False if the ticket was generated with ISteamUser::GetAuthSessionTicket().\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"SteamTicket\": \"steamTicketID\",\n \"TicketIsServiceSpecific\": true\n}" }, { "id": "client-LinkTwitch", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkTwitch?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkTwitch", "description": "Links the Twitch account associated with the token to the user's PlayFab account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linktwitch\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AccessToken\": Valid token issued by Twitch\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the account, unlink the other user and re-link.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"AccessToken\": \"TwitchAccessToken\"\n}" }, { "id": "client-LinkXboxAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LinkXboxAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkXboxAccount", "description": "Links the Xbox Live account associated with the provided access code to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/linkxboxaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the account, unlink the other user and re-link.\n\n\"XboxToken\": Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(\"POST\", \"https://playfabapi.com/\", \"\").\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"XboxToken\": \"XBL3.0 x=1981989841;akljdlkafdknad\"\n}" }, { "id": "client-LoginWithAndroidDeviceID", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithAndroidDeviceID?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithAndroidDeviceID", "description": "Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithandroiddeviceid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AndroidDevice\": Specific model of the user's device.\n\n\"AndroidDeviceId\": Android device identifier for the user's device.\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"OS\": Specific Operating System version for the user's device.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"AndroidDeviceId\": \"526f79204261747479\",\n \"OS\": \"5.0\",\n \"AndroidDevice\": \"Nexus 6\",\n \"CreateAccount\": false,\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithApple", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithApple?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithApple", "description": "Signs in the user with a Sign in with Apple identity token.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithapple\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"IdentityToken\": The JSON Web token (JWT) returned by Apple after login. Represented as the identityToken field in the authorization credential payload. If you choose to ignore the expiration date for identity tokens, you will receive an NotAuthorized error if Apple rotates the signing key. In this case, users have to login to provide a fresh identity token.\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"IdentityToken\": \"eyJraWQi...\",\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithCustomID", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithCustomID?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithCustomID", "description": "Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithcustomid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomId\": Custom unique identifier for the user, generated by the title.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CustomId\": \"67AB-5397-CC54-EA31\",\n \"CreateAccount\": false,\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithEmailAddress", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithEmailAddress?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithEmailAddress", "description": "Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithEmailAddress does not permit the creation of new accounts via the CreateAccountFlag. Email addresses may be used to create accounts via RegisterPlayFabUser.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithemailaddress\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Email\": Email address for the account.\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"Password\": Password for the PlayFab account (6-100 characters)\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Email\": \"theuser@domain.com\",\n \"Password\": \"thepassword\",\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithFacebook", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithFacebook?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithFacebook", "description": "Signs the user in using a Facebook access token, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebook\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AccessToken\": Unique identifier from Facebook for the user.\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"AccessToken\": \"FaceAccessTokenID\",\n \"CreateAccount\": false,\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithFacebookInstantGamesId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithFacebookInstantGamesId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithFacebookInstantGamesId", "description": "Signs the user in using a Facebook Instant Games ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Requires Facebook Instant Games to be configured.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithfacebookinstantgamesid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"FacebookInstantGamesSignature\": Facebook Instant Games signature for the user.\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"FacebookInstantGamesSignature\": \"abcdef\",\n \"CreateAccount\": false,\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithGameCenter", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithGameCenter?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithGameCenter", "description": "Signs the user in using an iOS Game Center player identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Logging in with a Game Center ID is insecure if you do not include the optional PublicKeyUrl, Salt, Signature, and Timestamp parameters in this request. It is recommended you require these parameters on all Game Center calls by going to the Apple Add-ons page in the PlayFab Game Manager and enabling the 'Require secure authentication only for this app' option.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgamecenter\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayerId\": Unique Game Center player id.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"PublicKeyUrl\": The URL for the public encryption key that will be used to verify the signature.\n\n\"Salt\": A random value used to compute the hash and keep it randomized.\n\n\"Signature\": The verification signature of the authentication payload.\n\n\"Timestamp\": The integer representation of date and time that the signature was created on. PlayFab will reject authentication signatures not within 10 minutes of the server's current time.\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"PlayerId\": \"pachycephalosaurus01\",\n \"CreateAccount\": false,\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithGoogleAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithGoogleAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithGoogleAccount", "description": "Signs the user in using their Google account credentials\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"ServerAuthCode\": OAuth 2.0 server authentication code obtained on the client by calling the getServerAuthCode() (https://developers.google.com/identity/sign-in/android/offline-access) Google client API.\n\n\"SetEmail\": Optional boolean to opt out of setting the MPA email when creating a Google account, defaults to true.\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ServerAuthCode\": \"4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#\",\n \"CreateAccount\": false,\n \"SetEmail\": true,\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithGooglePlayGamesServices", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithGooglePlayGamesServices?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithGooglePlayGamesServices", "description": "Signs the user in using their Google Play Games account credentials\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithgoogleplaygamesservices\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"ServerAuthCode\": OAuth 2.0 server authentication code obtained on the client by calling the requestServerSideAccess() (https://developers.google.com/games/services/android/signin) Google Play Games client API.\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ServerAuthCode\": \"4/TPdB1ter7eJ7cQ0lGBa6p1Cn-sSHJEXmPJ7t1-v4_ds#\",\n \"CreateAccount\": false,\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithIOSDeviceID", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithIOSDeviceID?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithIOSDeviceID", "description": "Signs the user in using the vendor-specific iOS device identifier, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithiosdeviceid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"DeviceId\": Vendor-specific iOS identifier for the user's device.\n\n\"DeviceModel\": Specific model of the user's device.\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"OS\": Specific Operating System version for the user's device.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"DeviceId\": \"29848d9bh8900a0b003\",\n \"OS\": \"7.11\",\n \"DeviceModel\": \"Iphone 5s\",\n \"CreateAccount\": false,\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithKongregate", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithKongregate?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithKongregate", "description": "Signs the user in using a Kongregate player account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithkongregate\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AuthTicket\": Token issued by Kongregate's client API for the user.\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"KongregateId\": Numeric user ID assigned by Kongregate\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"KongregateId\": \"457332\",\n \"AuthTicket\": \"SomeKongregateTokenHere\",\n \"CreateAccount\": false,\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithNintendoServiceAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithNintendoServiceAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithNintendoServiceAccount", "description": "Signs in the user with a Nintendo service account token.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoserviceaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"IdentityToken\": The JSON Web token (JWT) returned by Nintendo after login.\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"IdentityToken\": \"eyJraWQi...\",\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithNintendoSwitchDeviceId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithNintendoSwitchDeviceId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithNintendoSwitchDeviceId", "description": "Signs the user in using a Nintendo Switch Device ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithnintendoswitchdeviceid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"NintendoSwitchDeviceId\": Nintendo Switch unique identifier for the user's device.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"NintendoSwitchDeviceId\": \"526f79204261747479\",\n \"CreateAccount\": false,\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithOpenIdConnect", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithOpenIdConnect?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithOpenIdConnect", "description": "Logs in a user with an Open ID Connect JWT created by an existing relationship between a title and an Open ID Connect provider.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithopenidconnect\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ConnectionId\": A name that identifies which configured OpenID Connect provider relationship to use. Maximum 100 characters.\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"IdToken\": The JSON Web token (JWT) returned by the identity provider after login. Represented as the id_token field in the identity provider's response.\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ConnectionId\": \"exampleprovider\",\n \"IdToken\": \"eyJraWQi...\",\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithPSN", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithPSN?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithPSN", "description": "Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithpsn\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AuthCode\": Auth code provided by the PlayStation :tm: Network OAuth provider.\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"IssuerId\": Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"RedirectUri\": Redirect URI supplied to PlayStation :tm: Network when requesting an auth code\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"AuthCode\": \"LKJ6D896D\",\n \"RedirectUri\": \"orbis://games\",\n \"CreateAccount\": false,\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithPlayFab", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithPlayFab?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithPlayFab", "description": "Signs the user into the PlayFab account, returning a session identifier that can subsequently be used for API calls which require an authenticated user. Unlike most other login API calls, LoginWithPlayFab does not permit the creation of new accounts via the CreateAccountFlag. Username/Password credentials may be used to create accounts via RegisterPlayFabUser, or added to existing accounts using AddUsernamePassword.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithplayfab\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"Password\": Password for the PlayFab account (6-100 characters)\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\n\"Username\": PlayFab username for the account.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Username\": \"theuser\",\n \"Password\": \"ExampleSecret\",\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithSteam", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithSteam?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithSteam", "description": "Signs the user in using a Steam authentication ticket, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithsteam\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"SteamTicket\": Authentication token for the user, returned as a byte array from Steam, and converted to a string (for example, the byte 0x08 should become \"08\").\n\n\"TicketIsServiceSpecific\": True if ticket was generated using ISteamUser::GetAuthTicketForWebAPI() using \"AzurePlayFab\" as the identity string. False if the ticket was generated with ISteamUser::GetAuthSessionTicket().\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"SteamTicket\": \"steamTicketID\",\n \"CreateAccount\": false,\n \"TicketIsServiceSpecific\": true,\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithTwitch", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithTwitch?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithTwitch", "description": "Signs the user in using a Twitch access token.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithtwitch\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AccessToken\": Token issued by Twitch's API for the user.\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"AccessToken\": \"SomeTwitchTokenHere\",\n \"CreateAccount\": false,\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-LoginWithXbox", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/LoginWithXbox?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithXbox", "description": "Signs the user in using a Xbox Live Token, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithxbox\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\n\"XboxToken\": Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(\"POST\", \"https://playfabapi.com/\", \"\").\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"XboxToken\": \"XBL3.0 x=1981989841;akljdlkafdknad\",\n \"CreateAccount\": false,\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-OpenTrade", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/OpenTrade?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "OpenTrade", "description": "Opens a new outstanding trade. Note that a given item instance may only be in one open trade at a time.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/trading/opentrade\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AllowedPlayerIds\": Players who are allowed to accept the trade. If null, the trade may be accepted by any player. If empty, the trade may not be accepted by any player.\n\n\"OfferedInventoryInstanceIds\": Player inventory items offered for trade. If not set, the trade is effectively a gift request\n\n\"RequestedCatalogItemIds\": Catalog items accepted for the trade. If not set, the trade is effectively a gift.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"OfferedInventoryInstanceIds\": [\n \"1359447\",\n \"635691\"\n ],\n \"RequestedCatalogItemIds\": [\n \"rare_hat_7\"\n ]\n}" }, { "id": "client-PayForPurchase", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/PayForPurchase?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "PayForPurchase", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Selects a payment option for purchase order created via StartPurchase\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-item-management/payforpurchase\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Currency\": Currency to use to fund the purchase.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"OrderId\": Purchase order identifier returned from StartPurchase.\n\n\"ProviderName\": Payment provider to use to fund the purchase.\n\n\"ProviderTransactionId\": Payment provider transaction identifier. Required for Facebook Payments.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"OrderId\": \"8853591446005860822\",\n \"ProviderName\": \"PayPal\",\n \"Currency\": \"RM\"\n}" }, { "id": "client-PurchaseItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/PurchaseItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "PurchaseItem", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ 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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-item-management/purchaseitem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version for the items to be purchased (defaults to most recent version.\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ItemId\": Unique identifier of the item to purchase.\n\n\"Price\": Price the client expects to pay for the item (in case a new catalog or store was uploaded, with new prices).\n\n\"StoreId\": Store to buy this item through. If not set, prices default to those in the catalog.\n\n\"VirtualCurrency\": Virtual currency to use to purchase the item.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ItemId\": \"shield_level_5\",\n \"VirtualCurrency\": \"GV\",\n \"Price\": 25\n}" }, { "id": "client-RedeemCoupon", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/RedeemCoupon?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RedeemCoupon", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ 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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-item-management/redeemcoupon\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version of the coupon. If null, uses the default catalog\n\n\"CharacterId\": Optional identifier for the Character that should receive the item. If null, item is added to the player\n\n\"CouponCode\": Generated coupon code to redeem.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CouponCode\": \"123-1234-123\",\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\"\n}" }, { "id": "client-RefreshPSNAuthToken", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/RefreshPSNAuthToken?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RefreshPSNAuthToken", "description": "Uses the supplied OAuth code to refresh the internally cached player PlayStation :tm: Network auth token\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/refreshpsnauthtoken\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AuthCode\": Auth code returned by PlayStation :tm: Network OAuth system.\n\n\"IssuerId\": Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment.\n\n\"RedirectUri\": Redirect URI supplied to PlayStation :tm: Network when requesting an auth code\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"AuthCode\": \"LKJDG7DDE\",\n \"RedirectUri\": \"orbis://games\"\n}" }, { "id": "client-RegisterForIOSPushNotification", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/RegisterForIOSPushNotification?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RegisterForIOSPushNotification", "description": "Registers the iOS device to receive push notifications\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/registerforiospushnotification\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ConfirmationMessage\": Message to display when confirming push notification.\n\n\"DeviceToken\": Unique token generated by the Apple Push Notification service when the title registered to receive push notifications.\n\n\"SendPushNotificationConfirmation\": If true, send a test push message immediately after sucessful registration. Defaults to false.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"DeviceToken\": \"39872f98eb882brn8hg3889\",\n \"SendPushNotificationConfirmation\": true,\n \"ConfirmationMessage\": \"Welcome to PlayFab\"\n}" }, { "id": "client-RegisterPlayFabUser", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/RegisterPlayFabUser?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RegisterPlayFabUser", "description": "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 a username and an email address.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/registerplayfabuser\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"DisplayName\": An optional parameter for setting the display name for this title (3-25 characters).\n\n\"Email\": User email address attached to their account\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"Password\": Password for the PlayFab account (6-100 characters)\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"RequireBothUsernameAndEmail\": An optional parameter that specifies whether both the username and email parameters are required. If true, both parameters are required; if false, the user must supply either the username or email parameter. The default value is true.\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\n\"Username\": PlayFab username for the account (3-20 characters)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Username\": \"theuser\",\n \"Email\": \"me@here.com\",\n \"Password\": \"ExampleSecret\",\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "client-RemoveContactEmail", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/RemoveContactEmail?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemoveContactEmail", "description": "Removes a contact email from the player's profile.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/removecontactemail\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-RemoveFriend", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/RemoveFriend?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemoveFriend", "description": "Removes a specified user from the friend list of the local user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/removefriend\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"FriendPlayFabId\": PlayFab identifier of the friend account which is to be removed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"FriendPlayFabId\": \"29837799\"\n}" }, { "id": "client-RemoveGenericID", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/RemoveGenericID?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemoveGenericID", "description": "Removes the specified generic service identifier from the player's PlayFab account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/removegenericid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"GenericId\": Generic service identifier to be removed from the player.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"GenericId\": {\n \"ServiceName\": \"BigBizSocial\",\n \"UserId\": \"1234567890\"\n }\n}" }, { "id": "client-RemoveSharedGroupMembers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/RemoveSharedGroupMembers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemoveSharedGroupMembers", "description": "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, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/removesharedgroupmembers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabIds\": An array of unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"SharedGroupId\": Unique identifier for the shared group.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"SharedGroupId\": \"Clan Data\",\n \"PlayFabIds\": [\n \"D984A64B832\",\n \"F74A523E1562\"\n ]\n}" }, { "id": "client-ReportAdActivity", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/ReportAdActivity?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ReportAdActivity", "description": "Report player's ad activity\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/advertising/reportadactivity\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Activity\": Type of activity, may be Opened, Closed, Start or End\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlacementId\": Unique ID of the placement to report for\n\n\"RewardId\": Unique ID of the reward the player was offered\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"PlacementId\": \"A124572382B\",\n \"RewardId\": \"B2674981A\",\n \"Activity\": \"End\"\n}" }, { "id": "client-ReportDeviceInfo", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/ReportDeviceInfo?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ReportDeviceInfo", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/analytics/reportdeviceinfo\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Info\": Information posted to the PlayStream Event. Currently arbitrary, and specific to the environment sending it.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Info\": {\n \"UserAgent\": \"Some Browser\",\n \"ScreenResolution\": \"640x480\",\n \"processorCount\": \"2\"\n }\n}" }, { "id": "client-ReportPlayer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/ReportPlayer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ReportPlayer", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/reportplayer\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Comment\": Optional additional comment by reporting player.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ReporteeId\": Unique PlayFab identifier of the reported player.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ReporteeId\": \"1a46086aed40f142\",\n \"Comment\": \"cheating\"\n}" }, { "id": "client-RestoreIOSPurchases", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/RestoreIOSPurchases?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RestoreIOSPurchases", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Restores all in-app purchases based on the given restore receipt\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/restoreiospurchases\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version of the restored items. If null, defaults to primary catalog.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ReceiptData\": Base64 encoded receipt data, passed back by the App Store as a result of a successful purchase.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ReceiptData\": \"F00000000000000000000\"\n}" }, { "id": "client-RewardAdActivity", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/RewardAdActivity?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RewardAdActivity", "description": "Reward player's ad activity\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/advertising/rewardadactivity\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlacementId\": Placement unique ID\n\n\"RewardId\": Reward unique ID\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"PlacementId\": \"A124572382B\",\n \"RewardId\": \"B2674981A\"\n}" }, { "id": "client-SendAccountRecoveryEmail", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/Client/SendAccountRecoveryEmail?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SendAccountRecoveryEmail", "description": "Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password.If an account recovery email template ID is provided, an email using the custom email template will be used.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/sendaccountrecoveryemail\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Email\": User email address attached to their account\n\n\"EmailTemplateId\": The email template id of the account recovery email template to send.\n\n\"TitleId\": Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Email\": \"Me@here.com\",\n \"TitleId\": \"{{TitleId}}\",\n \"EmailTemplateId\": \"D53AB15D8F12E330\"\n}" }, { "id": "client-SetFriendTags", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/SetFriendTags?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetFriendTags", "description": "Updates the tag list for a specified user in the friend list of the local user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/friend-list-management/setfriendtags\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"FriendPlayFabId\": PlayFab identifier of the friend account to which the tag(s) should be applied.\n\n\"Tags\": Array of tags to set on the friend account.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"FriendPlayFabId\": \"29837799\",\n \"Tags\": [\n \"great sniper\",\n \"no good at melee\"\n ]\n}" }, { "id": "client-SetPlayerSecret", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/SetPlayerSecret?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetPlayerSecret", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/authentication/setplayersecret\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"EncryptedRequest\": Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"PlayerSecret\": \"A cryptographically strong string\"\n}" }, { "id": "client-StartPurchase", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/StartPurchase?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "StartPurchase", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Creates an order for a list of items from the title catalog\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-item-management/startpurchase\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version for the items to be purchased. Defaults to most recent catalog.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Items\": Array of items to purchase.\n\n\"StoreId\": Store through which to purchase items. If not set, prices will be pulled from the catalog itself.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\",\n \"StoreId\": \"BonusStore\",\n \"Items\": [\n {\n \"ItemId\": \"something\",\n \"Quantity\": 1,\n \"Annotation\": \"totally buying something\"\n }\n ]\n}" }, { "id": "client-SubtractUserVirtualCurrency", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/SubtractUserVirtualCurrency?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SubtractUserVirtualCurrency", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ 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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-item-management/subtractuservirtualcurrency\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Amount\": Amount to be subtracted from the user balance of the specified virtual currency.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"VirtualCurrency\": Name of the virtual currency which is to be decremented.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"VirtualCurrency\": \"GC\",\n \"Amount\": 100\n}" }, { "id": "client-UnlinkAndroidDeviceID", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkAndroidDeviceID?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkAndroidDeviceID", "description": "Unlinks the related Android device identifier from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkandroiddeviceid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AndroidDeviceId\": Android device identifier for the user's device. If not specified, the most recently signed in Android Device ID will be used.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"AndroidDeviceId\": \"526f79204261747479\"\n}" }, { "id": "client-UnlinkApple", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkApple?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkApple", "description": "Unlinks the related Apple account from the user's PlayFab account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkapple\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-UnlinkCustomID", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkCustomID?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkCustomID", "description": "Unlinks the related custom identifier from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkcustomid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomId\": Custom unique identifier for the user, generated by the title. If not specified, the most recently signed in Custom ID will be used.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CustomId\": \"67AB-5397-CC54-EA31\"\n}" }, { "id": "client-UnlinkFacebookAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkFacebookAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkFacebookAccount", "description": "Unlinks the related Facebook account from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-UnlinkFacebookInstantGamesId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkFacebookInstantGamesId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkFacebookInstantGamesId", "description": "Unlinks the related Facebook Instant Game Ids from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkfacebookinstantgamesid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"FacebookInstantGamesId\": Facebook Instant Games identifier for the user. If not specified, the most recently signed in ID will be used.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"FacebookInstantGamesId\": \"1114685845316173\"\n}" }, { "id": "client-UnlinkGameCenterAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkGameCenterAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkGameCenterAccount", "description": "Unlinks the related Game Center account from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgamecenteraccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-UnlinkGoogleAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkGoogleAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkGoogleAccount", "description": "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).\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-UnlinkGooglePlayGamesServicesAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkGooglePlayGamesServicesAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkGooglePlayGamesServicesAccount", "description": "Unlinks the related Google Play Games account from the user's PlayFab account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkgoogleplaygamesservicesaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-UnlinkIOSDeviceID", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkIOSDeviceID?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkIOSDeviceID", "description": "Unlinks the related iOS device identifier from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkiosdeviceid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"DeviceId\": Vendor-specific iOS identifier for the user's device. If not specified, the most recently signed in iOS Device ID will be used.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"DeviceId\": \"29848d9bh8900a0b003\"\n}" }, { "id": "client-UnlinkKongregate", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkKongregate?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkKongregate", "description": "Unlinks the related Kongregate identifier from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkkongregate\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-UnlinkNintendoServiceAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkNintendoServiceAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkNintendoServiceAccount", "description": "Unlinks the related Nintendo account from the user's PlayFab account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoserviceaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-UnlinkNintendoSwitchDeviceId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkNintendoSwitchDeviceId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkNintendoSwitchDeviceId", "description": "Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinknintendoswitchdeviceid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"NintendoSwitchDeviceId\": Nintendo Switch Device identifier for the user. If not specified, the most recently signed in device ID will be used.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"NintendoSwitchDeviceId\": \"526f79204261747479\"\n}" }, { "id": "client-UnlinkOpenIdConnect", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkOpenIdConnect?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkOpenIdConnect", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkopenidconnect\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ConnectionId\": A name that identifies which configured OpenID Connect provider relationship to use. Maximum 100 characters.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ConnectionId\": \"exampleprovider\"\n}" }, { "id": "client-UnlinkPSNAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkPSNAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkPSNAccount", "description": "Unlinks the related PlayStation :tm: Network account from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkpsnaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-UnlinkSteamAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkSteamAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkSteamAccount", "description": "Unlinks the related Steam account from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinksteamaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-UnlinkTwitch", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkTwitch?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkTwitch", "description": "Unlinks the related Twitch account from the user's PlayFab account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinktwitch\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AccessToken\": Valid token issued by Twitch. Used to specify which twitch account to unlink from the profile. By default it uses the one that is present on the profile.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-UnlinkXboxAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlinkXboxAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkXboxAccount", "description": "Unlinks the related Xbox Live account from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkxboxaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{}" }, { "id": "client-UnlockContainerInstance", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlockContainerInstance?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlockContainerInstance", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ 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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontainerinstance\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Specifies the catalog version that should be used to determine container contents. If unspecified, uses catalog associated with the item instance.\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"ContainerItemInstanceId\": ItemInstanceId of the container to unlock.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"KeyItemInstanceId\": ItemInstanceId of the key that will be consumed by unlocking this container. If the container requires a key, this parameter is required.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ContainerItemInstanceId\": \"123456788\",\n \"KeyItemInstanceId\": \"123456789\"\n}" }, { "id": "client-UnlockContainerItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UnlockContainerItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlockContainerItem", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ 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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-item-management/unlockcontaineritem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Specifies the catalog version that should be used to determine container contents. If unspecified, uses default/primary catalog.\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"ContainerItemId\": Catalog ItemId of the container type to unlock.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ContainerItemId\": \"crate block 1\"\n}" }, { "id": "client-UpdateAvatarUrl", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UpdateAvatarUrl?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateAvatarUrl", "description": "Update the avatar URL of the player\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/updateavatarurl\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ImageUrl\": URL of the avatar image. If empty, it removes the existing avatar URL.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ImageUrl\": \"https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50\"\n}" }, { "id": "client-UpdateCharacterData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UpdateCharacterData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateCharacterData", "description": "Creates and updates the title-specific custom data for the user's character which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/character-data/updatecharacterdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys written in this request. Defaults to \"private\" if not set.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CharacterId\": \"{{CharacterId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "client-UpdateCharacterStatistics", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UpdateCharacterStatistics?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateCharacterStatistics", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/characters/updatecharacterstatistics\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CharacterStatistics\": Statistics to be updated with the provided values, in the Key(string), Value(int) pattern.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CharacterId\": \"{{CharacterId}}\",\n \"CharacterStatistics\": {\n \"Headshots\": 18,\n \"Kills\": 47\n }\n}" }, { "id": "client-UpdatePlayerStatistics", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UpdatePlayerStatistics?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdatePlayerStatistics", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayerstatistics\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Statistics\": Statistics to be updated with the provided values\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Statistics\": [\n {\n \"StatisticName\": \"Points\",\n \"Version\": 1,\n \"Value\": 600\n },\n {\n \"StatisticName\": \"Wins\",\n \"Version\": 0,\n \"Value\": 16\n },\n {\n \"StatisticName\": \"Stars\",\n \"Value\": 7\n }\n ]\n}" }, { "id": "client-UpdateSharedGroupData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UpdateSharedGroupData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateSharedGroupData", "description": "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, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/updatesharedgroupdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys in this request.\n\n\"SharedGroupId\": Unique identifier for the shared group.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"SharedGroupId\": \"Clan Data\",\n \"Data\": {\n \"ClanKills\": \"34\",\n \"LastClanUpdate\": \"2014-10-03T09:21:14Z\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "client-UpdateUserData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UpdateUserData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserData", "description": "Creates and updates the title-specific custom data for the user which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys written in this request. Defaults to \"private\" if not set. This is used for requests by one player for information about another player; those requests will only return Public keys.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "client-UpdateUserPublisherData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UpdateUserPublisherData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserPublisherData", "description": "Creates and updates the publisher-specific custom data for the user which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateuserpublisherdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys written in this request. Defaults to \"private\" if not set. This is used for requests by one player for information about another player; those requests will only return Public keys.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "client-UpdateUserTitleDisplayName", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/UpdateUserTitleDisplayName?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserTitleDisplayName", "description": "Updates the title specific display name for the user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/account-management/updateusertitledisplayname\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"DisplayName\": New title display name for the user - must be between 3 and 25 characters.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"DisplayName\": \"User Title Name\"\n}" }, { "id": "client-ValidateAmazonIAPReceipt", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/ValidateAmazonIAPReceipt?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ValidateAmazonIAPReceipt", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates with Amazon that the receipt for an Amazon App Store in-app purchase is valid and that it matches the purchased catalog item\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateamazoniapreceipt\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version of the fulfilled items. If null, defaults to the primary catalog.\n\n\"CurrencyCode\": Currency used to pay for the purchase (ISO 4217 currency code).\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PurchasePrice\": Amount of the stated currency paid, in centesimal units.\n\n\"ReceiptId\": ReceiptId returned by the Amazon App Store in-app purchase API\n\n\"UserId\": AmazonId of the user making the purchase as returned by the Amazon App Store in-app purchase API\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ReceiptId\": \"q1YqVbJSyjH28DGPKChw9c0o8nd3vSstssQtzSkrzM8tCk43K6z0d_HOTcwwN8vxCrVV0lEqBmpJzs_VK8hJrExLTNLLTCzQK8_MSUnJTy8LSpcoWRnoKKUAFRmaGBtZmBqCCFMzpVoA\",\n \"UserId\": \"l3HL7XppEMhrOGDgur9-ulvqomrSg6qyODKmah72lJU=\"\n}" }, { "id": "client-ValidateGooglePlayPurchase", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/ValidateGooglePlayPurchase?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ValidateGooglePlayPurchase", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates a Google Play purchase and gives the corresponding item to the player.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validategoogleplaypurchase\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version of the fulfilled items. If null, defaults to the primary catalog.\n\n\"CurrencyCode\": Currency used to pay for the purchase (ISO 4217 currency code).\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PurchasePrice\": Amount of the stated currency paid, in centesimal units.\n\n\"ReceiptJson\": Original JSON string returned by the Google Play IAB API.\n\n\"Signature\": Signature returned by the Google Play IAB API.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CatalogVersion\": \"String\",\n \"CurrencyCode\": \"String\",\n \"CustomTags\": \"String\",\n \"PurchasePrice\": \"Number\",\n \"ReceiptJson\": \"String\",\n \"Signature\": \"String\"\n}" }, { "id": "client-ValidateIOSReceipt", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/ValidateIOSReceipt?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ValidateIOSReceipt", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates with the Apple store that the receipt for an iOS in-app purchase is valid and that it matches the purchased catalog item\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validateiosreceipt\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version of the fulfilled items. If null, defaults to the primary catalog.\n\n\"CurrencyCode\": Currency used to pay for the purchase (ISO 4217 currency code).\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PurchasePrice\": Amount of the stated currency paid, in centesimal units.\n\n\"ReceiptData\": Base64 encoded receipt data, passed back by the App Store as a result of a successful purchase.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"ReceiptData\": \"MTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMg0KMzMzMzMzMzMzMzMzMzMzMzMNCjQ0NDQ0NDQ0NDQ0NDQNCjU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NQ0KNjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3Nzc3NzcNCjg4DQo5OTk5OTk5OTk5OTkNCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMA0KMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjINCjMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMw0KNDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0DQo1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1DQo2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3NzcNCjg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4DQo5DQpBcHBsZSBJbmMuIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENlcnRpZmljYXRpb24gQXV0aG9yaXR5IChub3QgcmVhbGx5IC0gZmFrZSBQbGF5RmFiIGV4YW1wbGUsIGJ1dCBjb25ncmF0cyBvbiB0aGlua2luZyB0byBkZWNvZGUgdGhpcyEpDQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwDQoxMTExMTExMTExMQ0KMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyDQozMzMzMzMzMzMzMzMzMzMzMw0KNDQ0NDQ0NDQ0NDQ0NA0KNTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1DQo2NjY2NjY2NjY2NjY2DQo3Nzc3Nzc3Nzc3Nzc3Nw0KODgNCjk5OTk5OTk5OTk5OQ0KMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwDQoxMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMQ0KMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMg0KMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzDQo0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQNCjU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTUNCjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2DQo3Nzc3Nzc3Nzc3Nw0KODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODgNCjkNCkFwcGxlIEluYy4gV29ybGR3aWRlIERldmVsb3BlciBSZWxhdGlvbnMgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkgKG5vdCByZWFsbHkgLSBmYWtlIFBsYXlGYWIgZXhhbXBsZSwgYnV0IGNvbmdyYXRzIG9uIHRoaW5raW5nIHRvIGRlY29kZSB0aGlzISkNCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDANCjExMTExMTExMTExDQoyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjINCjMzMzMzMzMzMzMzMzMzMzMzDQo0NDQ0NDQ0NDQ0NDQ0DQo1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTUNCjY2NjY2NjY2NjY2NjYNCjc3Nzc3Nzc3Nzc3Nzc3DQo4OA0KOTk5OTk5OTk5OTk5DQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDANCjExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExDQoyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyDQozMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMNCjQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NA0KNTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NQ0KNjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjYNCjc3Nzc3Nzc3Nzc3DQo4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4OA0KOQ0KQXBwbGUgSW5jLiBXb3JsZHdpZGUgRGV2ZWxvcGVyIFJlbGF0aW9ucyBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eSAobm90IHJlYWxseSAtIGZha2UgUGxheUZhYiBleGFtcGxlLCBidXQgY29uZ3JhdHMgb24gdGhpbmtpbmcgdG8gZGVjb2RlIHRoaXMhKQ0KMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMA0KMTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMg0KMzMzMzMzMzMzMzMzMzMzMzMNCjQ0NDQ0NDQ0NDQ0NDQNCjU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NQ0KNjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3Nzc3NzcNCjg4DQo5OTk5OTk5OTk5OTkNCjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMA0KMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTExMTENCjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjINCjMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMw0KNDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0DQo1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1NTU1DQo2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2Ng0KNzc3Nzc3Nzc3NzcNCjg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4ODg4DQo5DQpBcHBsZSBJbmMuIFdvcmxkd2lkZSBEZXZlbG9wZXIgUmVsYXRpb25zIENlcnRpZmljYXRpb24gQXV0aG9yaXR5IChub3QgcmVhbGx5IC0gZmFrZSBQbGF5RmFiIGV4YW1wbGUsIGJ1dCBjb25ncmF0cyBvbiB0aGlua2luZyB0byBkZWNvZGUgdGhpcyEpDQowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw\",\n \"CurrencyCode\": \"GBP\",\n \"PurchasePrice\": 199\n}" }, { "id": "client-ValidateWindowsStoreReceipt", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/ValidateWindowsStoreReceipt?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ValidateWindowsStoreReceipt", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Validates with Windows that the receipt for an Windows App Store in-app purchase is valid and that it matches the purchased catalog item\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/platform-specific-methods/validatewindowsstorereceipt\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version of the fulfilled items. If null, defaults to the primary catalog.\n\n\"CurrencyCode\": Currency used to pay for the purchase (ISO 4217 currency code).\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PurchasePrice\": Amount of the stated currency paid, in centesimal units.\n\n\"Receipt\": XML Receipt returned by the Windows App Store in-app purchase API\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CatalogVersion\": \"String\",\n \"CurrencyCode\": \"String\",\n \"CustomTags\": \"String\",\n \"PurchasePrice\": \"Number\",\n \"Receipt\": \"String\"\n}" }, { "id": "client-WriteCharacterEvent", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/WriteCharacterEvent?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "WriteCharacterEvent", "description": "Writes a character-based event into PlayStream.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/analytics/writecharacterevent\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Body\": Custom event properties. Each property consists of a name (string) and a value (JSON object).\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EventName\": The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it commonly follows the subject_verb_object pattern (e.g. player_logged_in).\n\n\"Timestamp\": The time (in UTC) associated with this event. The value defaults to the current time.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"CharacterId\": \"{{CharacterId}}\",\n \"EventName\": \"character_defeated_enemy\",\n \"Timestamp\": \"2016-03-07T00:00:00Z\",\n \"Body\": {\n \"Enemy\": \"guardian\",\n \"Damage\": 5,\n \"Coordinates\": {\n \"X\": 123.4,\n \"Y\": 543.2\n }\n }\n}" }, { "id": "client-WritePlayerEvent", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/WritePlayerEvent?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "WritePlayerEvent", "description": "Writes a player-based event into PlayStream.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/analytics/writeplayerevent\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Body\": Custom data properties associated with the event. Each property consists of a name (string) and a value (JSON object).\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EventName\": The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it commonly follows the subject_verb_object pattern (e.g. player_logged_in).\n\n\"Timestamp\": The time (in UTC) associated with this event. The value defaults to the current time.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"EventName\": \"player_defeated_enemy\",\n \"Timestamp\": \"2014-03-07T00:00:00Z\",\n \"Body\": {\n \"Enemy\": \"guardian\",\n \"Damage\": 5,\n \"Coordinates\": {\n \"X\": 123.4,\n \"Y\": 543.2\n }\n }\n}" }, { "id": "client-WriteTitleEvent", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\n", "url": "https://{{TitleId}}.playfabapi.com/Client/WriteTitleEvent?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "WriteTitleEvent", "description": "Writes a title-based event into PlayStream.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/client/analytics/writetitleevent\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SessionTicket\" - The string returned as \"SessionTicket\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Body\": Custom event properties. Each property consists of a name (string) and a value (JSON object).\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EventName\": The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it commonly follows the subject_verb_object pattern (e.g. player_logged_in).\n\n\"Timestamp\": The time (in UTC) associated with this event. The value defaults to the current time.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-clientFolder", "rawModeData": "{\n \"EventName\": \"client_update_submitted\",\n \"Timestamp\": \"2016-03-07T00:00:00Z\",\n \"Body\": {\n \"Version\": \"1.4.50\"\n }\n}" }, { "id": "server-AddCharacterVirtualCurrency", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/AddCharacterVirtualCurrency?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddCharacterVirtualCurrency", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increments the character's balance of the specified virtual currency by the stated amount\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/addcharactervirtualcurrency\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Amount\": Amount to be added to the character balance of the specified virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase over this value will be discarded.\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": PlayFab unique identifier of the user whose virtual currency balance is to be incremented.\n\n\"VirtualCurrency\": Name of the virtual currency which is to be incremented.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"VirtualCurrency\": \"GC\",\n \"Amount\": 100\n}" }, { "id": "server-AddFriend", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/AddFriend?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddFriend", "description": "Adds the Friend user to the friendlist of the user with PlayFabId. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/addfriend\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"FriendEmail\": Email address of the user being added.\n\n\"FriendPlayFabId\": The PlayFab identifier of the user being added.\n\n\"FriendTitleDisplayName\": Title-specific display name of the user to being added.\n\n\"FriendUsername\": The PlayFab username of the user being added\n\n\"PlayFabId\": PlayFab identifier of the player to add a new friend.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"FriendPlayFabId\": \"20394883\"\n}" }, { "id": "server-AddGenericID", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/AddGenericID?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddGenericID", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/addgenericid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"GenericId\": Generic service identifier to add to the player account.\n\n\"PlayFabId\": PlayFabId of the user to link.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"GenericId\": {\n \"ServiceName\": \"BigBizSocial\",\n \"UserId\": \"1234567890\"\n }\n}" }, { "id": "server-AddPlayerTag", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/AddPlayerTag?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddPlayerTag", "description": "Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/playstream/addplayertag\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"TagName\": Unique tag for player profile.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"TagName\": \"MostKilled\"\n}" }, { "id": "server-AddSharedGroupMembers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/AddSharedGroupMembers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddSharedGroupMembers", "description": "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, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/addsharedgroupmembers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabIds\": An array of unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"SharedGroupId\": Unique identifier for the shared group.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"SharedGroupId\": \"Clan Data\",\n \"PlayFabIds\": [\n \"D984A64B832\",\n \"F74A523E1562\"\n ]\n}" }, { "id": "server-AddUserVirtualCurrency", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/AddUserVirtualCurrency?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddUserVirtualCurrency", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Increments the user's balance of the specified virtual currency by the stated amount\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/adduservirtualcurrency\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Amount\": Amount to be added to the user balance of the specified virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase over this value will be discarded.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": PlayFab unique identifier of the user whose virtual currency balance is to be increased.\n\n\"VirtualCurrency\": Name of the virtual currency which is to be incremented.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"VirtualCurrency\": \"GC\",\n \"Amount\": 100\n}" }, { "id": "server-AuthenticateSessionTicket", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/AuthenticateSessionTicket?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AuthenticateSessionTicket", "description": "Validated a client's session ticket, and if successful, returns details for that user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/authentication/authenticatesessionticket\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"SessionTicket\": Session ticket as issued by a PlayFab client login API.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"SessionTicket\": \"4D2----8D11F4249A80000-7C64AB0A9F1D8D1A.CD803BF233CE76CC\"\n}" }, { "id": "server-AwardSteamAchievement", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/AwardSteamAchievement?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AwardSteamAchievement", "description": "Awards the specified users the specified Steam achievements\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/platform-specific-methods/awardsteamachievement\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Achievements\": Array of achievements to grant and the users to whom they are to be granted.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"Achievements\": [\n {\n \"PlayFabId\": \"234974573892\",\n \"AchievementName\": \"FinishLevel1\",\n \"Result\": false\n },\n {\n \"PlayFabId\": \"334353433\",\n \"AchievementName\": \"FinishLevel1\",\n \"Result\": false\n }\n ]\n}" }, { "id": "server-BanUsers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/BanUsers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "BanUsers", "description": "Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/banusers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Bans\": List of ban requests to be applied. Maximum 100.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"Bans\": [\n {\n \"PlayFabId\": \"1679AF5CD04BD838\",\n \"IPAddress\": \"192.168.1.1\",\n \"Reason\": \"You cheated!\",\n \"DurationInHours\": 7\n },\n {\n \"PlayFabId\": \"2329AF5CD04BF513\",\n \"Reason\": \"Caught you using speed hack!\"\n }\n ]\n}" }, { "id": "server-ConsumeItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/ConsumeItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ConsumeItem", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Consume uses of a consumable item. When all uses are consumed, it will be removed from the player's inventory.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/consumeitem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"ConsumeCount\": Number of uses to consume from the item.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ItemInstanceId\": Unique instance identifier of the item to be consumed.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"ItemInstanceId\": \"94585729\",\n \"ConsumeCount\": 1\n}" }, { "id": "server-CreateSharedGroup", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/CreateSharedGroup?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateSharedGroup", "description": "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, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/createsharedgroup\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"SharedGroupId\": Unique identifier for the shared group (a random identifier will be assigned, if one is not specified).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"SharedGroupId\": \"Clan Data\"\n}" }, { "id": "server-DeleteCharacterFromUser", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/DeleteCharacterFromUser?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteCharacterFromUser", "description": "Deletes the specific character ID from the specified user.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/characters/deletecharacterfromuser\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"SaveCharacterInventory\": If true, the character's inventory will be transferred up to the owning user; otherwise, this request will purge those items.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"SaveCharacterInventory\": false\n}" }, { "id": "server-DeletePlayer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/DeletePlayer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeletePlayer", "description": "Removes a user's player account from a title and deletes all associated data\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/deleteplayer\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-DeletePushNotificationTemplate", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/DeletePushNotificationTemplate?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeletePushNotificationTemplate", "description": "Deletes push notification template for title\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/deletepushnotificationtemplate\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PushNotificationTemplateId\": Id of the push notification template to be deleted.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PushNotificationTemplateId\": \"6bc7dbf0-075a-46e9-8e84-35737a22c6a4\"\n}" }, { "id": "server-DeleteSharedGroup", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/DeleteSharedGroup?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteSharedGroup", "description": "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, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/deletesharedgroup\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"SharedGroupId\": Unique identifier for the shared group.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"SharedGroupId\": \"Clan Data\"\n}" }, { "id": "server-EvaluateRandomResultTable", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/EvaluateRandomResultTable?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "EvaluateRandomResultTable", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Returns the result of an evaluation of a Random Result Table - the ItemId from the game Catalog which would have been added to the player inventory, if the Random Result Table were added via a Bundle or a call to UnlockContainer.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/evaluaterandomresulttable\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Specifies the catalog version that should be used to evaluate the Random Result Table. If unspecified, uses default/primary catalog.\n\n\"TableId\": The unique identifier of the Random Result Table to use.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"TableId\": \"RareElementCard\",\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\"\n}" }, { "id": "server-ExecuteCloudScript", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/ExecuteCloudScript?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ExecuteCloudScript", "description": "Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The PlayFab ID is the entity ID of the player's master_player_account entity.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/server-side-cloud-script/executecloudscript\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"FunctionName\": The name of the CloudScript function to execute\n\n\"FunctionParameter\": Object that is passed in to the function as the first argument\n\n\"GeneratePlayStreamEvent\": Generate a 'player_executed_cloudscript' PlayStream event containing the results of the function execution and other contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.\n\n\"PlayFabId\": The unique user identifier for the player on whose behalf the script is being run\n\n\"RevisionSelection\": Option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live' executes the current live, published revision, and 'Specific' executes the specified revision. The default value is 'Specific', if the SpeificRevision parameter is specified, otherwise it is 'Live'.\n\n\"SpecificRevision\": The specivic revision to execute, when RevisionSelection is set to 'Specific'\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"FunctionName\": \"levelCompleted\",\n \"FunctionParameter\": {\n \"level\": 3,\n \"points\": 400\n },\n \"RevisionSelection\": \"Live\",\n \"GeneratePlayStreamEvent\": true\n}" }, { "id": "server-GetAllSegments", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetAllSegments?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetAllSegments", "description": "Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/playstream/getallsegments\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{}" }, { "id": "server-GetAllUsersCharacters", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetAllUsersCharacters?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetAllUsersCharacters", "description": "Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/characters/getalluserscharacters\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-GetCatalogItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetCatalogItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCatalogItems", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified version of the title's catalog of virtual goods, including all defined properties\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getcatalogitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Which catalog is being requested. If null, uses the default catalog.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\"\n}" }, { "id": "server-GetCharacterData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetCharacterData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCharacterData", "description": "Retrieves the title-specific custom data for the user which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 1\n}" }, { "id": "server-GetCharacterInternalData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetCharacterInternalData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCharacterInternalData", "description": "Retrieves the title-specific custom data for the user's character which cannot be accessed by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterinternaldata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 1\n}" }, { "id": "server-GetCharacterInventory", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetCharacterInventory?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCharacterInventory", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified character's current inventory of virtual goods\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getcharacterinventory\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Used to limit results to only those from a specific catalog version.\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\"\n}" }, { "id": "server-GetCharacterLeaderboard", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetCharacterLeaderboard?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCharacterLeaderboard", "description": "Retrieves a list of ranked characters for the given statistic, starting from the indicated point in the leaderboard\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterleaderboard\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"MaxResultsCount\": Maximum number of entries to retrieve.\n\n\"StartPosition\": First entry in the leaderboard to be retrieved.\n\n\"StatisticName\": Unique identifier for the title-specific statistic for the leaderboard.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"StatisticName\": \"Kills\",\n \"StartPosition\": 0,\n \"MaxResultsCount\": 20\n}" }, { "id": "server-GetCharacterReadOnlyData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetCharacterReadOnlyData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCharacterReadOnlyData", "description": "Retrieves the title-specific custom data for the user's character which can only be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/character-data/getcharacterreadonlydata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 1\n}" }, { "id": "server-GetCharacterStatistics", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetCharacterStatistics?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCharacterStatistics", "description": "Retrieves the details of all title-specific statistics for the specific character\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/characters/getcharacterstatistics\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\"\n}" }, { "id": "server-GetContentDownloadUrl", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetContentDownloadUrl?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetContentDownloadUrl", "description": "This API retrieves a pre-signed URL for accessing a content file for the title. A subsequent HTTP GET to the returned URL will attempt to download the content. A HEAD query to the returned URL will attempt to retrieve the metadata of the content. Note that a successful result does not guarantee the existence of this content - if it has not been uploaded, the query to retrieve the data will fail. See this post for more information: https://community.playfab.com/hc/community/posts/205469488-How-to-upload-files-to-PlayFab-s-Content-Service. Also, please be aware that the Content service is specifically PlayFab's CDN offering, for which standard CDN rates apply.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/content/getcontentdownloadurl\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"HttpMethod\": HTTP method to fetch item - GET or HEAD. Use HEAD when only fetching metadata. Default is GET.\n\n\"Key\": Key of the content item to fetch, usually formatted as a path, e.g. images/a.png\n\n\"ThruCDN\": True to download through CDN. CDN provides higher download bandwidth and lower latency. However, if you want the latest, non-cached version of the content during development, set this to false. Default is true.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"Key\": \"images/sword_icon.png\"\n}" }, { "id": "server-GetFriendLeaderboard", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetFriendLeaderboard?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetFriendLeaderboard", "description": "Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the leaderboard\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getfriendleaderboard\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExternalPlatformFriends\": Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a comma-separated list of platforms.\n\n\"MaxResultsCount\": Maximum number of entries to retrieve.\n\n\"PlayFabId\": The player whose friend leaderboard to get\n\n\"ProfileConstraints\": If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager \"Client Profile Options\" tab in the \"Settings\" section.\n\n\"StartPosition\": Position in the leaderboard to start this listing (defaults to the first entry).\n\n\"StatisticName\": Statistic used to rank friends for this leaderboard.\n\n\"Version\": The version of the leaderboard to get.\n\n\"XboxToken\": Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"StatisticName\": \"Kills\",\n \"StartPosition\": 1258,\n \"MaxResultsCount\": 20,\n \"ExternalPlatformFriends\": \"None\"\n}" }, { "id": "server-GetFriendsList", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetFriendsList?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetFriendsList", "description": "Retrieves the current friends for the user with PlayFabId, constrained to users who have PlayFab accounts. Friends from linked accounts (Facebook, Steam) are also included. You may optionally exclude some linked services' friends.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/getfriendslist\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExternalPlatformFriends\": Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a comma-separated list of platforms.\n\n\"PlayFabId\": PlayFab identifier of the player whose friend list to get.\n\n\"ProfileConstraints\": If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager \"Client Profile Options\" tab in the \"Settings\" section.\n\n\"XboxToken\": Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"ExternalPlatformFriends\": \"All\"\n}" }, { "id": "server-GetLeaderboard", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetLeaderboard?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetLeaderboard", "description": "Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboard\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"MaxResultsCount\": Maximum number of entries to retrieve.\n\n\"ProfileConstraints\": If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager \"Client Profile Options\" tab in the \"Settings\" section.\n\n\"StartPosition\": First entry in the leaderboard to be retrieved.\n\n\"StatisticName\": Unique identifier for the title-specific statistic for the leaderboard.\n\n\"Version\": The version of the leaderboard to get.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"StatisticName\": \"Kills\",\n \"StartPosition\": 0,\n \"MaxResultsCount\": 20\n}" }, { "id": "server-GetLeaderboardAroundCharacter", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetLeaderboardAroundCharacter?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetLeaderboardAroundCharacter", "description": "Retrieves a list of ranked characters for the given statistic, centered on the requested user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardaroundcharacter\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"MaxResultsCount\": Maximum number of entries to retrieve.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"StatisticName\": Unique identifier for the title-specific statistic for the leaderboard.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"StatisticName\": \"Kills\",\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"MaxResultsCount\": 20\n}" }, { "id": "server-GetLeaderboardAroundUser", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetLeaderboardAroundUser?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetLeaderboardAroundUser", "description": "Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getleaderboardarounduser\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"MaxResultsCount\": Maximum number of entries to retrieve.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"ProfileConstraints\": If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager \"Client Profile Options\" tab in the \"Settings\" section.\n\n\"StatisticName\": Unique identifier for the title-specific statistic for the leaderboard.\n\n\"Version\": The version of the leaderboard to get.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"StatisticName\": \"Kills\",\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"MaxResultsCount\": 20\n}" }, { "id": "server-GetLeaderboardForUserCharacters", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetLeaderboardForUserCharacters?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetLeaderboardForUserCharacters", "description": "Retrieves a list of all of the user's characters for the given statistic.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/characters/getleaderboardforusercharacters\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"StatisticName\": Unique identifier for the title-specific statistic for the leaderboard.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"StatisticName\": \"Kills\",\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-GetPlayFabIDsFromFacebookIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayFabIDsFromFacebookIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromFacebookIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"FacebookIDs\": Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"FacebookIDs\": [\n \"857498576495\",\n \"759374651209\"\n ]\n}" }, { "id": "server-GetPlayFabIDsFromFacebookInstantGamesIds", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayFabIDsFromFacebookInstantGamesIds?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromFacebookInstantGamesIds", "description": "Retrieves the unique PlayFab identifiers for the given set of Facebook Instant Games identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookinstantgamesids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"FacebookInstantGamesIds\": Array of unique Facebook Instant Games identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 25 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"FacebookInstantGamesIds\": [\n \"1114685845316172\",\n \"1114685845316173\"\n ]\n}" }, { "id": "server-GetPlayFabIDsFromGenericIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayFabIDsFromGenericIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromGenericIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromgenericids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"GenericIDs\": Array of unique generic service identifiers for which the title needs to get PlayFab identifiers. Currently limited to a maximum of 10 in a single request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"GenericIDs\": [\n {\n \"ServiceName\": \"BigBizSocial\",\n \"UserId\": \"1234567890\"\n },\n {\n \"ServiceName\": \"VeeCeeMe\",\n \"UserId\": \"og5igh85gf43gf\"\n }\n ]\n}" }, { "id": "server-GetPlayFabIDsFromNintendoServiceAccountIds", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayFabIDsFromNintendoServiceAccountIds?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromNintendoServiceAccountIds", "description": "Retrieves the unique PlayFab identifiers for the given set of Nintendo Service Account identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoserviceaccountids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"NintendoAccountIds\": Array of unique Nintendo Switch Account identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"NintendoAccountIds\": [\n \"526f79204261747478\",\n \"526f79204261747479\"\n ]\n}" }, { "id": "server-GetPlayFabIDsFromNintendoSwitchDeviceIds", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayFabIDsFromNintendoSwitchDeviceIds?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromNintendoSwitchDeviceIds", "description": "Retrieves the unique PlayFab identifiers for the given set of Nintendo Switch Device identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoswitchdeviceids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"NintendoSwitchDeviceIds\": Array of unique Nintendo Switch Device identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"NintendoSwitchDeviceIds\": [\n \"526f79204261747478\",\n \"526f79204261747479\"\n ]\n}" }, { "id": "server-GetPlayFabIDsFromPSNAccountIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayFabIDsFromPSNAccountIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromPSNAccountIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnaccountids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IssuerId\": Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment.\n\n\"PSNAccountIDs\": Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PSNAccountIDs\": [\n \"857498576495\",\n \"759374651209\"\n ]\n}" }, { "id": "server-GetPlayFabIDsFromPSNOnlineIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayFabIDsFromPSNOnlineIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromPSNOnlineIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnonlineids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IssuerId\": Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment.\n\n\"PSNOnlineIDs\": Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PSNOnlineIDs\": [\n \"857555576495\",\n \"759345551209\"\n ]\n}" }, { "id": "server-GetPlayFabIDsFromSteamIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayFabIDsFromSteamIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromSteamIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"SteamStringIDs\": Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"SteamStringIDs\": [\n \"857498576495\",\n \"759374651209\"\n ]\n}" }, { "id": "server-GetPlayFabIDsFromTwitchIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayFabIDsFromTwitchIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromTwitchIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as \"_id\" from the Twitch API methods (ex: https://github.com/justintv/Twitch-API/blob/master/v3_resources/users.md#get-usersuser).\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromtwitchids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"TwitchIds\": Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"TwitchIds\": [\n \"127168541\",\n \"88315720\"\n ]\n}" }, { "id": "server-GetPlayFabIDsFromXboxLiveIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayFabIDsFromXboxLiveIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayFabIDsFromXboxLiveIDs", "description": "Retrieves the unique PlayFab identifiers for the given set of XboxLive identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromxboxliveids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Sandbox\": The ID of Xbox Live sandbox.\n\n\"XboxLiveAccountIDs\": Array of unique Xbox Live account identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 in length.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"XboxLiveAccountIDs\": [\n \"857498576495\",\n \"759374651209\"\n ],\n \"Sandbox\": \"RETAIL\"\n}" }, { "id": "server-GetPlayerCombinedInfo", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayerCombinedInfo?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerCombinedInfo", "description": "Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be returned. All parameters default to false.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercombinedinfo\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayFabId\": PlayFabId of the user whose data will be returned\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"InfoRequestParameters\": {\n \"GetUserAccountInfo\": true,\n \"GetUserInventory\": false,\n \"GetUserVirtualCurrency\": true,\n \"GetUserData\": true,\n \"UserDataKeys\": [\n \"preferences\",\n \"progress\"\n ],\n \"GetUserReadOnlyData\": false,\n \"GetCharacterInventories\": false,\n \"GetCharacterList\": false,\n \"GetTitleData\": false,\n \"GetPlayerStatistics\": false,\n \"GetPlayerProfile\": false\n }\n}" }, { "id": "server-GetPlayerProfile", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayerProfile?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerProfile", "description": "Retrieves the player's profile\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayerprofile\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"ProfileConstraints\": If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client, only the allowed client profile properties for the title may be requested. These allowed properties are configured in the Game Manager \"Client Profile Options\" tab in the \"Settings\" section.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-GetPlayerSegments", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayerSegments?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerSegments", "description": "List all segments that a player currently belongs to at this moment in time.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersegments\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-GetPlayerStatisticVersions", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayerStatisticVersions?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerStatisticVersions", "description": "Retrieves the information on the available versions of the specified statistic.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatisticversions\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"StatisticName\": unique name of the statistic\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"StatisticName\": \"headshots\"\n}" }, { "id": "server-GetPlayerStatistics", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayerStatistics?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerStatistics", "description": "Retrieves the current version and values for the indicated statistics, for the local player.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatistics\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": user for whom statistics are being requested\n\n\"StatisticNames\": statistics to return\n\n\"StatisticNameVersions\": statistics to return, if StatisticNames is not set (only statistics which have a version matching that provided will be returned)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"StatisticNames\": [\n \"Points\",\n \"Wins\"\n ]\n}" }, { "id": "server-GetPlayerTags", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayerTags?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayerTags", "description": "Get all tags with a given Namespace (optional) from a player profile.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayertags\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Namespace\": Optional namespace to filter results by\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Namespace\": \"title.AAA\"\n}" }, { "id": "server-GetPlayersInSegment", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPlayersInSegment?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPlayersInSegment", "description": "Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being called 30 times in one minute. You will be returned an error if you exceed this threshold.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersinsegment\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ContinuationToken\": Continuation token if retrieving subsequent pages of results.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"GetProfilesAsync\": If set to true, the profiles are loaded asynchronously and the response will include a continuation token and approximate profile count until the first batch of profiles is loaded. Use this parameter to help avoid network timeouts.\n\n\"MaxBatchSize\": Maximum is 10,000. The value 0 will prevent loading any profiles and return only the count of profiles matching this segment.\n\n\"SecondsToLive\": Number of seconds to keep the continuation token active. After token expiration it is not possible to continue paging results. Default is 300 (5 minutes). Maximum is 5,400 (90 minutes).\n\n\"SegmentId\": Unique identifier for this segment.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"SegmentId\": \"1337AA00\",\n \"SecondsToLive\": 5,\n \"MaxBatchSize\": 500\n}" }, { "id": "server-GetPublisherData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetPublisherData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPublisherData", "description": "Retrieves the key-value store of custom publisher settings\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getpublisherdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Keys\": array of keys to get back data from the Publisher data blob, set by the admin tools\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"Keys\": [\n \"color\",\n \"propertyA\"\n ]\n}" }, { "id": "server-GetRandomResultTables", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetRandomResultTables?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetRandomResultTables", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the configuration information for the specified random results tables for the title, including all ItemId values and weights\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getrandomresulttables\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Specifies the catalog version that should be used to retrieve the Random Result Tables. If unspecified, uses default/primary catalog.\n\n\"TableIDs\": The unique identifier of the Random Result Table to use.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\",\n \"TableIDs\": [\n \"CommonElementCard\",\n \"UncommonElementCard\",\n \"RareElementCard\"\n ]\n}" }, { "id": "server-GetServerCustomIDsFromPlayFabIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetServerCustomIDsFromPlayFabIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetServerCustomIDsFromPlayFabIDs", "description": "Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/getservercustomidsfromplayfabids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabIDs\": Array of unique PlayFab player identifiers for which the title needs to get server custom identifiers. Cannot contain more than 25 identifiers.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabIDs\": [\n \"1232421311\"\n ]\n}" }, { "id": "server-GetSharedGroupData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetSharedGroupData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetSharedGroupData", "description": "Retrieves data stored in a shared group object, as well as the list of members in the group. The server can access all public and private group data. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/getsharedgroupdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"GetMembers\": If true, return the list of all members of the shared group.\n\n\"Keys\": Specific keys to retrieve from the shared group (if not specified, all keys will be returned, while an empty array indicates that no keys should be returned).\n\n\"SharedGroupId\": Unique identifier for the shared group.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"SharedGroupId\": \"Clan Data\",\n \"Keys\": [\n \"ClanKills\",\n \"LastClanUpdate\"\n ],\n \"GetMembers\": true\n}" }, { "id": "server-GetStoreItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetStoreItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetStoreItems", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the set of items defined for the specified store, including all prices defined, for the specified player\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/getstoreitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version to store items from. Use default catalog version if null\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Optional identifier for the player to use in requesting the store information - if used, segment overrides will be applied\n\n\"StoreId\": Unqiue identifier for the store which is being requested\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"StoreId\": \"BonusStore\",\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-GetTime", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetTime?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTime", "description": "Retrieves the current server time\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettime\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{}" }, { "id": "server-GetTitleData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetTitleData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTitleData", "description": "Retrieves the key-value store of custom title settings\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitledata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Keys\": Specific keys to search for in the title data (leave null to get all keys)\n\n\"OverrideLabel\": Optional field that specifies the name of an override. This value is ignored when used by the game client; otherwise, the overrides are applied automatically to the title data.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"Keys\": [\n \"color\",\n \"propertyA\"\n ]\n}" }, { "id": "server-GetTitleInternalData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetTitleInternalData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTitleInternalData", "description": "Retrieves the key-value store of custom internal title settings\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitleinternaldata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Keys\": Specific keys to search for in the title data (leave null to get all keys)\n\n\"OverrideLabel\": Optional field that specifies the name of an override. This value is ignored when used by the game client; otherwise, the overrides are applied automatically to the title data.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"Keys\": [\n \"color\",\n \"propertyA\"\n ]\n}" }, { "id": "server-GetTitleNews", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetTitleNews?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTitleNews", "description": "Retrieves the title news feed, as configured in the developer portal\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/gettitlenews\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Count\": Limits the results to the last n entries. Defaults to 10 if not set.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"Count\": 25\n}" }, { "id": "server-GetUserAccountInfo", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetUserAccountInfo?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserAccountInfo", "description": "Retrieves the relevant details for a specified user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/getuseraccountinfo\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-GetUserBans", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetUserBans?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserBans", "description": "Gets all bans for a user.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/getuserbans\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-GetUserData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetUserData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserData", "description": "Retrieves the title-specific custom data for the user which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}" }, { "id": "server-GetUserInternalData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetUserInternalData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserInternalData", "description": "Retrieves the title-specific custom data for the user which cannot be accessed by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserinternaldata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}" }, { "id": "server-GetUserInventory", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetUserInventory?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserInventory", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Retrieves the specified user's current inventory of virtual goods\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getuserinventory\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-GetUserPublisherData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetUserPublisherData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserPublisherData", "description": "Retrieves the publisher-specific custom data for the user which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}" }, { "id": "server-GetUserPublisherInternalData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetUserPublisherInternalData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserPublisherInternalData", "description": "Retrieves the publisher-specific custom data for the user which cannot be accessed by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherinternaldata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}" }, { "id": "server-GetUserPublisherReadOnlyData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetUserPublisherReadOnlyData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserPublisherReadOnlyData", "description": "Retrieves the publisher-specific custom data for the user which can only be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserpublisherreadonlydata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}" }, { "id": "server-GetUserReadOnlyData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GetUserReadOnlyData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetUserReadOnlyData", "description": "Retrieves the title-specific custom data for the user which can only be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getuserreadonlydata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"IfChangedFromDataVersion\": The version that currently exists according to the caller. The call will return the data for all of the keys if the version in the system is greater than this.\n\n\"Keys\": Specific keys to search for in the custom user data.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Keys\": [\n \"preferences\",\n \"progress\"\n ],\n \"IfChangedFromDataVersion\": 13\n}" }, { "id": "server-GrantCharacterToUser", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GrantCharacterToUser?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GrantCharacterToUser", "description": "Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/characters/grantcharactertouser\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterName\": Non-unique display name of the character being granted (1-40 characters in length).\n\n\"CharacterType\": Type of the character being granted; statistics can be sliced based on this value.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterName\": \"FighterDude\",\n \"CharacterType\": \"Blue Warrior\"\n}" }, { "id": "server-GrantItemsToCharacter", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GrantItemsToCharacter?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GrantItemsToCharacter", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the specified items to the specified character's inventory\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstocharacter\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Annotation\": String detailing any additional information concerning this operation.\n\n\"CatalogVersion\": Catalog version from which items are to be granted.\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ItemIds\": Array of itemIds to grant to the user.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"CharacterId\": \"{{CharacterId}}\",\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Annotation\": \"Entered Level 2\",\n \"ItemIds\": [\n \"shield_level_5\",\n \"shield_level_6\"\n ]\n}" }, { "id": "server-GrantItemsToUser", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GrantItemsToUser?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GrantItemsToUser", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the specified items to the specified user's inventory\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstouser\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Annotation\": String detailing any additional information concerning this operation.\n\n\"CatalogVersion\": Catalog version from which items are to be granted.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ItemIds\": Array of itemIds to grant to the user.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Annotation\": \"Entered Level 2\",\n \"ItemIds\": [\n \"shield_level_3\",\n \"shield_level_4\"\n ]\n}" }, { "id": "server-GrantItemsToUsers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/GrantItemsToUsers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GrantItemsToUsers", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Adds the specified items to the specified user inventories\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstousers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version from which items are to be granted.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ItemGrants\": Array of items to grant and the users to whom the items are to be granted.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\",\n \"ItemGrants\": [\n {\n \"PlayFabId\": \"20394883\",\n \"ItemId\": \"shield_level_1\",\n \"Annotation\": \"Entered Level 2\"\n },\n {\n \"PlayFabId\": \"20394883\",\n \"ItemId\": \"shield_level_2\",\n \"Annotation\": \"Entered Level 2\",\n \"Data\": {\n \"Equipped\": \"True\",\n \"Slot\": \"Head\"\n }\n }\n ]\n}" }, { "id": "server-LinkNintendoServiceAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/LinkNintendoServiceAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkNintendoServiceAccount", "description": "Links the Nintendo account associated with the token to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to a specific Nintendo Switch account, unlink the other user and re-link.\n\n\"IdentityToken\": The JSON Web token (JWT) returned by Nintendo after login. Used to validate the request and find the user ID (Nintendo Switch subject) to link with.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"IdentityToken\": \"eyJraWQi...\"\n}" }, { "id": "server-LinkNintendoServiceAccountSubject", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/LinkNintendoServiceAccountSubject?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkNintendoServiceAccountSubject", "description": "Links the Nintendo account associated with the Nintendo Service Account subject or id to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccountsubject\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to a specific Nintendo Service Account, unlink the other user and re-link.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"Subject\": The Nintendo Service Account subject or id to link to the PlayFab user.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Subject\": \"8e7Eju4j9\"\n}" }, { "id": "server-LinkNintendoSwitchDeviceId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/LinkNintendoSwitchDeviceId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkNintendoSwitchDeviceId", "description": "Links the NintendoSwitchDeviceId to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoswitchdeviceid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the Nintendo Switch Device ID, unlink the other user and re-link.\n\n\"NintendoSwitchDeviceId\": Nintendo Switch unique identifier for the user's device.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"NintendoSwitchDeviceId\": \"526f79204261747479\"\n}" }, { "id": "server-LinkPSNAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/LinkPSNAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkPSNAccount", "description": "Links the PlayStation :tm: Network account associated with the provided access code to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AuthCode\": Authentication code provided by the PlayStation :tm: Network.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the account, unlink the other user and re-link.\n\n\"IssuerId\": Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"RedirectUri\": Redirect URI supplied to PlayStation :tm: Network when requesting an auth code\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"AuthCode\": \"LKJDG7DDE\",\n \"RedirectUri\": \"orbis://games\"\n}" }, { "id": "server-LinkPSNId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/LinkPSNId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkPSNId", "description": "Links the PlayStation :tm: Network account associated with the provided user id to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/linkpsnid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the account, unlink the other user and re-link.\n\n\"IssuerId\": Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"PSNUserId\": Id of the PlayStation :tm: Network user.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"PSNUserId\": \"LKJDG7DDE\"\n}" }, { "id": "server-LinkServerCustomId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/LinkServerCustomId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkServerCustomId", "description": "Links the custom server identifier, generated by the title, to the user's PlayFab account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/linkservercustomid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the custom ID, unlink the other user and re-link.\n\n\"PlayFabId\": Unique PlayFab identifier.\n\n\"ServerCustomId\": Unique server custom identifier for this player.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"ServerCustomId\": \"67AB-5397-CC54-EA31\"\n}" }, { "id": "server-LinkSteamId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/LinkSteamId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkSteamId", "description": "Links the Steam account associated with the provided Steam ID to the user's PlayFab account \n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/linksteamid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the account, unlink the other user and re-link.\n\n\"PlayFabId\": Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier.\n\n\"SteamId\": Unique Steam identifier for a user.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"SteamId\": \"22223333\",\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-LinkXboxAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/LinkXboxAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LinkXboxAccount", "description": "Links the Xbox Live account associated with the provided access code to the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/linkxboxaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceLink\": If another user is already linked to the account, unlink the other user and re-link.\n\n\"PlayFabId\": Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier.\n\n\"XboxToken\": Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(\"POST\", \"https://playfabapi.com/\", \"\").\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"XboxToken\": \"XBL3.0 x=1981989841;akljdlkafdknad\",\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-LoginWithServerCustomId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/LoginWithServerCustomId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithServerCustomId", "description": "Securely login a game client from an external server backend using a custom identifier for that player. Server Custom ID and Client Custom ID are mutually exclusive and cannot be used to retrieve the same player account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithservercustomid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"ServerCustomId\": The backend server identifier for this player.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"ServerCustomId\": \"asdalsdkjar09u23ijf\",\n \"CreateAccount\": true\n}" }, { "id": "server-LoginWithSteamId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/LoginWithSteamId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithSteamId", "description": "Signs the user in using an Steam ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithsteamid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"SteamId\": Unique Steam identifier for a user.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"SteamId\": \"12344553\",\n \"CreateAccount\": false\n}" }, { "id": "server-LoginWithXbox", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/LoginWithXbox?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithXbox", "description": "Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxbox\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"XboxToken\": Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync(\"POST\", \"https://playfabapi.com/\", \"\").\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"XboxToken\": \"XBL3.0 x=1981989841;akljdlkafdknad\",\n \"CreateAccount\": false\n}" }, { "id": "server-LoginWithXboxId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/LoginWithXboxId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LoginWithXboxId", "description": "Signs the user in using an Xbox ID and Sandbox ID, returning a session identifier that can subsequently be used for API calls which require an authenticated user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithxboxid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CreateAccount\": Automatically create a PlayFab account if one is not currently linked to this ID.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"InfoRequestParameters\": Flags for which pieces of info to return for the user.\n\n\"Sandbox\": The id of Xbox Live sandbox.\n\n\"XboxId\": Unique Xbox identifier for a user.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"XboxId\": \"12344553\",\n \"Sandbox\": \"RETAIL\",\n \"CreateAccount\": false\n}" }, { "id": "server-ModifyItemUses", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/ModifyItemUses?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ModifyItemUses", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Modifies the number of remaining uses of a player's inventory item\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/modifyitemuses\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ItemInstanceId\": Unique instance identifier of the item to be modified.\n\n\"PlayFabId\": PlayFab unique identifier of the user whose item is being modified.\n\n\"UsesToAdd\": Number of uses to add to the item. Can be negative to remove uses.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"ItemInstanceId\": \"94585729\",\n \"UsesToAdd\": 1\n}" }, { "id": "server-MoveItemToCharacterFromCharacter", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/MoveItemToCharacterFromCharacter?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "MoveItemToCharacterFromCharacter", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Moves an item from a character's inventory into another of the users's character's inventory.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromcharacter\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"GivingCharacterId\": Unique identifier of the character that currently has the item.\n\n\"ItemInstanceId\": Unique PlayFab assigned instance identifier of the item\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"ReceivingCharacterId\": Unique identifier of the character that will be receiving the item.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"GivingCharacterId\": \"98092347523\",\n \"ReceivingCharacterId\": \"6323489712\",\n \"ItemInstanceId\": \"701231299999\"\n}" }, { "id": "server-MoveItemToCharacterFromUser", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/MoveItemToCharacterFromUser?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "MoveItemToCharacterFromUser", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Moves an item from a user's inventory into their character's inventory.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtocharacterfromuser\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"ItemInstanceId\": Unique PlayFab assigned instance identifier of the item\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"ItemInstanceId\": \"701231299999\"\n}" }, { "id": "server-MoveItemToUserFromCharacter", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/MoveItemToUserFromCharacter?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "MoveItemToUserFromCharacter", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Moves an item from a character's inventory into the owning user's inventory.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/moveitemtouserfromcharacter\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"ItemInstanceId\": Unique PlayFab assigned instance identifier of the item\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"ItemInstanceId\": \"701231299999\"\n}" }, { "id": "server-RedeemCoupon", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/RedeemCoupon?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RedeemCoupon", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ 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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/redeemcoupon\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Catalog version of the coupon.\n\n\"CharacterId\": Optional identifier for the Character that should receive the item. If null, item is added to the player\n\n\"CouponCode\": Generated coupon code to redeem.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"CouponCode\": \"123-1234-123\",\n \"CatalogVersion\": \"{{PrimaryCatalogName}}\"\n}" }, { "id": "server-RemoveFriend", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/RemoveFriend?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemoveFriend", "description": "Removes the specified friend from the the user's friend list\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/removefriend\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"FriendPlayFabId\": PlayFab identifier of the friend account which is to be removed.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"FriendPlayFabId\": \"29837799\",\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-RemoveGenericID", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/RemoveGenericID?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemoveGenericID", "description": "Removes the specified generic service identifier from the player's PlayFab account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/removegenericid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"GenericId\": Generic service identifier to be removed from the player.\n\n\"PlayFabId\": PlayFabId of the user to remove.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"GenericId\": {\n \"ServiceName\": \"BigBizSocial\",\n \"UserId\": \"1234567890\"\n }\n}" }, { "id": "server-RemovePlayerTag", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/RemovePlayerTag?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemovePlayerTag", "description": "Remove a given tag from a player profile. The tag's namespace is automatically generated based on the source of the tag.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/playstream/removeplayertag\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"TagName\": Unique tag for player profile.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"TagName\": \"MostKilled\"\n}" }, { "id": "server-RemoveSharedGroupMembers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/RemoveSharedGroupMembers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemoveSharedGroupMembers", "description": "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, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/removesharedgroupmembers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabIds\": An array of unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"SharedGroupId\": Unique identifier for the shared group.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"SharedGroupId\": \"Clan Data\",\n \"PlayFabIds\": [\n \"D984A64B832\",\n \"F74A523E1562\"\n ]\n}" }, { "id": "server-ReportPlayer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/ReportPlayer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ReportPlayer", "description": "Submit a report about a player (due to bad bahavior, etc.) on behalf of another player, so that customer service representatives for the title can take action concerning potentially toxic players.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/reportplayer\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Comment\": Optional additional comment by reporting player.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ReporteeId\": Unique PlayFab identifier of the reported player.\n\n\"ReporterId\": PlayFabId of the reporting player.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"ReporterId\": \"9ddafe27d6d445da\",\n \"ReporteeId\": \"1a46086aed40f142\",\n \"Comment\": \"cheating\"\n}" }, { "id": "server-RevokeAllBansForUser", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/RevokeAllBansForUser?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RevokeAllBansForUser", "description": "Revoke all active bans for a user.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/revokeallbansforuser\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-RevokeBans", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/RevokeBans?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RevokeBans", "description": "Revoke all active bans specified with BanId.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/revokebans\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BanIds\": Ids of the bans to be revoked. Maximum 100.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"BanIds\": [\n \"E0B5FF89542D413C\",\n \"EF43FF89542G1546\"\n ]\n}" }, { "id": "server-RevokeInventoryItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/RevokeInventoryItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RevokeInventoryItem", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access to an item in a user's inventory\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"ItemInstanceId\": Unique PlayFab assigned instance identifier of the item\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"ItemInstanceId\": \"2048583045\"\n}" }, { "id": "server-RevokeInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/RevokeInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RevokeInventoryItems", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Revokes access for up to 25 items across multiple users and characters.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/revokeinventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Items\": Array of player items to revoke, between 1 and 25 items.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"Items\": [\n {\n \"PlayFabId\": \"203945882\",\n \"ItemInstanceId\": \"2048583045\"\n }\n ]\n}" }, { "id": "server-SavePushNotificationTemplate", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/SavePushNotificationTemplate?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SavePushNotificationTemplate", "description": "Saves push notification template for title\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/savepushnotificationtemplate\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AndroidPayload\": Android JSON for the notification template.\n\n\"Id\": Id of the push notification template.\n\n\"IOSPayload\": IOS JSON for the notification template.\n\n\"LocalizedPushNotificationTemplates\": Dictionary of localized push notification templates with the language as the key.\n\n\"Name\": Name of the push notification template.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"AndroidPayload\": \"String\",\n \"Id\": \"String\",\n \"IOSPayload\": \"String\",\n \"LocalizedPushNotificationTemplates\": \"Object\",\n \"Name\": \"String\"\n}" }, { "id": "server-SendCustomAccountRecoveryEmail", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/SendCustomAccountRecoveryEmail?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SendCustomAccountRecoveryEmail", "description": "Forces an email to be sent to the registered contact email address for the user's account based on an account recovery email template\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/sendcustomaccountrecoveryemail\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Email\": User email address attached to their account\n\n\"EmailTemplateId\": The email template id of the account recovery email template to send.\n\n\"Username\": The user's username requesting an account recovery.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"EmailTemplateId\": \"D53AB15D8F12E330\",\n \"Email\": \"Me@here.com\"\n}" }, { "id": "server-SendEmailFromTemplate", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/SendEmailFromTemplate?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SendEmailFromTemplate", "description": "Sends an email based on an email template to a player's contact email \n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/sendemailfromtemplate\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EmailTemplateId\": The email template id of the email template to send.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"EmailTemplateId\": \"B53CA15D92D2E331\",\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-SendPushNotification", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/SendPushNotification?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SendPushNotification", "description": "Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotification\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AdvancedPlatformDelivery\": Allows you to provide precisely formatted json to target devices. This is an advanced feature, allowing you to deliver to custom plugin logic, fields, or functionality not natively supported by PlayFab.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Message\": Text of message to send.\n\n\"Package\": Defines all possible push attributes like message, title, icon, etc. Some parameters are device specific - please see the PushNotificationPackage documentation for details.\n\n\"Recipient\": PlayFabId of the recipient of the push notification.\n\n\"Subject\": Subject of message to send (may not be displayed in all platforms)\n\n\"TargetPlatforms\": Target Platforms that should receive the Message or Package. If omitted, we will send to all available platforms.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"Recipient\": \"F8763A987E\",\n \"Message\": \"You have been attacked! Go defend your base!\"\n}" }, { "id": "server-SendPushNotificationFromTemplate", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/SendPushNotificationFromTemplate?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SendPushNotificationFromTemplate", "description": "Sends an iOS/Android Push Notification template to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/sendpushnotificationfromtemplate\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PushNotificationTemplateId\": Id of the push notification template.\n\n\"Recipient\": PlayFabId of the push notification recipient.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"Recipient\": \"F8763A987E\",\n \"PushNotificationTemplateId\": \"6bc7dbf0-075a-46e9-8e84-35737a22c6a4\"\n}" }, { "id": "server-SetFriendTags", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/SetFriendTags?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetFriendTags", "description": "Updates the tag list for a specified user in the friend list of another user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/friend-list-management/setfriendtags\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"FriendPlayFabId\": PlayFab identifier of the friend account to which the tag(s) should be applied.\n\n\"PlayFabId\": PlayFab identifier of the player whose friend is to be updated.\n\n\"Tags\": Array of tags to set on the friend account.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"FriendPlayFabId\": \"298ABC37799\",\n \"Tags\": [\n \"sniper\",\n \"melee\"\n ]\n}" }, { "id": "server-SetPlayerSecret", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/SetPlayerSecret?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetPlayerSecret", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/authentication/setplayersecret\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"PlayerSecret\": Player secret that is used to verify API request signatures (Enterprise Only).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayerSecret\": \"ExampleSecret\",\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-SetPublisherData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/SetPublisherData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetPublisherData", "description": "Updates the key-value store of custom publisher settings\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/setpublisherdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Key\": key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.\n\n\"Value\": new value to set. Set to null to remove a value\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"Key\": \"Running Speed\",\n \"Value\": \"1.03\"\n}" }, { "id": "server-SetTitleData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/SetTitleData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetTitleData", "description": "Updates the key-value store of custom title settings\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitledata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Key\": key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.\n\n\"Value\": new value to set. Set to null to remove a value\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"Key\": \"Running Speed\",\n \"Value\": \"1.03\"\n}" }, { "id": "server-SetTitleInternalData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/SetTitleInternalData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetTitleInternalData", "description": "Updates the key-value store of custom title settings\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/title-wide-data-management/settitleinternaldata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Key\": key we want to set a value on (note, this is additive - will only replace an existing key's value if they are the same name.) Keys are trimmed of whitespace. Keys may not begin with the '!' character.\n\n\"Value\": new value to set. Set to null to remove a value\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"Key\": \"Running Speed\",\n \"Value\": \"1.03\"\n}" }, { "id": "server-SubtractCharacterVirtualCurrency", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/SubtractCharacterVirtualCurrency?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SubtractCharacterVirtualCurrency", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ 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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractcharactervirtualcurrency\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Amount\": Amount to be subtracted from the user balance of the specified virtual currency.\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"VirtualCurrency\": Name of the virtual currency which is to be decremented.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"VirtualCurrency\": \"GC\",\n \"Amount\": 100\n}" }, { "id": "server-SubtractUserVirtualCurrency", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/SubtractUserVirtualCurrency?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SubtractUserVirtualCurrency", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ 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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractuservirtualcurrency\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Amount\": Amount to be subtracted from the user balance of the specified virtual currency.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": PlayFab unique identifier of the user whose virtual currency balance is to be decreased.\n\n\"VirtualCurrency\": Name of the virtual currency which is to be decremented.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"VirtualCurrency\": \"GC\",\n \"Amount\": 100\n}" }, { "id": "server-UnlinkNintendoServiceAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UnlinkNintendoServiceAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkNintendoServiceAccount", "description": "Unlinks the related Nintendo account from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoserviceaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-UnlinkNintendoSwitchDeviceId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UnlinkNintendoSwitchDeviceId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkNintendoSwitchDeviceId", "description": "Unlinks the related NintendoSwitchDeviceId from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoswitchdeviceid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"NintendoSwitchDeviceId\": Nintendo Switch Device identifier for the user. If not specified, the most recently signed in device ID will be used.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"NintendoSwitchDeviceId\": \"526f79204261747479\"\n}" }, { "id": "server-UnlinkPSNAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UnlinkPSNAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkPSNAccount", "description": "Unlinks the related PlayStation :tm: Network account from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkpsnaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-UnlinkServerCustomId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UnlinkServerCustomId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkServerCustomId", "description": "Unlinks the custom server identifier from the user's PlayFab account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkservercustomid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab identifier.\n\n\"ServerCustomId\": Unique server custom identifier for this player.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"ServerCustomId\": \"67AB-5397-CC54-EA31\"\n}" }, { "id": "server-UnlinkSteamId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UnlinkSteamId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkSteamId", "description": "Unlinks the Steam account associated with the provided Steam ID to the user's PlayFab account \n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinksteamid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam account.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-UnlinkXboxAccount", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UnlinkXboxAccount?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlinkXboxAccount", "description": "Unlinks the related Xbox Live account from the user's PlayFab account\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkxboxaccount\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\"\n}" }, { "id": "server-UnlockContainerInstance", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UnlockContainerInstance?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlockContainerInstance", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ 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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/unlockcontainerinstance\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Specifies the catalog version that should be used to determine container contents. If unspecified, uses catalog associated with the item instance.\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"ContainerItemInstanceId\": ItemInstanceId of the container to unlock.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"KeyItemInstanceId\": ItemInstanceId of the key that will be consumed by unlocking this container. If the container requires a key, this parameter is required.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"ContainerItemInstanceId\": \"123456788\",\n \"KeyItemInstanceId\": \"123456789\"\n}" }, { "id": "server-UnlockContainerItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UnlockContainerItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnlockContainerItem", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ 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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/unlockcontaineritem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CatalogVersion\": Specifies the catalog version that should be used to determine container contents. If unspecified, uses default/primary catalog.\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"ContainerItemId\": Catalog ItemId of the container type to unlock.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"ContainerItemId\": \"crate block 1\"\n}" }, { "id": "server-UpdateAvatarUrl", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdateAvatarUrl?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateAvatarUrl", "description": "Update the avatar URL of the specified player\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/updateavatarurl\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ImageUrl\": URL of the avatar image. If empty, it removes the existing avatar URL.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"ImageUrl\": \"https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50\"\n}" }, { "id": "server-UpdateBans", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdateBans?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateBans", "description": "Updates information of a list of existing bans specified with Ban Ids.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/account-management/updatebans\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Bans\": List of bans to be updated. Maximum 100.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"Bans\": [\n {\n \"BanId\": \"E0B5FF89542D413C\",\n \"Permanent\": true,\n \"Active\": true\n },\n {\n \"BanId\": \"EF43FF89542G1546\",\n \"Reason\": \"Royal pardon\",\n \"Expires\": \"2016-07-04T00:00:00Z\"\n }\n ]\n}" }, { "id": "server-UpdateCharacterData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdateCharacterData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateCharacterData", "description": "Updates the title-specific custom data for the user's character which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys written in this request. Defaults to \"private\" if not set.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "server-UpdateCharacterInternalData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdateCharacterInternalData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateCharacterInternalData", "description": "Updates the title-specific custom data for the user's character which cannot be accessed by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterinternaldata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys written in this request. Defaults to \"private\" if not set.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "server-UpdateCharacterReadOnlyData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdateCharacterReadOnlyData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateCharacterReadOnlyData", "description": "Updates the title-specific custom data for the user's character which can only be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/character-data/updatecharacterreadonlydata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys written in this request. Defaults to \"private\" if not set.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "server-UpdateCharacterStatistics", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdateCharacterStatistics?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateCharacterStatistics", "description": "Updates the values of the specified title-specific statistics for the specific character\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/characters/updatecharacterstatistics\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CharacterStatistics\": Statistics to be updated with the provided values.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"CharacterStatistics\": {\n \"Headshots\": 18,\n \"Kills\": 47\n }\n}" }, { "id": "server-UpdatePlayerStatistics", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdatePlayerStatistics?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdatePlayerStatistics", "description": "Updates the values of the specified title-specific statistics for the user\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayerstatistics\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceUpdate\": Indicates whether the statistics provided should be set, regardless of the aggregation method set on the statistic. Default is false.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"Statistics\": Statistics to be updated with the provided values\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Statistics\": [\n {\n \"StatisticName\": \"Points\",\n \"Version\": 1,\n \"Value\": 600\n },\n {\n \"StatisticName\": \"Wins\",\n \"Version\": 2,\n \"Value\": 16\n },\n {\n \"StatisticName\": \"Stars\",\n \"Value\": 7\n }\n ]\n}" }, { "id": "server-UpdateSharedGroupData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdateSharedGroupData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateSharedGroupData", "description": "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 (and the server) can update the data. Shared Groups are designed for sharing data between a very small number of players, please see our guide: https://docs.microsoft.com/gaming/playfab/features/social/groups/using-shared-group-data\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/shared-group-data/updatesharedgroupdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys in this request.\n\n\"SharedGroupId\": Unique identifier for the shared group.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"SharedGroupId\": \"Clan Data\",\n \"Data\": {\n \"ClanKills\": \"34\",\n \"LastClanUpdate\": \"2014-10-03T09:21:14Z\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "server-UpdateUserData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdateUserData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserData", "description": "Updates the title-specific custom data for the user which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys written in this request. Defaults to \"private\" if not set.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "server-UpdateUserInternalData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdateUserInternalData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserInternalData", "description": "Updates the title-specific custom data for the user which cannot be accessed by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserinternaldata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n }\n}" }, { "id": "server-UpdateUserInventoryItemCustomData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdateUserInventoryItemCustomData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserInventoryItemCustomData", "description": "_NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2._ Updates the key-value pair data tagged to the specified item, which is read-only from the client.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-item-management/updateuserinventoryitemcustomdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"ItemInstanceId\": Unique PlayFab assigned instance identifier of the item\n\n\"KeysToRemove\": 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.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"ItemInstanceId\": \"88331144\",\n \"Data\": {\n \"Equipped\": \"True\",\n \"Slot\": \"Head\"\n }\n}" }, { "id": "server-UpdateUserPublisherData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdateUserPublisherData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserPublisherData", "description": "Updates the publisher-specific custom data for the user which is readable and writable by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherdata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys written in this request. Defaults to \"private\" if not set.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "server-UpdateUserPublisherInternalData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdateUserPublisherInternalData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserPublisherInternalData", "description": "Updates the publisher-specific custom data for the user which cannot be accessed by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherinternaldata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n }\n}" }, { "id": "server-UpdateUserPublisherReadOnlyData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdateUserPublisherReadOnlyData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserPublisherReadOnlyData", "description": "Updates the publisher-specific custom data for the user which can only be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserpublisherreadonlydata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys written in this request. Defaults to \"private\" if not set.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "server-UpdateUserReadOnlyData", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/UpdateUserReadOnlyData?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateUserReadOnlyData", "description": "Updates the title-specific custom data for the user which can only be read by the client\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateuserreadonlydata\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Data\": 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.\n\n\"KeysToRemove\": 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.\n\n\"Permission\": Permission to be applied to all user data keys written in this request. Defaults to \"private\" if not set.\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"Data\": {\n \"Class\": \"Fighter\",\n \"Gender\": \"Female\",\n \"Icon\": \"Guard 3\",\n \"Theme\": \"Colorful\"\n },\n \"Permission\": \"Public\"\n}" }, { "id": "server-WriteCharacterEvent", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/WriteCharacterEvent?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "WriteCharacterEvent", "description": "Writes a character-based event into PlayStream.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/analytics/writecharacterevent\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Body\": Custom event properties. Each property consists of a name (string) and a value (JSON object).\n\n\"CharacterId\": Unique PlayFab assigned ID for a specific character owned by a user\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EventName\": The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it commonly follows the subject_verb_object pattern (e.g. player_logged_in).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"Timestamp\": The time (in UTC) associated with this event. The value defaults to the current time.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"CharacterId\": \"{{CharacterId}}\",\n \"EventName\": \"character_defeated_enemy\",\n \"Timestamp\": \"2016-03-07T00:00:00Z\",\n \"Body\": {\n \"Enemy\": \"guardian\",\n \"Damage\": 5,\n \"Coordinates\": {\n \"X\": 123.4,\n \"Y\": 543.2\n }\n }\n}" }, { "id": "server-WritePlayerEvent", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/WritePlayerEvent?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "WritePlayerEvent", "description": "Writes a player-based event into PlayStream.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/analytics/writeplayerevent\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Body\": Custom data properties associated with the event. Each property consists of a name (string) and a value (JSON object).\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EventName\": The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it commonly follows the subject_verb_object pattern (e.g. player_logged_in).\n\n\"PlayFabId\": Unique PlayFab assigned ID of the user on whom the operation will be performed.\n\n\"Timestamp\": The time (in UTC) associated with this event. The value defaults to the current time.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"PlayFabId\": \"{{PlayFabId}}\",\n \"EventName\": \"player_defeated_enemy\",\n \"Timestamp\": \"2016-03-07T00:00:00Z\",\n \"Body\": {\n \"Enemy\": \"guardian\",\n \"Damage\": 5,\n \"Coordinates\": {\n \"X\": 123.4,\n \"Y\": 543.2\n }\n }\n}" }, { "id": "server-WriteTitleEvent", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Server/WriteTitleEvent?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "WriteTitleEvent", "description": "Writes a title-based event into PlayStream.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/server/analytics/writetitleevent\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"SecretKey\" - The PlayFab API Secret Key, available in Game Manager for your title (https://developer.playfab.com/{{titleId}}/settings/credentials)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Body\": Custom event properties. Each property consists of a name (string) and a value (JSON object).\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EventName\": The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it commonly follows the subject_verb_object pattern (e.g. player_logged_in).\n\n\"Timestamp\": The time (in UTC) associated with this event. The value defaults to the current time.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-serverFolder", "rawModeData": "{\n \"EventName\": \"client_update_submitted\",\n \"Timestamp\": \"2016-03-07T00:00:00Z\",\n \"Body\": {\n \"Version\": \"1.4.50\"\n }\n}" }, { "id": "authentication-AuthenticateGameServerWithCustomId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/GameServerIdentity/AuthenticateGameServerWithCustomId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AuthenticateGameServerWithCustomId", "description": "Create a game_server entity token and return a new or existing game_server entity.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/authentication/authentication/authenticategameserverwithcustomid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomId\": The customId used to create and retrieve game_server entity tokens. This is unique at the title level. CustomId must be between 32 and 100 characters.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-authenticationFolder", "rawModeData": "{\n \"CustomId\": \"12345678123412341234123456789abc\"\n}" }, { "id": "authentication-Delete", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/GameServerIdentity/Delete?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "Delete", "description": "Delete a game_server entity.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/authentication/authentication/delete\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The game_server entity to be removed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-authenticationFolder", "rawModeData": "{\n \"Entity\": {\n \"Id\": \"3D00C64954\",\n \"Type\": \"game_server\",\n \"TypeString\": \"game_server\"\n }\n}" }, { "id": "authentication-GetEntityToken", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-Authorization: {{SessionTicket}}\nX-SecretKey: {{SecretKey}}\n", "url": "https://{{TitleId}}.playfabapi.com/Authentication/GetEntityToken?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetEntityToken", "description": "Method to exchange a legacy AuthenticationTicket or title SecretKey for an Entity Token or to refresh a still valid Entity Token.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/authentication/authentication/getentitytoken\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-authenticationFolder", "rawModeData": "{}" }, { "id": "authentication-ValidateEntityToken", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Authentication/ValidateEntityToken?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ValidateEntityToken", "description": "Method for a server to validate a client provided EntityToken. Only callable by the title entity.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/authentication/authentication/validateentitytoken\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EntityToken\": Client EntityToken\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-authenticationFolder", "rawModeData": "{\n \"EntityToken\": \"50c61b9065b27a124a400ee3b95d404313986969\"\n}" }, { "id": "cloudscript-ExecuteEntityCloudScript", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/CloudScript/ExecuteEntityCloudScript?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ExecuteEntityCloudScript", "description": "Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executeentitycloudscript\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\n\"FunctionName\": The name of the CloudScript function to execute\n\n\"FunctionParameter\": Object that is passed in to the function as the first argument\n\n\"GeneratePlayStreamEvent\": Generate a 'entity_executed_cloudscript' PlayStream event containing the results of the function execution and other contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.\n\n\"RevisionSelection\": Option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live' executes the current live, published revision, and 'Specific' executes the specified revision. The default value is 'Specific', if the SpecificRevision parameter is specified, otherwise it is 'Live'.\n\n\"SpecificRevision\": The specific revision to execute, when RevisionSelection is set to 'Specific'\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-cloudscriptFolder", "rawModeData": "{\n \"FunctionName\": \"levelCompleted\",\n \"FunctionParameter\": {\n \"level\": 3,\n \"points\": 400\n },\n \"RevisionSelection\": \"Live\",\n \"GeneratePlayStreamEvent\": true,\n \"Entity\": {\n \"Id\": \"aaa\",\n \"Type\": \"master_player_account\",\n \"TypeString\": \"master_player_account\"\n }\n}" }, { "id": "cloudscript-ExecuteFunction", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/CloudScript/ExecuteFunction?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ExecuteFunction", "description": "Cloud Script is one of PlayFab's most versatile features. It allows client code to request execution of any kind of custom server-side functionality you can implement, and it can be used in conjunction with virtually anything.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/executefunction\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\n\"FunctionName\": The name of the CloudScript function to execute\n\n\"FunctionParameter\": Object that is passed in to the function as the FunctionArgument field of the FunctionExecutionContext data structure\n\n\"GeneratePlayStreamEvent\": Generate a 'entity_executed_cloudscript_function' PlayStream event containing the results of the function execution and other contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-cloudscriptFolder", "rawModeData": "{\n \"FunctionName\": \"LevelCompleted\",\n \"FunctionParameter\": {\n \"level\": 3,\n \"points\": 400\n },\n \"GeneratePlayStreamEvent\": true,\n \"Entity\": {\n \"Id\": \"aaa\",\n \"Type\": \"master_player_account\",\n \"TypeString\": \"master_player_account\"\n }\n}" }, { "id": "cloudscript-GetFunction", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/CloudScript/GetFunction?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetFunction", "description": "Gets registered Azure Functions for a given title id and function name.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/getfunction\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"FunctionName\": The name of the function to register\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-cloudscriptFolder", "rawModeData": "{}" }, { "id": "cloudscript-ListFunctions", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/CloudScript/ListFunctions?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListFunctions", "description": "Lists all currently registered Azure Functions for a given title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listfunctions\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-cloudscriptFolder", "rawModeData": "{}" }, { "id": "cloudscript-ListHttpFunctions", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/CloudScript/ListHttpFunctions?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListHttpFunctions", "description": "Lists all currently registered HTTP triggered Azure Functions for a given title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listhttpfunctions\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-cloudscriptFolder", "rawModeData": "{}" }, { "id": "cloudscript-ListQueuedFunctions", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/CloudScript/ListQueuedFunctions?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListQueuedFunctions", "description": "Lists all currently registered Queue triggered Azure Functions for a given title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/listqueuedfunctions\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-cloudscriptFolder", "rawModeData": "{}" }, { "id": "cloudscript-PostFunctionResultForEntityTriggeredAction", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/CloudScript/PostFunctionResultForEntityTriggeredAction?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "PostFunctionResultForEntityTriggeredAction", "description": "Generate an entity PlayStream event for the provided function result.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforentitytriggeredaction\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"FunctionResult\": The result of the function execution.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-cloudscriptFolder", "rawModeData": "{\n \"FunctionResult\": {\n \"ExecutionTimeMilliseconds\": 367,\n \"FunctionName\": \"LevelCompleted\",\n \"FunctionResult\": {\n \"newScore\": 25,\n \"isWinner\": false\n }\n }\n}" }, { "id": "cloudscript-PostFunctionResultForFunctionExecution", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/CloudScript/PostFunctionResultForFunctionExecution?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "PostFunctionResultForFunctionExecution", "description": "Generate an entity PlayStream event for the provided function result.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforfunctionexecution\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"FunctionResult\": The result of the function execution.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-cloudscriptFolder", "rawModeData": "{\n \"FunctionResult\": {\n \"ExecutionTimeMilliseconds\": 367,\n \"FunctionName\": \"LevelCompleted\",\n \"FunctionResult\": {\n \"newScore\": 25,\n \"isWinner\": false\n }\n }\n}" }, { "id": "cloudscript-PostFunctionResultForPlayerTriggeredAction", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/CloudScript/PostFunctionResultForPlayerTriggeredAction?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "PostFunctionResultForPlayerTriggeredAction", "description": "Generate a player PlayStream event for the provided function result.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforplayertriggeredaction\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"FunctionResult\": The result of the function execution.\n\n\"PlayerProfile\": The player profile the function was invoked with.\n\n\"PlayStreamEventEnvelope\": The triggering PlayStream event, if any, that caused the function to be invoked.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-cloudscriptFolder", "rawModeData": "{\n \"PlayStreamEventEnvelope\": {\n \"EntityId\": \"1234ABCD\",\n \"EntityType\": \"title_player_account\",\n \"EventName\": \"player_logged_in\",\n \"EventNamespace\": \"com.playfab\",\n \"EventData\": \"someeventdata\",\n \"EventSettings\": \"someeventsettings\",\n \"EventToBeDropped\": false\n },\n \"PlayerProfile\": {\n \"TitleId\": \"FFFF\",\n \"PlayerId\": \"1234ABCD\",\n \"Created\": \"2019-02-11T20:23:05Z\",\n \"LastLogin\": \"2020-02-11T20:23:05Z\",\n \"DisplayName\": \"Gudge\"\n },\n \"FunctionResult\": {\n \"ExecutionTimeMilliseconds\": 367,\n \"FunctionName\": \"LevelCompleted\",\n \"FunctionResult\": {\n \"newScore\": 25,\n \"isWinner\": false\n }\n }\n}" }, { "id": "cloudscript-PostFunctionResultForScheduledTask", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/CloudScript/PostFunctionResultForScheduledTask?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "PostFunctionResultForScheduledTask", "description": "Generate a PlayStream event for the provided function result.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/postfunctionresultforscheduledtask\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"FunctionResult\": The result of the function execution\n\n\"ScheduledTaskId\": The id of the scheduled task that invoked the function.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-cloudscriptFolder", "rawModeData": "{\n \"ScheduledTaskId\": {\n \"Name\": \"MyTask\",\n \"Id\": \"d739e188-22f6-4d13-a4d5-df2e93d4d2f7\"\n },\n \"FunctionResult\": {\n \"ExecutionTimeMilliseconds\": 367,\n \"FunctionName\": \"LevelCompleted\",\n \"FunctionResult\": {\n \"newScore\": 25,\n \"isWinner\": false\n }\n }\n}" }, { "id": "cloudscript-RegisterHttpFunction", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/CloudScript/RegisterHttpFunction?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RegisterHttpFunction", "description": "Registers an HTTP triggered Azure function with a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerhttpfunction\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"FunctionName\": The name of the function to register\n\n\"FunctionUrl\": Full URL for Azure Function that implements the function.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-cloudscriptFolder", "rawModeData": "{\n \"FunctionUrl\": \"http://function.url\",\n \"FunctionName\": \"functionName\"\n}" }, { "id": "cloudscript-RegisterQueuedFunction", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/CloudScript/RegisterQueuedFunction?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RegisterQueuedFunction", "description": "Registers a queue triggered Azure Function with a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/registerqueuedfunction\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ConnectionString\": A connection string for the storage account that hosts the queue for the Azure Function.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"FunctionName\": The name of the function to register\n\n\"QueueName\": The name of the queue for the Azure Function.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-cloudscriptFolder", "rawModeData": "{\n \"QueueName\": \"fn-queue\",\n \"ConnectionString\": \"SampleConnectionString\",\n \"FunctionName\": \"functionName\"\n}" }, { "id": "cloudscript-UnregisterFunction", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/CloudScript/UnregisterFunction?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnregisterFunction", "description": "Unregisters an Azure Function with a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/cloudscript/server-side-cloud-script/unregisterfunction\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"FunctionName\": The name of the function to register\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-cloudscriptFolder", "rawModeData": "{\n \"FunctionName\": \"functionName\"\n}" }, { "id": "data-AbortFileUploads", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/File/AbortFileUploads?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AbortFileUploads", "description": "Abort pending file uploads to an entity's profile.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/data/file/abortfileuploads\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"FileNames\": Names of the files to have their pending uploads aborted.\n\n\"ProfileVersion\": The expected version of the profile, if set and doesn't match the current version of the profile the operation will not be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-dataFolder", "rawModeData": "{\n \"FileNames\": [\n \"avatar\"\n ],\n \"Entity\": {\n \"Id\": \"ID\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "data-DeleteFiles", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/File/DeleteFiles?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteFiles", "description": "Delete files on an entity's profile.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/data/file/deletefiles\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"FileNames\": Names of the files to be deleted.\n\n\"ProfileVersion\": The expected version of the profile, if set and doesn't match the current version of the profile the operation will not be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-dataFolder", "rawModeData": "{\n \"FileNames\": [\n \"game_state\",\n \"avatar\"\n ],\n \"Entity\": {\n \"Id\": \"ID\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "data-FinalizeFileUploads", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/File/FinalizeFileUploads?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "FinalizeFileUploads", "description": "Finalize file uploads to an entity's profile.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/data/file/finalizefileuploads\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"FileNames\": Names of the files to be finalized. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'\n\n\"ProfileVersion\": The current version of the profile, can be used for concurrency control during updates.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-dataFolder", "rawModeData": "{\n \"ProfileVersion\": 0,\n \"FileNames\": [\n \"profile_configuration\",\n \"game_state\"\n ],\n \"Entity\": {\n \"Id\": \"ID\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "data-GetFiles", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/File/GetFiles?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetFiles", "description": "Retrieves file metadata from an entity's profile.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/data/file/getfiles\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-dataFolder", "rawModeData": "{\n \"Entity\": {\n \"Id\": \"ID\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "data-GetObjects", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Object/GetObjects?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetObjects", "description": "Retrieves objects from an entity's profile.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/data/object/getobjects\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"EscapeObject\": Determines whether the object will be returned as an escaped JSON string or as a un-escaped JSON object. Default is JSON object.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-dataFolder", "rawModeData": "{\n \"Entity\": {\n \"Id\": \"ABC90712ABC\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "data-InitiateFileUploads", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/File/InitiateFileUploads?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "InitiateFileUploads", "description": "Initiates file uploads to an entity's profile.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/data/file/initiatefileuploads\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"FileNames\": Names of the files to be set. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'\n\n\"ProfileVersion\": The expected version of the profile, if set and doesn't match the current version of the profile the operation will not be performed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-dataFolder", "rawModeData": "{\n \"FileNames\": [\n \"profile_configuration\",\n \"game_state\"\n ],\n \"Entity\": {\n \"Id\": \"ID\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "data-SetObjects", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Object/SetObjects?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetObjects", "description": "Sets objects on an entity's profile.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/data/object/setobjects\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"ExpectedProfileVersion\": Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from GetProfile API, you can ensure that the object set will only be performed if the profile has not been updated by any other clients since the version you last loaded.\n\n\"Objects\": Collection of objects to set on the profile.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-dataFolder", "rawModeData": "{\n \"ExpectedProfileVersion\": 5,\n \"Objects\": [\n {\n \"ObjectName\": \"SaveSate\",\n \"DataObject\": {\n \"PlayerDetails\": {\n \"LastMissionSuccess\": \"2017-06-15T11:05:19Z\",\n \"LastMissionFailure\": \"2017-06-12T11:05:19Z\",\n \"MapPosition\": [\n 22,\n 37.78\n ],\n \"IsPaidUpgrade\": true\n },\n \"GameSettings\": {\n \"Screen\": \"FriendsList\",\n \"Favorites\": [\n \"Place 1\",\n \"Place 2\"\n ]\n }\n },\n \"SimpleStatements\": {\n \"Read\": [\n {\n \"Friend\": true\n }\n ],\n \"Write\": [\n \"Self\"\n ]\n }\n }\n ],\n \"Entity\": {\n \"Id\": \"A8140AB9109712B\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "economy-AddInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/AddInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddInventoryItems", "description": "Add inventory items. Up to 3500 stacks of items can be added to a single inventory collection. Stack size is uncapped.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/addinventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Amount\": The amount to add for the current item.\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\"). The number of inventory collections is unlimited.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"DurationInSeconds\": The duration to add to the current item expiration date.\n\n\"Entity\": The entity to perform this action on.\n\n\"ETag\": ETags are used for concurrency checking when updating resources. More information about using ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags\n\n\"IdempotencyId\": The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will be garbage collected eventually.\n\n\"Item\": The inventory item the request applies to.\n\n\"NewStackValues\": The values to apply to a stack newly created by this request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Item\": {\n \"Id\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"Amount\": 3,\n \"ReturnInventory\": false\n}" }, { "id": "economy-CreateDraftItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/CreateDraftItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateDraftItem", "description": "Creates a new item in the working catalog using provided metadata.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/createdraftitem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Item\": Metadata describing the new catalog item to be created.\n\n\"Publish\": Whether the item should be published immediately. This value is optional, defaults to false.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Item\": {\n \"Type\": \"ugc\",\n \"Title\": {\n \"NEUTRAL\": \"Neutral title\",\n \"en-US\": \"US English title\"\n },\n \"Description\": {\n \"NEUTRAL\": \"Neutral description\",\n \"en-US\": \"US English description\"\n },\n \"Keywords\": {\n \"NEUTRAL\": {\n \"Values\": [\n \"Keyword_1\",\n \"Keyword_2\"\n ]\n }\n },\n \"ContentType\": \"example item\",\n \"CreatorEntity\": {\n \"Id\": \"someId\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"IsHidden\": false,\n \"Tags\": [\n \"pirates\",\n \"holiday\"\n ],\n \"DisplayVersion\": \"1.0.0\",\n \"CreationDate\": \"2018-08-17T22:32:10.472Z\",\n \"Contents\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000001\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip\",\n \"MaxClientVersion\": \"2.4.1\",\n \"MinClientVersion\": \"2.0.0\"\n }\n ],\n \"Images\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000003\",\n \"Type\": \"Thumbnail\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg\"\n }\n ],\n \"DisplayProperties\": {\n \"mapDetails\": {\n \"mapType\": \"desertIsland\",\n \"gameMode\": \"capture\",\n \"maxPlayers\": 16\n },\n \"averageMatchLengthInSeconds\": 947\n },\n \"DefaultStackId\": \"Static_Default_Stack_Id\"\n },\n \"Publish\": false\n}" }, { "id": "economy-CreateUploadUrls", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/CreateUploadUrls?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateUploadUrls", "description": "Creates one or more upload URLs which can be used by the client to upload raw file data. Content URls and uploaded content will be garbage collected after 24 hours if not attached to a draft or published item. Detailed pricing info around uploading content can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/pricing/meters/catalog-meters\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/createuploadurls\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Files\": Description of the files to be uploaded by the client.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Files\": [\n {\n \"FileName\": \"textures.zip\"\n },\n {\n \"FileName\": \"sprites.png\"\n }\n ]\n}" }, { "id": "economy-DeleteEntityItemReviews", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/DeleteEntityItemReviews?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteEntityItemReviews", "description": "Deletes all reviews, helpfulness votes, and ratings submitted by the entity specified.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/deleteentityitemreviews\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Entity\": {\n \"Id\": \"ABC123\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "economy-DeleteInventoryCollection", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/DeleteInventoryCollection?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteInventoryCollection", "description": "Delete an Inventory Collection. More information about Inventory Collections can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/collections\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/deleteinventorycollection\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CollectionId\": The inventory collection id the request applies to.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity the request is about. Set to the caller by default.\n\n\"ETag\": ETags are used for concurrency checking when updating resources. More information about using ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"CollectionId\": \"backpack\"\n}" }, { "id": "economy-DeleteInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/DeleteInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteInventoryItems", "description": "Delete inventory items\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/deleteinventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\"). The number of inventory collections is unlimited.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"ETag\": ETags are used for concurrency checking when updating resources. More information about using ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags\n\n\"IdempotencyId\": The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will be garbage collected eventually.\n\n\"Item\": The inventory item the request applies to.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Item\": {\n \"Id\": \"11111111-1111-1111-1111-111111111111\"\n }\n}" }, { "id": "economy-DeleteItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/DeleteItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteItem", "description": "Removes an item from working catalog and all published versions from the public catalog.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/deleteitem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID associated with this item.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Id\": The unique ID of the item.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Id\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\"\n}" }, { "id": "economy-ExecuteInventoryOperations", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/ExecuteInventoryOperations?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ExecuteInventoryOperations", "description": "Execute a list of Inventory Operations. A maximum list of 10 operations can be performed by a single request. There is also a limit to 250 items that can be modified/added in a single request. For example, adding a bundle with 50 items counts as 50 items modified. All operations must be done within a single inventory collection. This API has a reduced RPS compared to an individual inventory operation with Player Entities limited to 15 requests in 90 seconds and Title Entities limited to 500 requests in 10 seconds.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/executeinventoryoperations\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\"). The number of inventory collections is unlimited.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"ETag\": ETags are used for concurrency checking when updating resources. More information about using ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags\n\n\"IdempotencyId\": The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will be garbage collected eventually.\n\n\"Operations\": The operations to run transactionally. The operations will be executed in-order sequentially and will succeed or fail as a batch. Up to 10 operations can be added.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Operations\": [\n {\n \"Add\": {\n \"Item\": {\n \"Id\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"Amount\": 3\n }\n },\n {\n \"Subtract\": {\n \"Item\": {\n \"Id\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"Amount\": 3,\n \"DeleteEmptyStacks\": false\n }\n }\n ]\n}" }, { "id": "economy-ExecuteTransferOperations", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/ExecuteTransferOperations?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ExecuteTransferOperations", "description": "Transfer a list of inventory items. A maximum list of 50 operations can be performed by a single request. When the response code is 202, one or more operations did not complete within the timeframe of the request. You can identify the pending operations by looking for OperationStatus = 'InProgress'. You can check on the operation status at anytime within 1 day of the request by passing the TransactionToken to the GetInventoryOperationStatus API.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/executetransferoperations\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"GivingCollectionId\": The inventory collection id the request is transferring from. (Default=\"default\")\n\n\"GivingEntity\": The entity the request is transferring from. Set to the caller by default.\n\n\"GivingETag\": ETags are used for concurrency checking when updating resources. More information about using ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags\n\n\"IdempotencyId\": The idempotency id for the request.\n\n\"Operations\": The transfer operations to run transactionally. The operations will be executed in-order sequentially and will succeed or fail as a batch. Up to 50 operations can be added.\n\n\"ReceivingCollectionId\": The inventory collection id the request is transferring to. (Default=\"default\")\n\n\"ReceivingEntity\": The entity the request is transferring to. Set to the caller by default.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Operations\": [\n {\n \"GivingItem\": {\n \"Id\": \"11111111-1111-1111-1111-111111111111\",\n \"StackId\": \"default\"\n },\n \"ReceivingItem\": {\n \"Id\": \"11111111-1111-1111-1111-111111111111\",\n \"StackId\": \"default\"\n },\n \"Amount\": 1,\n \"DeleteEmptyStacks\": false\n }\n ],\n \"GivingEntity\": {\n \"Id\": \"someId1\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"ReceivingEntity\": {\n \"Id\": \"someId2\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"GivingCollectionId\": \"default\",\n \"ReceivingCollectionId\": \"backpack\"\n}" }, { "id": "economy-GetCatalogConfig", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/GetCatalogConfig?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetCatalogConfig", "description": "Gets the configuration for the catalog. Only Title Entities can call this API. There is a limit of 100 requests in 10 seconds for this API. More information about the Catalog Config can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/getcatalogconfig\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{}" }, { "id": "economy-GetDraftItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/GetDraftItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetDraftItem", "description": "Retrieves an item from the working catalog. This item represents the current working state of the item. GetDraftItem does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/getdraftitem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID associated with this item.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Id\": The unique ID of the item.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Id\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\"\n}" }, { "id": "economy-GetDraftItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/GetDraftItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetDraftItems", "description": "Retrieves a paginated list of the items from the draft catalog. Up to 50 IDs can be retrieved in a single request. GetDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/getdraftitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateIds\": List of item alternate IDs.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Ids\": List of Item Ids.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Ids\": [\n \"dddddddd-dddd-dddd-dddd-dddddddddddd\",\n \"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee\"\n ]\n}" }, { "id": "economy-GetEntityDraftItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/GetEntityDraftItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetEntityDraftItems", "description": "Retrieves a paginated list of the items from the draft catalog created by the Entity. Up to 50 items can be returned at once. You can use continuation tokens to paginate through results that return greater than the limit. GetEntityDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/getentitydraftitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ContinuationToken\": An opaque token used to retrieve the next page of items created by the caller, if any are available. Should be null on initial request.\n\n\"Count\": Number of items to retrieve. This value is optional. Default value is 10.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Filter\": OData Filter to refine the items returned. CatalogItem properties 'type' can be used in the filter. For example: \"type eq 'ugc'\"\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Count\": 2,\n \"Entity\": {\n \"Id\": \"someId\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "economy-GetEntityItemReview", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/GetEntityItemReview?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetEntityItemReview", "description": "Gets the submitted review for the specified item by the authenticated entity. Individual ratings and reviews data update in near real time with delays within a few seconds.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/getentityitemreview\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID associated with this item.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Id\": The unique ID of the item.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Id\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\"\n}" }, { "id": "economy-GetInventoryCollectionIds", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/GetInventoryCollectionIds?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetInventoryCollectionIds", "description": "Get Inventory Collection Ids. Up to 50 Ids can be returned at once. You can use continuation tokens to paginate through results that return greater than the limit. It can take a few seconds for new collection Ids to show up.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/getinventorycollectionids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ContinuationToken\": An opaque token used to retrieve the next page of collection ids, if any are available.\n\n\"Count\": Number of items to retrieve. This value is optional. The default value is 10\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity the request is about. Set to the caller by default.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Count\": 5\n}" }, { "id": "economy-GetInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/GetInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetInventoryItems", "description": "Get current inventory items.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/getinventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\")\n\n\"ContinuationToken\": An opaque token used to retrieve the next page of items in the inventory, if any are available. Should be null on initial request.\n\n\"Count\": Number of items to retrieve. This value is optional. Maximum page size is 50. The default value is 10\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Filter\": OData Filter to refine the items returned. InventoryItem properties 'type', 'id', and 'stackId' can be used in the filter. For example: \"type eq 'currency'\"\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Count\": 5\n}" }, { "id": "economy-GetInventoryOperationStatus", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/GetInventoryOperationStatus?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetInventoryOperationStatus", "description": "Get the status of an inventory operation using an OperationToken. You can check on the operation status at anytime within 1 day of the request by passing the TransactionToken to the this API.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/getinventoryoperationstatus\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\")\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"OperationToken\": \"token\"\n}" }, { "id": "economy-GetItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/GetItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetItem", "description": "Retrieves an item from the public catalog. GetItem does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID associated with this item.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Id\": The unique ID of the item.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Id\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\"\n}" }, { "id": "economy-GetItemContainers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/GetItemContainers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetItemContainers", "description": "Search for a given item and return a set of bundles and stores containing the item. Up to 50 items can be returned at once. You can use continuation tokens to paginate through results that return greater than the limit. This API is intended for tooling/automation scenarios and has a reduced RPS with Player Entities limited to 30 requests in 300 seconds and Title Entities limited to 100 requests in 10 seconds.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitemcontainers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID associated with this item.\n\n\"ContinuationToken\": An opaque token used to retrieve the next page of items in the inventory, if any are available. Should be null on initial request.\n\n\"Count\": Number of items to retrieve. This value is optional. Default value is 10.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Id\": The unique ID of the item.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Count\": 5,\n \"Id\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\"\n}" }, { "id": "economy-GetItemModerationState", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/GetItemModerationState?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetItemModerationState", "description": "Gets the moderation state for an item, including the concern category and string reason. More information about moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitemmoderationstate\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID associated with this item.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Id\": The unique ID of the item.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Id\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\"\n}" }, { "id": "economy-GetItemPublishStatus", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/GetItemPublishStatus?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetItemPublishStatus", "description": "Gets the status of a publish of an item.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitempublishstatus\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID associated with this item.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Id\": The unique ID of the item.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Id\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\"\n}" }, { "id": "economy-GetItemReviewSummary", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/GetItemReviewSummary?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetItemReviewSummary", "description": "Get a summary of all ratings and reviews associated with the specified item. Summary ratings data is cached with update data coming within 15 minutes.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitemreviewsummary\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID associated with this item.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Id\": The unique ID of the item.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Id\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\"\n}" }, { "id": "economy-GetItemReviews", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/GetItemReviews?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetItemReviews", "description": "Get a paginated set of reviews associated with the specified item. Individual ratings and reviews data update in near real time with delays within a few seconds.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitemreviews\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID associated with this item.\n\n\"ContinuationToken\": An opaque token used to retrieve the next page of items, if any are available.\n\n\"Count\": Number of items to retrieve. This value is optional. Default value is 10.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Id\": The unique ID of the item.\n\n\"OrderBy\": An OData orderBy used to order the results of the query. Possible values are Helpfulness, Rating, and Submitted (For example: \"Submitted desc\")\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Count\": 2,\n \"Id\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\"\n}" }, { "id": "economy-GetItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/GetItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetItems", "description": "Retrieves items from the public catalog. Up to 50 items can be returned at once. GetItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note that item references data is cached and may take a few moments for changes to propagate.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/getitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateIds\": List of item alternate IDs.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Ids\": List of Item Ids.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Ids\": [\n \"dddddddd-dddd-dddd-dddd-dddddddddddd\",\n \"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee\"\n ]\n}" }, { "id": "economy-GetMicrosoftStoreAccessTokens", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/GetMicrosoftStoreAccessTokens?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetMicrosoftStoreAccessTokens", "description": "Gets the access tokens.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/getmicrosoftstoreaccesstokens\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{}" }, { "id": "economy-GetTransactionHistory", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/GetTransactionHistory?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTransactionHistory", "description": "Get transaction history for a player. Up to 50 Events can be returned at once. You can use continuation tokens to paginate through results that return greater than the limit. Getting transaction history has a lower RPS limit than getting a Player's inventory with Player Entities having a limit of 30 requests in 300 seconds and Title Entities having a limit of 100 requests in 10 seconds.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/gettransactionhistory\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\")\n\n\"ContinuationToken\": An opaque token used to retrieve the next page of items, if any are available. Should be null on initial request.\n\n\"Count\": Number of items to retrieve. This value is optional. The default value is 10\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Filter\": An OData filter used to refine the TransactionHistory. Transaction properties 'timestamp', 'transactionid', 'apiname' and 'operationtype' can be used in the filter. Properties 'transactionid', 'apiname', and 'operationtype' cannot be used together in a single request. The 'timestamp' property can be combined with 'apiname' or 'operationtype' in a single request. For example: \"timestamp ge 2023-06-20T23:30Z\" or \"transactionid eq '10'\" or \"(timestamp ge 2023-06-20T23:30Z) and (apiname eq 'AddInventoryItems')\". By default, a 6 month timespan from the current date is used.\n\n\"OrderBy\": An OData orderby to order TransactionHistory results. The only supported values are 'timestamp asc' or 'timestamp desc'. Default orderby is 'timestamp asc'\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Count\": 10,\n \"CollectionId\": \"default\"\n}" }, { "id": "economy-PublishDraftItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/PublishDraftItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "PublishDraftItem", "description": "Initiates a publish of an item from the working catalog to the public catalog. You can use the GetItemPublishStatus API to track the state of the item publish.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/publishdraftitem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID associated with this item.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"ETag\": ETag of the catalog item to published from the working catalog to the public catalog. Used for optimistic concurrency. If the provided ETag does not match the ETag in the current working catalog, the request will be rejected. If not provided, the current version of the document in the working catalog will be published.\n\n\"Id\": The unique ID of the item.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Id\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\"\n}" }, { "id": "economy-PurchaseInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/PurchaseInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "PurchaseInventoryItems", "description": "Purchase an item or bundle. Up to 3500 stacks of items can be added to a single inventory collection. Stack size is uncapped.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/purchaseinventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Amount\": The amount to purchase.\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\"). The number of inventory collections is unlimited.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"DeleteEmptyStacks\": Indicates whether stacks reduced to an amount of 0 during the request should be deleted from the inventory. (Default=false)\n\n\"DurationInSeconds\": The duration to purchase.\n\n\"Entity\": The entity to perform this action on.\n\n\"ETag\": ETags are used for concurrency checking when updating resources. More information about using ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags\n\n\"IdempotencyId\": The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will be garbage collected eventually.\n\n\"Item\": The inventory item the request applies to.\n\n\"NewStackValues\": The values to apply to a stack newly created by this request.\n\n\"PriceAmounts\": The per-item price the item is expected to be purchased at. This must match a value configured in the Catalog or specified Store. \n\n\"StoreId\": The id of the Store to purchase the item from.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Item\": {\n \"Id\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"Amount\": 1,\n \"PriceAmounts\": [\n {\n \"ItemId\": \"cccccccc-cccc-cccc-cccc-cccccccccccc\",\n \"Amount\": 15\n }\n ],\n \"DeleteEmptyStacks\": false\n}" }, { "id": "economy-RedeemAppleAppStoreInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/RedeemAppleAppStoreInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RedeemAppleAppStoreInventoryItems", "description": "Redeem items.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemappleappstoreinventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\")\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Receipt\": The receipt provided by the Apple marketplace upon successful purchase.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Receipt\": \"receipt\"\n}" }, { "id": "economy-RedeemGooglePlayInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/RedeemGooglePlayInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RedeemGooglePlayInventoryItems", "description": "Redeem items.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemgoogleplayinventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\")\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Purchases\": The list of purchases to redeem\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Purchases\": [\n {\n \"ProductId\": \"productId\",\n \"Token\": \"token\"\n }\n ]\n}" }, { "id": "economy-RedeemMicrosoftStoreInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/RedeemMicrosoftStoreInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RedeemMicrosoftStoreInventoryItems", "description": "Redeem items.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemmicrosoftstoreinventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\")\n\n\"CollectionsIdKey\": The OneStore Collections Id Key used for AAD authentication.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"XboxToken\": Xbox Token used for delegated business partner authentication. Token provided by the Xbox Live SDK method GetTokenAndSignatureAsync(\"POST\", \"https://playfabapi.com/\", \"\").\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"CollectionsIdKey\": \"collectionsIdKey\"\n}" }, { "id": "economy-RedeemNintendoEShopInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/RedeemNintendoEShopInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RedeemNintendoEShopInventoryItems", "description": "Redeem items.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemnintendoeshopinventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\")\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"NintendoServiceAccountIdToken\": The Nintendo provided token authorizing redemption\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"NintendoServiceAccountIdToken\": \"nsaIdToken\"\n}" }, { "id": "economy-RedeemPlayStationStoreInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/RedeemPlayStationStoreInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RedeemPlayStationStoreInventoryItems", "description": "Redeem items.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemplaystationstoreinventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AuthorizationCode\": Auth code returned by PlayStation :tm: Network OAuth system.\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\")\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"RedirectUri\": Redirect URI supplied to PlayStation :tm: Network when requesting an auth code\n\n\"ServiceLabel\": Optional Service Label to pass into the request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"AuthorizationCode\": \"authorizationCode\",\n \"RedirectUri\": \"orbis://games\",\n \"ServiceLabel\": \"0\"\n}" }, { "id": "economy-RedeemSteamInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/RedeemSteamInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RedeemSteamInventoryItems", "description": "Redeem items.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemsteaminventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\")\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{}" }, { "id": "economy-ReportItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/ReportItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ReportItem", "description": "Submit a report for an item, indicating in what way the item is inappropriate.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/reportitem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID associated with this item.\n\n\"ConcernCategory\": Category of concern for this report.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Id\": The unique ID of the item.\n\n\"Reason\": The string reason for this report.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"ConcernCategory\": \"Profanity\",\n \"Reason\": \"There was swearing in the description.\",\n \"Id\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\"\n}" }, { "id": "economy-ReportItemReview", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/ReportItemReview?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ReportItemReview", "description": "Submit a report for a review\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/reportitemreview\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID of the item associated with the review.\n\n\"ConcernCategory\": The reason this review is being reported.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"ItemId\": The string ID of the item associated with the review.\n\n\"Reason\": The string reason for this report.\n\n\"ReviewId\": The ID of the review to submit a report for.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"ReviewId\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\",\n \"ItemId\": \"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee\",\n \"ConcernCategory\": \"OffensiveContent\",\n \"Reason\": \"Foul language.\"\n}" }, { "id": "economy-ReviewItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/ReviewItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ReviewItem", "description": "Creates or updates a review for the specified item. More information around the caching surrounding item ratings and reviews can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/ratings#ratings-design-and-caching\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/reviewitem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID associated with this item.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Id\": The unique ID of the item.\n\n\"Review\": The review to submit.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Review\": {\n \"ItemVersion\": \"2.4.1\",\n \"Title\": \"Best Game Ever\",\n \"ReviewText\": \"I play this game every day. It's my favorite game yet.\",\n \"Rating\": 5,\n \"IsInstalled\": true,\n \"HelpfulPositive\": 0,\n \"HelpfulNegative\": 0,\n \"Submitted\": \"0001-01-01T00:00:00Z\"\n },\n \"Id\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\"\n}" }, { "id": "economy-SearchItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/SearchItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SearchItems", "description": "Executes a search against the public catalog using the provided search parameters and returns a set of paginated results. SearchItems uses a cache of the catalog with item updates taking up to a few minutes to propagate. You should use the GetItem API for when trying to immediately get recent item updates. More information about the Search API can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/search\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/searchitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ContinuationToken\": An opaque token used to retrieve the next page of items, if any are available.\n\n\"Count\": Number of items to retrieve. This value is optional. Maximum page size is 50. Default value is 10.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Filter\": An OData filter used to refine the search query (For example: \"type eq 'ugc'\"). More info about Filter Complexity limits can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/search#limits\n\n\"Language\": The locale to be returned in the result.\n\n\"OrderBy\": An OData orderBy used to order the results of the search query. For example: \"rating/average asc\" \n\n\"Search\": The text to search for.\n\n\"Select\": An OData select query option used to augment the search results. If not defined, the default search result metadata will be returned.\n\n\"Store\": The store to restrict the search request to.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Search\": \"Pirates\",\n \"Filter\": \"tags/any(t:t eq 'desert') and contentType eq 'map'\",\n \"OrderBy\": \"lastModifiedDate asc\",\n \"ContinuationToken\": \"abc=\",\n \"Count\": 2\n}" }, { "id": "economy-SetItemModerationState", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/SetItemModerationState?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetItemModerationState", "description": "Sets the moderation state for an item, including the concern category and string reason. More information about moderation states can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/ugc/moderation\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/setitemmoderationstate\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID associated with this item.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Id\": The unique ID of the item.\n\n\"Reason\": The reason for the moderation state change for the associated item.\n\n\"Status\": The status to set for the associated item.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Status\": \"AwaitingModeration\",\n \"Reason\": \"User reports over threshold\",\n \"Id\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\"\n}" }, { "id": "economy-SubmitItemReviewVote", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/SubmitItemReviewVote?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SubmitItemReviewVote", "description": "Submit a vote for a review, indicating whether the review was helpful or unhelpful.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/submititemreviewvote\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AlternateId\": An alternate ID of the item associated with the review.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"ItemId\": The string ID of the item associated with the review.\n\n\"ReviewId\": The ID of the review to submit a helpfulness vote for.\n\n\"Vote\": The helpfulness vote of the review.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"ReviewId\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\",\n \"ItemId\": \"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee\",\n \"Vote\": \"Helpful\"\n}" }, { "id": "economy-SubtractInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/SubtractInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SubtractInventoryItems", "description": "Subtract inventory items.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/subtractinventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Amount\": The amount to subtract for the current item.\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\"). The number of inventory collections is unlimited.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"DeleteEmptyStacks\": Indicates whether stacks reduced to an amount of 0 during the request should be deleted from the inventory. (Default=false)\n\n\"DurationInSeconds\": The duration to subtract from the current item expiration date.\n\n\"Entity\": The entity to perform this action on.\n\n\"ETag\": ETags are used for concurrency checking when updating resources. More information about using ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags\n\n\"IdempotencyId\": The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will be garbage collected eventually.\n\n\"Item\": The inventory item the request applies to.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Item\": {\n \"Id\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"Amount\": 3,\n \"DeleteEmptyStacks\": false,\n \"ReturnInventory\": false\n}" }, { "id": "economy-TakedownItemReviews", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/TakedownItemReviews?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "TakedownItemReviews", "description": "Submit a request to takedown one or more reviews.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/takedownitemreviews\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Reviews\": The set of reviews to take down.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Reviews\": [\n {\n \"ItemId\": \"00000000-0000-0000-0000-000000000003\",\n \"ReviewId\": \"dddddddd-dddd-dddd-dddd-dddddddddddd\"\n }\n ]\n}" }, { "id": "economy-TransferInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/TransferInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "TransferInventoryItems", "description": "Transfer inventory items. When transferring across collections, a 202 response indicates that the transfer did not complete within the timeframe of the request. You can identify the pending operations by looking for OperationStatus = 'InProgress'. You can check on the operation status at anytime within 1 day of the request by passing the TransactionToken to the GetInventoryOperationStatus API. More information about item transfer scenarios can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/inventory/?tabs=inventory-game-manager#transfer-inventory-items\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/transferinventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Amount\": The amount to transfer .\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"DeleteEmptyStacks\": Indicates whether stacks reduced to an amount of 0 during the request should be deleted from the inventory. (Default = false)\n\n\"GivingCollectionId\": The inventory collection id the request is transferring from. (Default=\"default\")\n\n\"GivingEntity\": The entity the request is transferring from. Set to the caller by default.\n\n\"GivingETag\": ETags are used for concurrency checking when updating resources (before transferring from). More information about using ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags\n\n\"GivingItem\": The inventory item the request is transferring from.\n\n\"IdempotencyId\": The idempotency id for the request.\n\n\"NewStackValues\": The values to apply to a stack newly created by this request.\n\n\"ReceivingCollectionId\": The inventory collection id the request is transferring to. (Default=\"default\")\n\n\"ReceivingEntity\": The entity the request is transferring to. Set to the caller by default.\n\n\"ReceivingItem\": The inventory item the request is transferring to.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"GivingItem\": {\n \"Id\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"ReceivingItem\": {\n \"Id\": \"11111111-1111-1111-1111-111111111111\"\n },\n \"Amount\": 1,\n \"DeleteEmptyStacks\": false,\n \"GivingCollectionId\": \"default\",\n \"ReceivingCollectionId\": \"backpack\"\n}" }, { "id": "economy-UpdateCatalogConfig", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/UpdateCatalogConfig?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateCatalogConfig", "description": "Updates the configuration for the catalog. Only Title Entities can call this API. There is a limit of 10 requests in 10 seconds for this API. More information about the Catalog Config can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/settings\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/updatecatalogconfig\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Config\": The updated catalog configuration.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Config\": {\n \"IsCatalogEnabled\": true,\n \"AdminEntities\": [\n {\n \"Id\": \"ABC123\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n ],\n \"DisplayPropertyIndexInfos\": [\n {\n \"Name\": \"damage\",\n \"Type\": \"QueryDouble\"\n }\n ],\n \"ReviewerEntities\": [\n {\n \"Id\": \"ABC123\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n ],\n \"UserGeneratedContent\": {\n \"ContentTypes\": [\n \"skin\",\n \"map\",\n \"example item\"\n ],\n \"Tags\": [\n \"pirate\",\n \"holiday\"\n ]\n }\n }\n}" }, { "id": "economy-UpdateDraftItem", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Catalog/UpdateDraftItem?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateDraftItem", "description": "Update the metadata for an item in the working catalog.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/catalog/updatedraftitem\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Item\": Updated metadata describing the catalog item to be updated.\n\n\"Publish\": Whether the item should be published immediately. This value is optional, defaults to false.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Item\": {\n \"Id\": \"qqqqqqqq-qqqq-qqqq-qqqq-qqqqqqqqqqqq\",\n \"Type\": \"ugc\",\n \"Title\": {\n \"NEUTRAL\": \"Neutral title\",\n \"en-US\": \"US English title\"\n },\n \"Description\": {\n \"NEUTRAL\": \"Neutral description\",\n \"en-US\": \"US English description\"\n },\n \"Keywords\": {\n \"NEUTRAL\": {\n \"Values\": [\n \"Keyword_1\",\n \"Keyword_2\"\n ]\n }\n },\n \"ContentType\": \"example item\",\n \"CreatorEntity\": {\n \"Id\": \"someId\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"IsHidden\": false,\n \"Tags\": [\n \"pirates\",\n \"holiday\"\n ],\n \"DisplayVersion\": \"1.0.0\",\n \"CreationDate\": \"2018-08-17T22:32:10.472Z\",\n \"Contents\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000001\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000001/textures.zip\",\n \"MaxClientVersion\": \"2.4.1\",\n \"MinClientVersion\": \"2.0.0\"\n }\n ],\n \"Images\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000003\",\n \"Type\": \"Thumbnail\",\n \"Url\": \"https://endpoint.blob.core.windows.net/some-identifier-private/00000000-0000-0000-0000-000000000003/splashscreen_thumb.jpg\"\n }\n ],\n \"DisplayProperties\": {\n \"mapDetails\": {\n \"mapType\": \"desertIsland\",\n \"gameMode\": \"capture\",\n \"maxPlayers\": 16\n },\n \"averageMatchLengthInSeconds\": 947\n },\n \"DefaultStackId\": \"Static_Default_Stack_Id\"\n },\n \"Publish\": false\n}" }, { "id": "economy-UpdateInventoryItems", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Inventory/UpdateInventoryItems?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateInventoryItems", "description": "Update inventory items\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/economy/inventory/updateinventoryitems\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CollectionId\": The id of the entity's collection to perform this action on. (Default=\"default\"). The number of inventory collections is unlimited.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"ETag\": ETags are used for concurrency checking when updating resources. More information about using ETags can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/economy-v2/catalog/etags\n\n\"IdempotencyId\": The Idempotency ID for this request. Idempotency IDs can be used to prevent operation replay in the medium term but will be garbage collected eventually.\n\n\"Item\": The inventory item to update with the specified values.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-economyFolder", "rawModeData": "{\n \"Item\": {\n \"Id\": \"11111111-1111-1111-1111-111111111111\",\n \"Amount\": 3\n },\n \"ReturnInventory\": false\n}" }, { "id": "events-CreateTelemetryKey", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Event/CreateTelemetryKey?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateTelemetryKey", "description": "Creates a new telemetry key for the title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/events/playstream-events/createtelemetrykey\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\n\"KeyName\": The name of the new key. Telemetry key names must be unique within the scope of the title.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-eventsFolder", "rawModeData": "{\n \"KeyName\": \"MyTelemetryKey\"\n}" }, { "id": "events-DeleteTelemetryKey", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Event/DeleteTelemetryKey?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteTelemetryKey", "description": "Deletes a telemetry key configured for the title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/events/playstream-events/deletetelemetrykey\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\n\"KeyName\": The name of the key to delete.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-eventsFolder", "rawModeData": "{\n \"KeyName\": \"MyTelemetryKey\"\n}" }, { "id": "events-GetTelemetryKey", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Event/GetTelemetryKey?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTelemetryKey", "description": "Gets information about a telemetry key configured for the title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/events/playstream-events/gettelemetrykey\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\n\"KeyName\": The name of the key to retrieve.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-eventsFolder", "rawModeData": "{\n \"KeyName\": \"MyTelemetryKey\"\n}" }, { "id": "events-ListTelemetryKeys", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Event/ListTelemetryKeys?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListTelemetryKeys", "description": "Lists all telemetry keys configured for the title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/events/playstream-events/listtelemetrykeys\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-eventsFolder", "rawModeData": "{}" }, { "id": "events-SetTelemetryKeyActive", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Event/SetTelemetryKeyActive?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetTelemetryKeyActive", "description": "Sets a telemetry key to the active or deactivated state.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/events/playstream-events/settelemetrykeyactive\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Active\": Whether to set the key to active (true) or deactivated (false).\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\n\"KeyName\": The name of the key to update.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-eventsFolder", "rawModeData": "{\n \"KeyName\": \"MyTelemetryKey\",\n \"Active\": false\n}" }, { "id": "events-WriteEvents", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Event/WriteEvents?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "WriteEvents", "description": "Write batches of entity based events to PlayStream. The namespace of the Event must be 'custom' or start with 'custom.'.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/events/playstream-events/writeevents\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Events\": The collection of events to write. Up to 200 events can be written per request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-eventsFolder", "rawModeData": "{\n \"Events\": [\n {\n \"Entity\": {\n \"Id\": \"A8140AB9109712B\",\n \"Type\": \"title\",\n \"TypeString\": \"title\"\n },\n \"EventNamespace\": \"com.playfab.events.example\",\n \"Name\": \"something_happened\",\n \"Payload\": {\n \"Foo\": \"Bar\",\n \"Nums\": [\n 1,\n 2,\n 3\n ]\n }\n }\n ]\n}" }, { "id": "events-WriteTelemetryEvents", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Event/WriteTelemetryEvents?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "WriteTelemetryEvents", "description": "Write batches of entity based events to as Telemetry events (bypass PlayStream). The namespace must be 'custom' or start with 'custom.'\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/events/playstream-events/writetelemetryevents\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Events\": The collection of events to write. Up to 200 events can be written per request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-eventsFolder", "rawModeData": "{\n \"Events\": [\n {\n \"Entity\": {\n \"Id\": \"A8140AB9109712B\",\n \"Type\": \"title\",\n \"TypeString\": \"title\"\n },\n \"EventNamespace\": \"com.playfab.events.example\",\n \"Name\": \"something_happened\",\n \"Payload\": {\n \"Foo\": \"Bar\",\n \"Nums\": [\n 1,\n 2,\n 3\n ]\n }\n }\n ]\n}" }, { "id": "experimentation-CreateExclusionGroup", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Experimentation/CreateExclusionGroup?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateExclusionGroup", "description": "Creates a new experiment exclusion group for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/createexclusiongroup\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Description\": Description of the exclusion group.\n\n\"Name\": Friendly name of the exclusion group.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-experimentationFolder", "rawModeData": "{\n \"Name\": \"Commerce Exclusion Group\",\n \"Description\": \"Exclusion group for independent, commerce-related experiments\"\n}" }, { "id": "experimentation-CreateExperiment", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Experimentation/CreateExperiment?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateExperiment", "description": "Creates a new experiment for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/createexperiment\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Description\": Description of the experiment.\n\n\"EndDate\": When experiment should end.\n\n\"ExclusionGroupId\": Id of the exclusion group.\n\n\"ExclusionGroupTrafficAllocation\": Percentage of exclusion group traffic that will see this experiment.\n\n\"ExperimentType\": Type of experiment.\n\n\"Name\": Friendly name of the experiment.\n\n\"SegmentId\": Id of the segment to which this experiment applies. Defaults to the 'All Players' segment.\n\n\"StartDate\": When experiment should start.\n\n\"TitlePlayerAccountTestIds\": List of title player account IDs that automatically receive treatments in the experiment, but are not included when calculating experiment metrics.\n\n\"Variants\": List of variants for the experiment.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-experimentationFolder", "rawModeData": "{\n \"Name\": \"BackgroundColor Experiment\",\n \"Description\": \"Tests whether a green background color increases revenue\",\n \"StartDate\": \"2019-10-25T20:37:00Z\",\n \"EndDate\": \"2019-11-13T20:37:00Z\",\n \"Variants\": [\n {\n \"Name\": \"Control\",\n \"Description\": \"Control variant\",\n \"TrafficPercentage\": 10,\n \"Variables\": [\n {\n \"Name\": \"BackgroundColor\",\n \"Value\": \"White\"\n }\n ],\n \"IsControl\": true\n },\n {\n \"Name\": \"Treatment\",\n \"Description\": \"Treatment variant\",\n \"TrafficPercentage\": 90,\n \"Variables\": [\n {\n \"Name\": \"BackgroundColor\",\n \"Value\": \"Green\"\n }\n ],\n \"IsControl\": false\n }\n ],\n \"ExperimentType\": \"Active\"\n}" }, { "id": "experimentation-DeleteExclusionGroup", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Experimentation/DeleteExclusionGroup?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteExclusionGroup", "description": "Deletes an existing exclusion group for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/deleteexclusiongroup\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExclusionGroupId\": The ID of the exclusion group to delete.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-experimentationFolder", "rawModeData": "{\n \"ExclusionGroupId\": \"00000000-0000-0000-0000-000000000000\"\n}" }, { "id": "experimentation-DeleteExperiment", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Experimentation/DeleteExperiment?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteExperiment", "description": "Deletes an existing experiment for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/deleteexperiment\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExperimentId\": The ID of the experiment to delete.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-experimentationFolder", "rawModeData": "{\n \"ExperimentId\": \"00000000-0000-0000-0000-000000000000\"\n}" }, { "id": "experimentation-GetExclusionGroupTraffic", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Experimentation/GetExclusionGroupTraffic?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetExclusionGroupTraffic", "description": "Gets the details of all exclusion groups for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexclusiongrouptraffic\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExclusionGroupId\": The ID of the exclusion group.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-experimentationFolder", "rawModeData": "{}" }, { "id": "experimentation-GetExclusionGroups", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Experimentation/GetExclusionGroups?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetExclusionGroups", "description": "Gets the details of all exclusion groups for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexclusiongroups\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-experimentationFolder", "rawModeData": "{}" }, { "id": "experimentation-GetExperiments", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Experimentation/GetExperiments?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetExperiments", "description": "Gets the details of all experiments for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getexperiments\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-experimentationFolder", "rawModeData": "{}" }, { "id": "experimentation-GetLatestScorecard", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Experimentation/GetLatestScorecard?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetLatestScorecard", "description": "Gets the latest scorecard of the experiment for the title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/getlatestscorecard\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExperimentId\": The ID of the experiment.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-experimentationFolder", "rawModeData": "{\n \"ExperimentId\": \"00000000-0000-0000-0000-000000000000\"\n}" }, { "id": "experimentation-GetTreatmentAssignment", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Experimentation/GetTreatmentAssignment?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTreatmentAssignment", "description": "Gets the treatment assignments for a player for every running experiment in the title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/gettreatmentassignment\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-experimentationFolder", "rawModeData": "{}" }, { "id": "experimentation-StartExperiment", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Experimentation/StartExperiment?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "StartExperiment", "description": "Starts an existing experiment for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/startexperiment\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExperimentId\": The ID of the experiment to start.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-experimentationFolder", "rawModeData": "{\n \"ExperimentId\": \"00000000-0000-0000-0000-000000000000\"\n}" }, { "id": "experimentation-StopExperiment", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Experimentation/StopExperiment?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "StopExperiment", "description": "Stops an existing experiment for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/stopexperiment\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExperimentId\": The ID of the experiment to stop.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-experimentationFolder", "rawModeData": "{\n \"ExperimentId\": \"00000000-0000-0000-0000-000000000000\"\n}" }, { "id": "experimentation-UpdateExclusionGroup", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Experimentation/UpdateExclusionGroup?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateExclusionGroup", "description": "Updates an existing exclusion group for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/updateexclusiongroup\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Description\": Description of the exclusion group.\n\n\"ExclusionGroupId\": The ID of the exclusion group to update.\n\n\"Name\": Friendly name of the exclusion group.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-experimentationFolder", "rawModeData": "{\n \"ExclusionGroupId\": \"00000000-0000-0000-0000-000000000000\",\n \"Name\": \"Commerce Exclusion Group\",\n \"Description\": \"Exclusion group for independent, commerce-related experiments\"\n}" }, { "id": "experimentation-UpdateExperiment", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Experimentation/UpdateExperiment?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateExperiment", "description": "Updates an existing experiment for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/experimentation/experimentation/updateexperiment\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Description\": Description of the experiment.\n\n\"EndDate\": When experiment should end.\n\n\"ExclusionGroupId\": Id of the exclusion group.\n\n\"ExclusionGroupTrafficAllocation\": Percentage of exclusion group traffic that will see this experiment.\n\n\"ExperimentType\": Type of experiment.\n\n\"Id\": Id of the experiment.\n\n\"Name\": Friendly name of the experiment.\n\n\"SegmentId\": Id of the segment to which this experiment applies. Defaults to the 'All Players' segment.\n\n\"StartDate\": When experiment should start.\n\n\"TitlePlayerAccountTestIds\": List of title player account IDs that automatically receive treatments in the experiment, but are not included when calculating experiment metrics.\n\n\"Variants\": List of variants for the experiment.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-experimentationFolder", "rawModeData": "{\n \"Name\": \"BackgroundColor Experiment\",\n \"Id\": \"B9A90E90-A009-4254-80A4-46B5933E9D26\",\n \"Description\": \"Tests whether a green background color increases revenue\",\n \"StartDate\": \"2019-10-25T20:37:00Z\",\n \"EndDate\": \"2019-11-13T20:37:00Z\",\n \"SegmentId\": \"0\",\n \"Variants\": [\n {\n \"Name\": \"Control\",\n \"Description\": \"Control variant\",\n \"TrafficPercentage\": 10,\n \"Variables\": [\n {\n \"Name\": \"BackgroundColor\",\n \"Value\": \"White\"\n }\n ],\n \"IsControl\": true\n },\n {\n \"Name\": \"Treatment\",\n \"Description\": \"Treatment variant\",\n \"TrafficPercentage\": 90,\n \"Variables\": [\n {\n \"Name\": \"BackgroundColor\",\n \"Value\": \"Green\"\n }\n ],\n \"IsControl\": false\n }\n ],\n \"ExperimentType\": \"Active\"\n}" }, { "id": "insights-GetDetails", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Insights/GetDetails?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetDetails", "description": "Gets the current values for the Insights performance and data storage retention, list of pending operations, and the performance and data storage retention limits.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/insights/analytics/getdetails\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-insightsFolder", "rawModeData": "{}" }, { "id": "insights-GetLimits", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Insights/GetLimits?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetLimits", "description": "Retrieves the range of allowed values for performance and data storage retention values as well as the submeter details for each performance level.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/insights/analytics/getlimits\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-insightsFolder", "rawModeData": "{}" }, { "id": "insights-GetOperationStatus", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Insights/GetOperationStatus?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetOperationStatus", "description": "Gets the status of a SetPerformance or SetStorageRetention operation.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/insights/analytics/getoperationstatus\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"OperationId\": Id of the Insights operation.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-insightsFolder", "rawModeData": "{\n \"OperationId\": \"3ee468c4-ad09-4bb1-bccf-209ef5abfb96\"\n}" }, { "id": "insights-GetPendingOperations", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Insights/GetPendingOperations?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetPendingOperations", "description": "Gets a list of pending SetPerformance and/or SetStorageRetention operations for the title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/insights/analytics/getpendingoperations\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"OperationType\": The type of pending operations requested, or blank for all operation types.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-insightsFolder", "rawModeData": "{\n \"OperationType\": \"SetPerformance\"\n}" }, { "id": "insights-SetPerformance", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Insights/SetPerformance?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetPerformance", "description": "Sets the Insights performance level value for the title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/insights/analytics/setperformance\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PerformanceLevel\": The Insights performance level to apply to the title.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-insightsFolder", "rawModeData": "{\n \"PerformanceLevel\": 3\n}" }, { "id": "insights-SetStorageRetention", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Insights/SetStorageRetention?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetStorageRetention", "description": "Sets the Insights data storage retention days value for the title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/insights/analytics/setstorageretention\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"RetentionDays\": The Insights data storage retention value (in days) to apply to the title.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-insightsFolder", "rawModeData": "{\n \"RetentionDays\": 30\n}" }, { "id": "groups-AcceptGroupApplication", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/AcceptGroupApplication?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AcceptGroupApplication", "description": "Accepts an outstanding invitation to to join a group\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/acceptgroupapplication\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": Type of the entity to accept as. Must be the same entity as the claimant or an entity that is a child of the claimant entity.\n\n\"Group\": The identifier of the group\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n },\n \"Entity\": {\n \"Id\": \"90901000\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "groups-AcceptGroupInvitation", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/AcceptGroupInvitation?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AcceptGroupInvitation", "description": "Accepts an invitation to join a group\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/acceptgroupinvitation\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\n\"Group\": The identifier of the group\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n }\n}" }, { "id": "groups-AddMembers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/AddMembers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "AddMembers", "description": "Adds members to a group or role.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/addmembers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Group\": The identifier of the group\n\n\"Members\": List of entities to add to the group. Only entities of type title_player_account and character may be added to groups.\n\n\"RoleId\": Optional: The ID of the existing role to add the entities to. If this is not specified, the default member role for the group will be used. Role IDs must be between 1 and 64 characters long.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n },\n \"Members\": [\n {\n \"Id\": \"90901000\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n ]\n}" }, { "id": "groups-ApplyToGroup", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/ApplyToGroup?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ApplyToGroup", "description": "Applies to join a group\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/applytogroup\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AutoAcceptOutstandingInvite\": Optional, default true. Automatically accept an outstanding invitation if one exists instead of creating an application\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\n\"Group\": The identifier of the group\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n }\n}" }, { "id": "groups-BlockEntity", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/BlockEntity?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "BlockEntity", "description": "Blocks a list of entities from joining a group.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/blockentity\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Group\": The identifier of the group\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n },\n \"Entity\": {\n \"Id\": \"90901000\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "groups-ChangeMemberRole", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/ChangeMemberRole?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ChangeMemberRole", "description": "Changes the role membership of a list of entities from one role to another.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/changememberrole\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"DestinationRoleId\": The ID of the role that the entities will become a member of. This must be an existing role. Role IDs must be between 1 and 64 characters long.\n\n\"Group\": The identifier of the group\n\n\"Members\": List of entities to move between roles in the group. All entities in this list must be members of the group and origin role.\n\n\"OriginRoleId\": The ID of the role that the entities currently are a member of. Role IDs must be between 1 and 64 characters long.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n },\n \"OriginRoleId\": \"awesomepeople\",\n \"DestinationRoleId\": \"members\",\n \"Members\": [\n {\n \"Id\": \"90901000\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n ]\n}" }, { "id": "groups-CreateGroup", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/CreateGroup?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateGroup", "description": "Creates a new group.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/creategroup\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\n\"GroupName\": The name of the group. This is unique at the title level by default.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"GroupName\": \"Example Group\"\n}" }, { "id": "groups-CreateRole", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/CreateRole?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateRole", "description": "Creates a new group role.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/createrole\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Group\": The identifier of the group\n\n\"RoleId\": The ID of the role. This must be unique within the group and cannot be changed. Role IDs must be between 1 and 64 characters long and are restricted to a-Z, A-Z, 0-9, '(', ')', '_', '-' and '.'.\n\n\"RoleName\": The name of the role. This must be unique within the group and can be changed later. Role names must be between 1 and 100 characters long\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"RoleId\": \"example\",\n \"RoleName\": \"Example Role\",\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n }\n}" }, { "id": "groups-DeleteGroup", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/DeleteGroup?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteGroup", "description": "Deletes a group and all roles, invitations, join requests, and blocks associated with it.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/deletegroup\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Group\": ID of the group or role to remove\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n }\n}" }, { "id": "groups-DeleteRole", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/DeleteRole?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteRole", "description": "Deletes an existing role in a group.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/deleterole\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Group\": The identifier of the group\n\n\"RoleId\": The ID of the role to delete. Role IDs must be between 1 and 64 characters long.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n },\n \"RoleId\": \"ABC1234DEF\"\n}" }, { "id": "groups-GetGroup", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/GetGroup?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetGroup", "description": "Gets information about a group and its roles\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/getgroup\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Group\": The identifier of the group\n\n\"GroupName\": The full name of the group\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n }\n}" }, { "id": "groups-InviteToGroup", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/InviteToGroup?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "InviteToGroup", "description": "Invites a player to join a group\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/invitetogroup\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AutoAcceptOutstandingApplication\": Optional, default true. Automatically accept an application if one exists instead of creating an invitation\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Group\": The identifier of the group\n\n\"RoleId\": Optional. ID of an existing a role in the group to assign the user to. The group's default member role is used if this is not specified. Role IDs must be between 1 and 64 characters long.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n },\n \"RoleId\": \"awesomepeople\",\n \"Entity\": {\n \"Id\": \"90901000\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "groups-IsMember", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/IsMember?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "IsMember", "description": "Checks to see if an entity is a member of a group or role within the group\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/ismember\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Group\": The identifier of the group\n\n\"RoleId\": Optional: ID of the role to check membership of. Defaults to any role (that is, check to see if the entity is a member of the group in any capacity) if not specified.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n },\n \"RoleId\": \"ABC1234DEF\",\n \"Entity\": {\n \"Id\": \"90901000\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "groups-ListGroupApplications", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/ListGroupApplications?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListGroupApplications", "description": "Lists all outstanding requests to join a group\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupapplications\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Group\": The identifier of the group\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n }\n}" }, { "id": "groups-ListGroupBlocks", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/ListGroupBlocks?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListGroupBlocks", "description": "Lists all entities blocked from joining a group\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupblocks\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Group\": The identifier of the group\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n }\n}" }, { "id": "groups-ListGroupInvitations", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/ListGroupInvitations?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListGroupInvitations", "description": "Lists all outstanding invitations for a group\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupinvitations\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Group\": The identifier of the group\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n }\n}" }, { "id": "groups-ListGroupMembers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/ListGroupMembers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListGroupMembers", "description": "Lists all members for a group\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/listgroupmembers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Group\": ID of the group to list the members and roles for\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n }\n}" }, { "id": "groups-ListMembership", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/ListMembership?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListMembership", "description": "Lists all groups and roles for an entity\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/listmembership\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{}" }, { "id": "groups-ListMembershipOpportunities", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/ListMembershipOpportunities?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListMembershipOpportunities", "description": "Lists all outstanding invitations and group applications for an entity\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/listmembershipopportunities\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{}" }, { "id": "groups-RemoveGroupApplication", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/RemoveGroupApplication?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemoveGroupApplication", "description": "Removes an application to join a group\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/removegroupapplication\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Group\": The identifier of the group\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n },\n \"Entity\": {\n \"Id\": \"90901000\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "groups-RemoveGroupInvitation", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/RemoveGroupInvitation?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemoveGroupInvitation", "description": "Removes an invitation join a group\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/removegroupinvitation\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Group\": The identifier of the group\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n },\n \"Entity\": {\n \"Id\": \"90901000\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "groups-RemoveMembers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/RemoveMembers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemoveMembers", "description": "Removes members from a group.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/removemembers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Group\": The identifier of the group\n\n\"Members\": List of entities to remove\n\n\"RoleId\": The ID of the role to remove the entities from.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n },\n \"RoleId\": \"ABC1234DEF\",\n \"Members\": [\n {\n \"Id\": \"90901000\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n ]\n}" }, { "id": "groups-UnblockEntity", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/UnblockEntity?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnblockEntity", "description": "Unblocks a list of entities from joining a group\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/unblockentity\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Group\": The identifier of the group\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n },\n \"Entity\": {\n \"Id\": \"90901000\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "groups-UpdateGroup", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/UpdateGroup?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateGroup", "description": "Updates non-membership data about a group.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/updategroup\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AdminRoleId\": Optional: the ID of an existing role to set as the new administrator role for the group\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExpectedProfileVersion\": Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from the GetGroup API, you can ensure that the group data update will only be performed if the group has not been updated by any other clients since the version you last loaded.\n\n\"Group\": The identifier of the group\n\n\"GroupName\": Optional: the new name of the group\n\n\"MemberRoleId\": Optional: the ID of an existing role to set as the new member role for the group\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n },\n \"GroupName\": \"My New Group Name\",\n \"ExpectedProfileVersion\": 17\n}" }, { "id": "groups-UpdateRole", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Group/UpdateRole?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateRole", "description": "Updates metadata about a role.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/groups/groups/updaterole\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExpectedProfileVersion\": Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from the GetGroup API, you can ensure that the group data update will only be performed if the group has not been updated by any other clients since the version you last loaded.\n\n\"Group\": The identifier of the group\n\n\"RoleId\": ID of the role to update. Role IDs must be between 1 and 64 characters long.\n\n\"RoleName\": The new name of the role\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-groupsFolder", "rawModeData": "{\n \"Group\": {\n \"Id\": \"ABC1234ABC\"\n },\n \"RoleId\": \"ABC1234DEF\",\n \"RoleName\": \"My New Role Name\",\n \"ExpectedProfileVersion\": 17\n}" }, { "id": "localization-GetLanguageList", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Locale/GetLanguageList?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetLanguageList", "description": "Retrieves the list of allowed languages, only accessible by title entities\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/localization/localization/getlanguagelist\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-localizationFolder", "rawModeData": "{}" }, { "id": "multiplayer-CancelAllMatchmakingTicketsForPlayer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/CancelAllMatchmakingTicketsForPlayer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CancelAllMatchmakingTicketsForPlayer", "description": "Cancel all active tickets the player is a member of in a given queue.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/cancelallmatchmakingticketsforplayer\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity key of the player whose tickets should be canceled.\n\n\"QueueName\": The name of the queue from which a player's tickets should be canceled.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Entity\": {\n \"Id\": \"123123123\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"QueueName\": \"custom123\"\n}" }, { "id": "multiplayer-CancelAllServerBackfillTicketsForPlayer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/CancelAllServerBackfillTicketsForPlayer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CancelAllServerBackfillTicketsForPlayer", "description": "Cancel all active backfill tickets the player is a member of in a given queue.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/cancelallserverbackfillticketsforplayer\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity key of the player whose backfill tickets should be canceled.\n\n\"QueueName\": The name of the queue from which a player's backfill tickets should be canceled.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Entity\": {\n \"Id\": \"123123123\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"QueueName\": \"custom123\"\n}" }, { "id": "multiplayer-CancelMatchmakingTicket", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/CancelMatchmakingTicket?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CancelMatchmakingTicket", "description": "Cancel a matchmaking ticket.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/cancelmatchmakingticket\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"QueueName\": The name of the queue the ticket is in.\n\n\"TicketId\": The Id of the ticket to find a match for.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"TicketId\": \"1c4b0daa-150e-47ae-9923-d770c0f9b07c\",\n \"QueueName\": \"custom123\"\n}" }, { "id": "multiplayer-CancelServerBackfillTicket", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/CancelServerBackfillTicket?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CancelServerBackfillTicket", "description": "Cancel a server backfill ticket.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/cancelserverbackfillticket\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"QueueName\": The name of the queue the ticket is in.\n\n\"TicketId\": The Id of the ticket to find a match for.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"TicketId\": \"1c4b0daa-150e-47ae-9923-d770c0f9b07c\",\n \"QueueName\": \"custom123\"\n}" }, { "id": "multiplayer-CreateBuildAlias", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/CreateBuildAlias?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateBuildAlias", "description": "Creates a multiplayer server build alias.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createbuildalias\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AliasName\": The alias name.\n\n\"BuildSelectionCriteria\": Array of build selection criteria.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"AliasName\": \"AliasName\",\n \"BuildSelectionCriteria\": [\n {\n \"BuildWeightDistribution\": {\n \"53781fa8-006d-4e9c-b733-57433d579285\": 1\n }\n }\n ]\n}" }, { "id": "multiplayer-CreateBuildWithCustomContainer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/CreateBuildWithCustomContainer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateBuildWithCustomContainer", "description": "Creates a multiplayer server build with a custom container.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createbuildwithcustomcontainer\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AreAssetsReadonly\": When true, assets will not be copied for each server inside the VM. All serverswill run from the same set of assets, or will have the same assets mounted in the container.\n\n\"BuildName\": The build name.\n\n\"ContainerFlavor\": The flavor of container to create a build from.\n\n\"ContainerImageReference\": The container reference, consisting of the image name and tag.\n\n\"ContainerRunCommand\": The container command to run when the multiplayer server has been allocated, including any arguments.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"GameAssetReferences\": The list of game assets related to the build.\n\n\"GameCertificateReferences\": The game certificates for the build.\n\n\"LinuxInstrumentationConfiguration\": The Linux instrumentation configuration for the build.\n\n\"Metadata\": Metadata to tag the build. The keys are case insensitive. The build metadata is made available to the server through Game Server SDK (GSDK).Constraints: Maximum number of keys: 30, Maximum key length: 50, Maximum value length: 100\n\n\"MonitoringApplicationConfiguration\": The configuration for the monitoring application on the build\n\n\"MultiplayerServerCountPerVm\": The number of multiplayer servers to host on a single VM.\n\n\"Ports\": The ports to map the build on.\n\n\"RegionConfigurations\": The region configurations for the build.\n\n\"ServerResourceConstraints\": The resource constraints to apply to each server on the VM (EXPERIMENTAL API)\n\n\"VmSize\": The VM size to create the build on.\n\n\"VmStartupScriptConfiguration\": The configuration for the VmStartupScript for the build\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"ContainerRunCommand\": \"/data/Assets -startserver\",\n \"GameAssetReferences\": [\n {\n \"FileName\": \"gameserver.zip\",\n \"MountPath\": \"/data/Assets\"\n }\n ],\n \"ContainerImageReference\": {\n \"ImageName\": \"ContainerImageName\",\n \"Tag\": \"ContainerTag\"\n },\n \"LinuxInstrumentationConfiguration\": {\n \"IsEnabled\": false\n },\n \"ContainerFlavor\": \"CustomLinux\",\n \"ServerResourceConstraints\": {\n \"CpuLimit\": 0.5,\n \"MemoryLimitGB\": 0.5\n },\n \"BuildName\": \"GameBuildName\",\n \"Metadata\": {\n \"MetadataKey\": \"MetadataValue\"\n },\n \"VmSize\": \"Standard_D2_v2\",\n \"MultiplayerServerCountPerVm\": 10,\n \"Ports\": [\n {\n \"Name\": \"PortName\",\n \"Num\": 1243,\n \"Protocol\": \"TCP\"\n }\n ],\n \"RegionConfigurations\": [\n {\n \"Region\": \"EastUs\",\n \"MaxServers\": 10,\n \"StandbyServers\": 5,\n \"ScheduledStandbySettings\": {\n \"IsEnabled\": true,\n \"ScheduleList\": [\n {\n \"StartTime\": \"2020-08-21T17:00:00Z\",\n \"EndTime\": \"2020-08-24T09:00:00Z\",\n \"IsRecurringWeekly\": true,\n \"IsDisabled\": false,\n \"Description\": \"Weekend Schedule\",\n \"TargetStandby\": 8\n },\n {\n \"StartTime\": \"2020-08-24T09:00:00Z\",\n \"EndTime\": \"2020-08-28T17:00:00Z\",\n \"IsRecurringWeekly\": true,\n \"IsDisabled\": false,\n \"Description\": \"Weekday Schedule\",\n \"TargetStandby\": 3\n }\n ]\n },\n \"RoutingSettings\": {\n \"NumberOfMicrosoftRoutingIPs\": 1,\n \"NumberOfInternetRoutingIPs\": 1,\n \"DefaultRoutingType\": 1\n }\n },\n {\n \"Region\": \"WestUs\",\n \"MaxServers\": 50,\n \"StandbyServers\": 8,\n \"ScheduledStandbySettings\": {\n \"IsEnabled\": true,\n \"ScheduleList\": [\n {\n \"StartTime\": \"2020-08-21T09:00:00Z\",\n \"EndTime\": \"2020-08-21T23:00:00Z\",\n \"IsRecurringWeekly\": false,\n \"IsDisabled\": false,\n \"Description\": \"Game Launch\",\n \"TargetStandby\": 30\n }\n ]\n }\n },\n {\n \"Region\": \"NorthEurope\",\n \"MaxServers\": 7,\n \"StandbyServers\": 3\n }\n ],\n \"GameCertificateReferences\": [\n {\n \"Name\": \"CertName\",\n \"GsdkAlias\": \"CertGsdkAlias\"\n }\n ],\n \"RoutingSettings\": {\n \"NumberOfMicrosoftRoutingIPs\": 1,\n \"NumberOfInternetRoutingIPs\": 0,\n \"DefaultRoutingType\": 0\n }\n}" }, { "id": "multiplayer-CreateBuildWithManagedContainer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/CreateBuildWithManagedContainer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateBuildWithManagedContainer", "description": "Creates a multiplayer server build with a managed container.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createbuildwithmanagedcontainer\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AreAssetsReadonly\": When true, assets will not be copied for each server inside the VM. All serverswill run from the same set of assets, or will have the same assets mounted in the container.\n\n\"BuildName\": The build name.\n\n\"ContainerFlavor\": The flavor of container to create a build from.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"GameAssetReferences\": The list of game assets related to the build.\n\n\"GameCertificateReferences\": The game certificates for the build.\n\n\"GameWorkingDirectory\": The directory containing the game executable. This would be the start path of the game assets that contain the main game server executable. If not provided, a best effort will be made to extract it from the start game command.\n\n\"InstrumentationConfiguration\": The instrumentation configuration for the build.\n\n\"Metadata\": Metadata to tag the build. The keys are case insensitive. The build metadata is made available to the server through Game Server SDK (GSDK).Constraints: Maximum number of keys: 30, Maximum key length: 50, Maximum value length: 100\n\n\"MonitoringApplicationConfiguration\": The configuration for the monitoring application on the build\n\n\"MultiplayerServerCountPerVm\": The number of multiplayer servers to host on a single VM.\n\n\"Ports\": The ports to map the build on.\n\n\"RegionConfigurations\": The region configurations for the build.\n\n\"ServerResourceConstraints\": The resource constraints to apply to each server on the VM (EXPERIMENTAL API)\n\n\"StartMultiplayerServerCommand\": The command to run when the multiplayer server is started, including any arguments.\n\n\"VmSize\": The VM size to create the build on.\n\n\"VmStartupScriptConfiguration\": The configuration for the VmStartupScript for the build\n\n\"WindowsCrashDumpConfiguration\": The crash dump configuration for the build.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"AreAssetsReadonly\": \"Boolean\",\n \"BuildName\": \"String\",\n \"ContainerFlavor\": \"String\",\n \"CustomTags\": \"String\",\n \"GameAssetReferences\": \"Object\",\n \"GameCertificateReferences\": \"Object\",\n \"GameWorkingDirectory\": \"String\",\n \"InstrumentationConfiguration\": \"Object\",\n \"Metadata\": \"String\",\n \"MonitoringApplicationConfiguration\": \"Object\",\n \"MultiplayerServerCountPerVm\": \"Number\",\n \"Ports\": \"Object\",\n \"RegionConfigurations\": \"Object\",\n \"ServerResourceConstraints\": \"Object\",\n \"StartMultiplayerServerCommand\": \"String\",\n \"VmSize\": \"String\",\n \"VmStartupScriptConfiguration\": \"Object\",\n \"WindowsCrashDumpConfiguration\": \"Object\"\n}" }, { "id": "multiplayer-CreateBuildWithProcessBasedServer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/CreateBuildWithProcessBasedServer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateBuildWithProcessBasedServer", "description": "Creates a multiplayer server build with the server running as a process.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createbuildwithprocessbasedserver\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AreAssetsReadonly\": When true, assets will not be copied for each server inside the VM. All serverswill run from the same set of assets, or will have the same assets mounted in the container.\n\n\"BuildName\": The build name.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"GameAssetReferences\": The list of game assets related to the build.\n\n\"GameCertificateReferences\": The game certificates for the build.\n\n\"GameWorkingDirectory\": The working directory for the game process. If this is not provided, the working directory will be set based on the mount path of the game server executable.\n\n\"InstrumentationConfiguration\": The instrumentation configuration for the build.\n\n\"IsOSPreview\": Indicates whether this build will be created using the OS Preview versionPreview OS is recommended for dev builds to detect any breaking changes before they are released to retail. Retail builds should set this value to false.\n\n\"Metadata\": Metadata to tag the build. The keys are case insensitive. The build metadata is made available to the server through Game Server SDK (GSDK).Constraints: Maximum number of keys: 30, Maximum key length: 50, Maximum value length: 100\n\n\"MonitoringApplicationConfiguration\": The configuration for the monitoring application on the build\n\n\"MultiplayerServerCountPerVm\": The number of multiplayer servers to host on a single VM.\n\n\"OsPlatform\": The OS platform used for running the game process.\n\n\"Ports\": The ports to map the build on.\n\n\"RegionConfigurations\": The region configurations for the build.\n\n\"StartMultiplayerServerCommand\": The command to run when the multiplayer server is started, including any arguments. The path to any executable should be relative to the root asset folder when unzipped.\n\n\"VmSize\": The VM size to create the build on.\n\n\"VmStartupScriptConfiguration\": The configuration for the VmStartupScript for the build\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"OsPlatform\": \"Windows\",\n \"GameAssetReferences\": [\n {\n \"FileName\": \"game.zip\"\n }\n ],\n \"StartMultiplayerServerCommand\": \"gameserver.exe -startserver\",\n \"InstrumentationConfiguration\": {\n \"ProcessesToMonitor\": [\n \"GameServerProcessName\"\n ],\n \"IsEnabled\": true\n },\n \"GameWorkingDirectory\": \"C:\\Assets\",\n \"IsOSPreview\": false,\n \"VmSize\": \"Standard_D2_v2\",\n \"MultiplayerServerCountPerVm\": 10,\n \"Ports\": [\n {\n \"Name\": \"PortName\",\n \"Num\": 1243,\n \"Protocol\": \"TCP\"\n }\n ],\n \"RegionConfigurations\": [\n {\n \"Region\": \"EastUs\",\n \"MaxServers\": 10,\n \"StandbyServers\": 5\n },\n {\n \"Region\": \"WestUs\",\n \"MaxServers\": 12,\n \"StandbyServers\": 8\n },\n {\n \"Region\": \"NorthEurope\",\n \"MaxServers\": 7,\n \"StandbyServers\": 3\n }\n ],\n \"GameCertificateReferences\": [\n {\n \"Name\": \"CertName\",\n \"GsdkAlias\": \"CertGsdkAlias\"\n }\n ]\n}" }, { "id": "multiplayer-CreateLobby", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/CreateLobby?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateLobby", "description": "Create a lobby.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/createlobby\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AccessPolicy\": The policy indicating who is allowed to join the lobby, and the visibility to queries. May be 'Public', 'Friends' or 'Private'. Public means the lobby is both visible in queries and any player may join, including invited players. Friends means that users who are bidirectional friends of members in the lobby may search to find friend lobbies, to retrieve its connection string. Private means the lobby is not visible in queries, and a player must receive an invitation to join. Defaults to 'Public' on creation. Can only be changed by the lobby owner.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"LobbyData\": The private key-value pairs which are visible to all entities in the lobby. At most 30 key-value pairs may be stored here, keys are limited to 30 characters and values to 1000. The total size of all lobbyData values may not exceed 4096 bytes. Keys are case sensitive.\n\n\"MaxPlayers\": The maximum number of players allowed in the lobby. The value must be between 2 and 128.\n\n\"Members\": The member initially added to the lobby. Client must specify exactly one member, which is the creator's entity and member data. Member PubSubConnectionHandle must be null or empty. Game servers must not specify any members.\n\n\"Owner\": The lobby owner. Must be the calling entity.\n\n\"OwnerMigrationPolicy\": The policy for how a new owner is chosen. May be 'Automatic', 'Manual' or 'None'. Can only be specified by clients. If client-owned and 'Automatic' - The Lobby service will automatically assign another connected owner when the current owner leaves or disconnects. The useConnections property must be true. If client - owned and 'Manual' - Ownership is protected as long as the current owner is connected. If the current owner leaves or disconnects any member may set themselves as the current owner. The useConnections property must be true. If client-owned and 'None' - Any member can set ownership. The useConnections property can be either true or false.\n\n\"SearchData\": The public key-value pairs which allow queries to differentiate between lobbies. Queries will refer to these key-value pairs in their filter and order by clauses to retrieve lobbies fitting the specified criteria. At most 30 key-value pairs may be stored here. Keys are of the format string_key1, string_key2 ... string_key30 for string values, or number_key1, number_key2, ... number_key30 for numeric values.Numeric values are floats. Values can be at most 256 characters long. The total size of all searchData values may not exceed 1024 bytes.\n\n\"UseConnections\": A setting to control whether connections are used. Defaults to true. When true, notifications are sent to subscribed players, disconnect detection removes connectionHandles, only owner migration policies using connections are allowed, and lobbies must have at least one connected member to be searchable or be a server hosted lobby with a connected server. If false, then notifications are not sent, connections are not allowed, and lobbies do not need connections to be searchable.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"MaxPlayers\": 50,\n \"Owner\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"OwnerMigrationPolicy\": \"Automatic\",\n \"UseConnections\": true,\n \"AccessPolicy\": \"Public\",\n \"SearchData\": {\n \"string_key1\": \"searchable value\"\n },\n \"LobbyData\": {\n \"MyGameKey\": \"MyGameKey value\"\n },\n \"Members\": [\n {\n \"MemberEntity\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n }\n ]\n}" }, { "id": "multiplayer-CreateMatchmakingTicket", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/CreateMatchmakingTicket?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateMatchmakingTicket", "description": "Create a matchmaking ticket as a client.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/creatematchmakingticket\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"Creator\": The User who created this ticket.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"GiveUpAfterSeconds\": How long to attempt matching this ticket in seconds.\n\n\"MembersToMatchWith\": A list of Entity Keys of other users to match with.\n\n\"QueueName\": The Id of a match queue.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Creator\": {},\n \"MembersToMatchWith\": [],\n \"GiveUpAfterSeconds\": 100,\n \"QueueName\": \"custom123\"\n}" }, { "id": "multiplayer-CreateRemoteUser", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/CreateRemoteUser?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateRemoteUser", "description": "Creates a remote user to log on to a VM for a multiplayer server build.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createremoteuser\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BuildId\": The guid string build ID of to create the remote user for.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExpirationTime\": The expiration time for the remote user created. Defaults to expiring in one day if not specified.\n\n\"Region\": The region of virtual machine to create the remote user for.\n\n\"Username\": The username to create the remote user with.\n\n\"VmId\": The virtual machine ID the multiplayer server is located on.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"Region\": \"SouthCentralUs\",\n \"VmId\": \"VmID1\",\n \"Username\": \"AUsername\",\n \"ExpirationTime\": \"2014-04-07T09:04:28Z\"\n}" }, { "id": "multiplayer-CreateServerBackfillTicket", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/CreateServerBackfillTicket?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateServerBackfillTicket", "description": "Create a backfill matchmaking ticket as a server. A backfill ticket represents an ongoing game. The matchmaking service automatically starts matching the backfill ticket against other matchmaking tickets. Backfill tickets cannot match with other backfill tickets.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/createserverbackfillticket\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"GiveUpAfterSeconds\": How long to attempt matching this ticket in seconds.\n\n\"Members\": The users who will be part of this ticket, along with their team assignments.\n\n\"QueueName\": The Id of a match queue.\n\n\"ServerDetails\": The details of the server the members are connected to.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Members\": [],\n \"GiveUpAfterSeconds\": 100,\n \"ServerDetails\": {\n \"IPV4Address\": \"10.250.24.54\",\n \"Ports\": [\n {\n \"Name\": \"PortName\",\n \"Num\": 1243,\n \"Protocol\": \"TCP\"\n }\n ],\n \"Region\": \"WestUS\",\n \"Fqdn\": \"vm.azure.cloudapp.net\"\n },\n \"QueueName\": \"custom123\"\n}" }, { "id": "multiplayer-CreateServerMatchmakingTicket", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/CreateServerMatchmakingTicket?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateServerMatchmakingTicket", "description": "Create a matchmaking ticket as a server. The matchmaking service automatically starts matching the ticket against other matchmaking tickets.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/createservermatchmakingticket\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"GiveUpAfterSeconds\": How long to attempt matching this ticket in seconds.\n\n\"Members\": The users who will be part of this ticket.\n\n\"QueueName\": The Id of a match queue.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Members\": [\n null\n ],\n \"GiveUpAfterSeconds\": 100,\n \"QueueName\": \"custom123\"\n}" }, { "id": "multiplayer-CreateTitleMultiplayerServersQuotaChange", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/CreateTitleMultiplayerServersQuotaChange?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "CreateTitleMultiplayerServersQuotaChange", "description": "Creates a request to change a title's multiplayer server quotas.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/createtitlemultiplayerserversquotachange\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ChangeDescription\": A brief description of the requested changes.\n\n\"Changes\": Changes to make to the titles cores quota.\n\n\"ContactEmail\": Email to be contacted by our team about this request. Only required when a request is not approved.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Notes\": Additional information about this request that our team can use to better understand the requirements.\n\n\"StartDate\": When these changes would need to be in effect. Only required when a request is not approved.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"ContactEmail\": \"john@mygamestudio.com\",\n \"StartDate\": \"2020-01-23T00:00:00Z\",\n \"ChangeDescription\": \"Season 3 Launch\",\n \"Notes\": \"Based on the last launch, we expect 1 trillion active users.\",\n \"Changes\": [\n {\n \"VmFamily\": \"Dv2\",\n \"Region\": \"EastUs\",\n \"NewCoreLimit\": 55000\n },\n {\n \"VmFamily\": \"Dv2\",\n \"Region\": \"NorthCentralUs\",\n \"NewCoreLimit\": 65000\n }\n ]\n}" }, { "id": "multiplayer-DeleteAsset", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/DeleteAsset?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteAsset", "description": "Deletes a multiplayer server game asset for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deleteasset\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"FileName\": The filename of the asset to delete.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"FileName\": \"gameserver.zip\"\n}" }, { "id": "multiplayer-DeleteBuild", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/DeleteBuild?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteBuild", "description": "Deletes a multiplayer server build.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletebuild\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BuildId\": The guid string build ID of the build to delete.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\"\n}" }, { "id": "multiplayer-DeleteBuildAlias", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/DeleteBuildAlias?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteBuildAlias", "description": "Deletes a multiplayer server build alias.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletebuildalias\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AliasId\": The guid string alias ID of the alias to perform the action on.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"AliasId\": \"21781fa8-096d-4d9c-b699-75433d579285\"\n}" }, { "id": "multiplayer-DeleteBuildRegion", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/DeleteBuildRegion?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteBuildRegion", "description": "Removes a multiplayer server build's region.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletebuildregion\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BuildId\": The guid string ID of the build we want to update regions for.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Region\": The build region to delete.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"Region\": \"JapanEast\"\n}" }, { "id": "multiplayer-DeleteCertificate", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/DeleteCertificate?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteCertificate", "description": "Deletes a multiplayer server game certificate.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletecertificate\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Name\": The name of the certificate.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Name\": \"GameCertificate1\"\n}" }, { "id": "multiplayer-DeleteContainerImageRepository", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/DeleteContainerImageRepository?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteContainerImageRepository", "description": "Deletes a container image repository.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deletecontainerimagerepository\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ImageName\": The container image repository we want to delete.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"ImageName\": \"imageName1\"\n}" }, { "id": "multiplayer-DeleteLobby", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/DeleteLobby?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteLobby", "description": "Delete a lobby.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/deletelobby\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"LobbyId\": The id of the lobby.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\n}" }, { "id": "multiplayer-DeleteRemoteUser", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/DeleteRemoteUser?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "DeleteRemoteUser", "description": "Deletes a remote user to log on to a VM for a multiplayer server build.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/deleteremoteuser\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BuildId\": The guid string build ID of the multiplayer server where the remote user is to delete.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Region\": The region of the multiplayer server where the remote user is to delete.\n\n\"Username\": The username of the remote user to delete.\n\n\"VmId\": The virtual machine ID the multiplayer server is located on.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"Region\": \"SouthCentralUs\",\n \"VmId\": \"VmID1\",\n \"Username\": \"AUsername\"\n}" }, { "id": "multiplayer-EnableMultiplayerServersForTitle", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/EnableMultiplayerServersForTitle?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "EnableMultiplayerServersForTitle", "description": "Enables the multiplayer server feature for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/enablemultiplayerserversfortitle\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{}" }, { "id": "multiplayer-FindFriendLobbies", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/FindFriendLobbies?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "FindFriendLobbies", "description": "Find lobbies which match certain criteria, and which friends are in.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/findfriendlobbies\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ExternalPlatformFriends\": Indicates which other platforms' friends this query should link to.\n\n\"Filter\": OData style string that contains one or more filters. Only the following operators are supported: \"and\" (logical and), \"eq\" (equal), \"ne\" (not equals), \"ge\" (greater than or equal), \"gt\" (greater than), \"le\" (less than or equal), and \"lt\" (less than). The left-hand side of each OData logical expression should be either a search property key (e.g. string_key1, number_key3, etc) or one of the pre-defined search keys all of which must be prefixed by \"lobby/\": lobby/memberCount (number of players in a lobby), lobby/maxMemberCount (maximum number of players allowed in a lobby), lobby/memberCountRemaining (remaining number of players who can be allowed in a lobby), lobby/membershipLock (must equal 'Unlocked' or 'Locked'), lobby/amOwner (required to equal \"true\"), lobby/amMember (required to equal \"true\").\n\n\"OrderBy\": OData style string that contains sorting for this query in either ascending (\"asc\") or descending (\"desc\") order. OrderBy clauses are of the form \"number_key1 asc\" or the pre-defined search key \"lobby/memberCount asc\", \"lobby/memberCountRemaining desc\" and \"lobby/maxMemberCount desc\". To sort by closest, a moniker `distance{number_key1 = 5}` can be used to sort by distance from the given number. This field only supports either one sort clause or one distance clause.\n\n\"Pagination\": Request pagination information.\n\n\"XboxToken\": Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Filter\": \"string_key1 eq 'Wizard' and number_key5 gt 5\",\n \"OrderBy\": \"number_key5 desc\",\n \"ExternalPlatformFriends\": \"Xbox\",\n \"XboxToken\": \"XBOXTOKEN\",\n \"Pagination\": {\n \"ContinuationToken\": \"\",\n \"PageSizeRequested\": 20\n }\n}" }, { "id": "multiplayer-FindLobbies", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/FindLobbies?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "FindLobbies", "description": "Find all the lobbies that match certain criteria.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/findlobbies\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Filter\": OData style string that contains one or more filters. Only the following operators are supported: \"and\" (logical and), \"eq\" (equal), \"ne\" (not equals), \"ge\" (greater than or equal), \"gt\" (greater than), \"le\" (less than or equal), and \"lt\" (less than). The left-hand side of each OData logical expression should be either a search property key (e.g. string_key1, number_key3, etc) or one of the pre-defined search keys all of which must be prefixed by \"lobby/\": lobby/memberCount (number of players in a lobby), lobby/maxMemberCount (maximum number of players allowed in a lobby), lobby/memberCountRemaining (remaining number of players who can be allowed in a lobby), lobby/membershipLock (must equal 'Unlocked' or 'Locked'), lobby/amOwner (required to equal \"true\"), lobby/amMember (required to equal \"true\").\n\n\"OrderBy\": OData style string that contains sorting for this query in either ascending (\"asc\") or descending (\"desc\") order. OrderBy clauses are of the form \"number_key1 asc\" or the pre-defined search key \"lobby/memberCount asc\", \"lobby/memberCountRemaining desc\" and \"lobby/maxMemberCount desc\". To sort by closest, a moniker `distance{number_key1 = 5}` can be used to sort by distance from the given number. This field only supports either one sort clause or one distance clause.\n\n\"Pagination\": Request pagination information.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Filter\": \"string_key1 eq 'Wizard' and number_key5 gt 5\",\n \"OrderBy\": \"number_key5 desc\",\n \"Pagination\": {\n \"ContinuationToken\": \"\",\n \"PageSizeRequested\": 20\n }\n}" }, { "id": "multiplayer-GetAssetDownloadUrl", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/GetAssetDownloadUrl?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetAssetDownloadUrl", "description": "Gets a URL that can be used to download the specified asset. A sample pre-authenticated url - https://sampleStorageAccount.blob.core.windows.net/gameassets/gameserver.zip?sv=2015-04-05&ss=b&srt=sco&sp=rw&st=startDate&se=endDate&spr=https&sig=sampleSig&api-version=2017-07-29\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getassetdownloadurl\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"FileName\": The asset's file name to get the download URL for.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"FileName\": \"gameserver.zip\"\n}" }, { "id": "multiplayer-GetAssetUploadUrl", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/GetAssetUploadUrl?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetAssetUploadUrl", "description": "Gets the URL to upload assets to. A sample pre-authenticated url - https://sampleStorageAccount.blob.core.windows.net/gameassets/gameserver.zip?sv=2015-04-05&ss=b&srt=sco&sp=rw&st=startDate&se=endDate&spr=https&sig=sampleSig&api-version=2017-07-29\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getassetuploadurl\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"FileName\": The asset's file name to get the upload URL for.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"FileName\": \"gameserver.zip\"\n}" }, { "id": "multiplayer-GetBuild", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/GetBuild?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetBuild", "description": "Gets a multiplayer server build.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getbuild\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BuildId\": The guid string build ID of the build to get.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"BuildId\": \"53781fa8-006d-4e9c-b733-57433d579285\"\n}" }, { "id": "multiplayer-GetBuildAlias", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/GetBuildAlias?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetBuildAlias", "description": "Gets a multiplayer server build alias.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getbuildalias\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AliasId\": The guid string alias ID of the alias to perform the action on.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"AliasId\": \"21781fa8-096d-4d9c-b699-75433d579285\"\n}" }, { "id": "multiplayer-GetContainerRegistryCredentials", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/GetContainerRegistryCredentials?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetContainerRegistryCredentials", "description": "Gets the credentials to the container registry.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getcontainerregistrycredentials\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{}" }, { "id": "multiplayer-GetLobby", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/GetLobby?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetLobby", "description": "Get a lobby.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/getlobby\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"LobbyId\": The id of the lobby.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\n}" }, { "id": "multiplayer-GetMatch", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/GetMatch?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetMatch", "description": "Get a match.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/getmatch\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EscapeObject\": Determines whether the matchmaking attributes will be returned as an escaped JSON string or as an un-escaped JSON object.\n\n\"MatchId\": The Id of a match.\n\n\"QueueName\": The name of the queue to join.\n\n\"ReturnMemberAttributes\": Determines whether the matchmaking attributes for each user should be returned in the response for match request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"MatchId\": \"4e0c5fd7-80e9-4744-b0ce-061a7f067ff5\",\n \"QueueName\": \"custom123\",\n \"EscapeObject\": false,\n \"ReturnMemberAttributes\": false\n}" }, { "id": "multiplayer-GetMatchmakingQueue", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/GetMatchmakingQueue?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetMatchmakingQueue", "description": "SDK support is limited to C# and Java for this API. Get a matchmaking queue configuration.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking-admin/getmatchmakingqueue\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"QueueName\": The Id of the matchmaking queue to retrieve.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"QueueName\": \"custom123\"\n}" }, { "id": "multiplayer-GetMatchmakingTicket", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/GetMatchmakingTicket?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetMatchmakingTicket", "description": "Get a matchmaking ticket by ticket Id.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/getmatchmakingticket\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EscapeObject\": Determines whether the matchmaking attributes will be returned as an escaped JSON string or as an un-escaped JSON object.\n\n\"QueueName\": The name of the queue to find a match for.\n\n\"TicketId\": The Id of the ticket to find a match for.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"TicketId\": \"1c4b0daa-150e-47ae-9923-d770c0f9b07c\",\n \"QueueName\": \"custom123\",\n \"EscapeObject\": false\n}" }, { "id": "multiplayer-GetMultiplayerServerDetails", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/GetMultiplayerServerDetails?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetMultiplayerServerDetails", "description": "Gets multiplayer server session details for a build.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getmultiplayerserverdetails\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"SessionId\": The title generated guid string session ID of the multiplayer server to get details for. This is to keep track of multiplayer server sessions.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"SessionId\": \"02bdef0e-e01e-4b29-8efe-ff9f47a06d8c\"\n}" }, { "id": "multiplayer-GetMultiplayerServerLogs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/GetMultiplayerServerLogs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetMultiplayerServerLogs", "description": "Gets multiplayer server logs after a server has terminated.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getmultiplayerserverlogs\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ServerId\": The server ID of multiplayer server to get logs for.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Region\": \"AustraliaEast\",\n \"ServerId\": \"SomeServerId\"\n}" }, { "id": "multiplayer-GetMultiplayerSessionLogsBySessionId", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/GetMultiplayerSessionLogsBySessionId?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetMultiplayerSessionLogsBySessionId", "description": "Gets multiplayer server logs after a server has terminated.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getmultiplayersessionlogsbysessionid\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"SessionId\": The server ID of multiplayer server to get logs for.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"SessionId\": \"92e29db9-4004-4349-9a1f-b70ac01bdc08\"\n}" }, { "id": "multiplayer-GetQueueStatistics", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/GetQueueStatistics?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetQueueStatistics", "description": "Get the statistics for a queue.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/getqueuestatistics\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"QueueName\": The name of the queue.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"QueueName\": \"custom123\"\n}" }, { "id": "multiplayer-GetRemoteLoginEndpoint", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/GetRemoteLoginEndpoint?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetRemoteLoginEndpoint", "description": "Gets a remote login endpoint to a VM that is hosting a multiplayer server build.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/getremoteloginendpoint\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BuildId\": The guid string build ID of the multiplayer server to get remote login information for.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Region\": The region of the multiplayer server to get remote login information for.\n\n\"VmId\": The virtual machine ID the multiplayer server is located on.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"Region\": \"SouthCentralUs\",\n \"VmId\": \"VmID1\"\n}" }, { "id": "multiplayer-GetServerBackfillTicket", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/GetServerBackfillTicket?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetServerBackfillTicket", "description": "Get a matchmaking backfill ticket by ticket Id.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/getserverbackfillticket\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EscapeObject\": Determines whether the matchmaking attributes will be returned as an escaped JSON string or as an un-escaped JSON object.\n\n\"QueueName\": The name of the queue to find a match for.\n\n\"TicketId\": The Id of the ticket to find a match for.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"TicketId\": \"1c4b0daa-150e-47ae-9923-d770c0f9b07c\",\n \"QueueName\": \"custom123\",\n \"EscapeObject\": false\n}" }, { "id": "multiplayer-GetTitleEnabledForMultiplayerServersStatus", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/GetTitleEnabledForMultiplayerServersStatus?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTitleEnabledForMultiplayerServersStatus", "description": "Gets the status of whether a title is enabled for the multiplayer server feature.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/gettitleenabledformultiplayerserversstatus\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{}" }, { "id": "multiplayer-GetTitleMultiplayerServersQuotaChange", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/GetTitleMultiplayerServersQuotaChange?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTitleMultiplayerServersQuotaChange", "description": "Gets a title's server quota change request.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/gettitlemultiplayerserversquotachange\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"RequestId\": Id of the change request to get.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"RequestId\": \"1234\"\n}" }, { "id": "multiplayer-GetTitleMultiplayerServersQuotas", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/GetTitleMultiplayerServersQuotas?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTitleMultiplayerServersQuotas", "description": "Gets the quotas for a title in relation to multiplayer servers.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/gettitlemultiplayerserversquotas\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{}" }, { "id": "multiplayer-InviteToLobby", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/InviteToLobby?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "InviteToLobby", "description": "Send a notification to invite a player to a lobby.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/invitetolobby\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"InviteeEntity\": The entity invited to the lobby.\n\n\"LobbyId\": The id of the lobby.\n\n\"MemberEntity\": The member entity sending the invite. Must be a member of the lobby.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\",\n \"MemberEntity\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"InviteeEntity\": {\n \"Id\": \"4321\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "multiplayer-JoinArrangedLobby", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/JoinArrangedLobby?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "JoinArrangedLobby", "description": "Join an Arranged lobby.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/joinarrangedlobby\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AccessPolicy\": The policy indicating who is allowed to join the lobby, and the visibility to queries. May be 'Public', 'Friends' or 'Private'. Public means the lobby is both visible in queries and any player may join, including invited players. Friends means that users who are bidirectional friends of members in the lobby may search to find friend lobbies, to retrieve its connection string. Private means the lobby is not visible in queries, and a player must receive an invitation to join. Defaults to 'Public' on creation. Can only be changed by the lobby owner.\n\n\"ArrangementString\": A field which indicates which lobby the user will be joining. This field is opaque to everyone except the Lobby service and the creator of the arrangementString (Matchmaking). This string defines a unique identifier for the arranged lobby as well as the title and member the string is valid for. Arrangement strings have an expiration.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"MaxPlayers\": The maximum number of players allowed in the lobby. The value must be between 2 and 128.\n\n\"MemberData\": The private key-value pairs used by the member to communicate information to other members and the owner. Visible to all entities in the lobby. At most 30 key-value pairs may be stored here, keys are limited to 30 characters and values to 1000. The total size of all memberData values may not exceed 4096 bytes. Keys are case sensitive.\n\n\"MemberEntity\": The member entity who is joining the lobby. The first member to join will be the lobby owner.\n\n\"OwnerMigrationPolicy\": The policy for how a new owner is chosen. May be 'Automatic', 'Manual' or 'None'. Can only be specified by clients. If client-owned and 'Automatic' - The Lobby service will automatically assign another connected owner when the current owner leaves or disconnects. The useConnections property must be true. If client - owned and 'Manual' - Ownership is protected as long as the current owner is connected. If the current owner leaves or disconnects any member may set themselves as the current owner. The useConnections property must be true. If client-owned and 'None' - Any member can set ownership. The useConnections property can be either true or false.\n\n\"UseConnections\": A setting to control whether connections are used. Defaults to true. When true, notifications are sent to subscribed players, disconnect detection removes connectionHandles, only owner migration policies using connections are allowed, and lobbies must have at least one connected member to be searchable or be a server hosted lobby with a connected server. If false, then notifications are not sent, connections are not allowed, and lobbies do not need connections to be searchable.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"MaxPlayers\": 50,\n \"OwnerMigrationPolicy\": \"Automatic\",\n \"UseConnections\": true,\n \"AccessPolicy\": \"Public\",\n \"MemberEntity\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"ArrangementString\": \"arrangementString\",\n \"MemberData\": {\n \"MyMemberKey\": \"MyMemberKey value\"\n }\n}" }, { "id": "multiplayer-JoinLobby", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/JoinLobby?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "JoinLobby", "description": "Join a lobby.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/joinlobby\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ConnectionString\": A field which indicates which lobby the user will be joining. This field is opaque to everyone except the Lobby service.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"MemberData\": The private key-value pairs used by the member to communicate information to other members and the owner. Visible to all entities in the lobby. At most 30 key-value pairs may be stored here, keys are limited to 30 characters and values to 1000. The total size of all memberData values may not exceed 4096 bytes.Keys are case sensitive.\n\n\"MemberEntity\": The member entity who is joining the lobby.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"MemberEntity\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"ConnectionString\": \"connString\",\n \"MemberData\": {\n \"MyDataKey\": \"MyDataKey value\"\n }\n}" }, { "id": "multiplayer-JoinLobbyAsServer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/JoinLobbyAsServer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "JoinLobbyAsServer", "description": "Preview: Join a lobby as a server entity. This is restricted to client lobbies which are using connections.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/joinlobbyasserver\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"ConnectionString\": A field which indicates which lobby the game_server will be joining. This field is opaque to everyone except the Lobby service.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ServerData\": The private key-value pairs which are visible to all entities in the lobby but can only be modified by the joined server.At most 30 key - value pairs may be stored here, keys are limited to 30 characters and values to 1000.The total size of all serverData values may not exceed 4096 bytes.\n\n\"ServerEntity\": The game_server entity which is joining the Lobby. If a different game_server entity has already joined the request will fail unless the joined entity is disconnected, in which case the incoming game_server entity will replace the disconnected entity.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"ServerEntity\": {\n \"Id\": \"1234\",\n \"Type\": \"game_server\",\n \"TypeString\": \"game_server\"\n },\n \"ConnectionString\": \"connString\",\n \"ServerData\": {\n \"MyDataKey\": \"MyDataKey value\"\n }\n}" }, { "id": "multiplayer-JoinMatchmakingTicket", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/JoinMatchmakingTicket?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "JoinMatchmakingTicket", "description": "Join a matchmaking ticket.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/joinmatchmakingticket\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Member\": The User who wants to join the ticket. Their Id must be listed in PlayFabIdsToMatchWith.\n\n\"QueueName\": The name of the queue to join.\n\n\"TicketId\": The Id of the ticket to find a match for.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"TicketId\": \"1c4b0daa-150e-47ae-9923-d770c0f9b07c\",\n \"QueueName\": \"custom123\",\n \"Member\": {}\n}" }, { "id": "multiplayer-LeaveLobby", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/LeaveLobby?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LeaveLobby", "description": "Leave a lobby.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/leavelobby\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"LobbyId\": The id of the lobby.\n\n\"MemberEntity\": The member entity leaving the lobby.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\",\n \"MemberEntity\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "multiplayer-LeaveLobbyAsServer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/LeaveLobbyAsServer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "LeaveLobbyAsServer", "description": "Preview: Request for server to leave a lobby. This is restricted to client owned lobbies which are using connections.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/leavelobbyasserver\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"LobbyId\": The id of the lobby.\n\n\"ServerEntity\": The game_server entity leaving the lobby. If the game_server was subscribed to notifications, it will be unsubscribed. If a the given game_server entity is not in the lobby, it will fail.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"ServerEntity\": {\n \"Id\": \"1234\",\n \"Type\": \"game_server\",\n \"TypeString\": \"game_server\"\n },\n \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\"\n}" }, { "id": "multiplayer-ListArchivedMultiplayerServers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/ListArchivedMultiplayerServers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListArchivedMultiplayerServers", "description": "Lists archived multiplayer server sessions for a build.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listarchivedmultiplayerservers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BuildId\": The guid string build ID of the multiplayer servers to list.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PageSize\": The page size for the request.\n\n\"Region\": The region the multiplayer servers to list.\n\n\"SkipToken\": The skip token for the paged request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"Region\": \"SouthCentralUs\"\n}" }, { "id": "multiplayer-ListAssetSummaries", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/ListAssetSummaries?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListAssetSummaries", "description": "Lists multiplayer server game assets for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listassetsummaries\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PageSize\": The page size for the request.\n\n\"SkipToken\": The skip token for the paged request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"PageSize\": 10\n}" }, { "id": "multiplayer-ListBuildAliases", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/ListBuildAliases?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListBuildAliases", "description": "Lists details of all build aliases for a title. Accepts tokens for title and if game client access is enabled, allows game client to request list of builds with player entity token.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listbuildaliases\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PageSize\": The page size for the request.\n\n\"SkipToken\": The skip token for the paged request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"PageSize\": 10\n}" }, { "id": "multiplayer-ListBuildSummariesV2", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/ListBuildSummariesV2?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListBuildSummariesV2", "description": "Lists summarized details of all multiplayer server builds for a title. Accepts tokens for title and if game client access is enabled, allows game client to request list of builds with player entity token.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listbuildsummariesv2\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PageSize\": The page size for the request.\n\n\"SkipToken\": The skip token for the paged request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"PageSize\": 10\n}" }, { "id": "multiplayer-ListCertificateSummaries", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/ListCertificateSummaries?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListCertificateSummaries", "description": "Lists multiplayer server game certificates for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listcertificatesummaries\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PageSize\": The page size for the request.\n\n\"SkipToken\": The skip token for the paged request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"PageSize\": 10\n}" }, { "id": "multiplayer-ListContainerImageTags", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/ListContainerImageTags?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListContainerImageTags", "description": "Lists the tags for a custom container image.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listcontainerimagetags\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ImageName\": The container images we want to list tags for.\n\n\"PageSize\": The page size for the request.\n\n\"SkipToken\": The skip token for the paged request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"ImageName\": \"imageName1\",\n \"PageSize\": 10\n}" }, { "id": "multiplayer-ListContainerImages", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/ListContainerImages?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListContainerImages", "description": "Lists custom container images for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listcontainerimages\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PageSize\": The page size for the request.\n\n\"SkipToken\": The skip token for the paged request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"PageSize\": 10\n}" }, { "id": "multiplayer-ListMatchmakingQueues", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/ListMatchmakingQueues?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListMatchmakingQueues", "description": "SDK support is limited to C# and Java for this API. List all matchmaking queue configs.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking-admin/listmatchmakingqueues\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{}" }, { "id": "multiplayer-ListMatchmakingTicketsForPlayer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/ListMatchmakingTicketsForPlayer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListMatchmakingTicketsForPlayer", "description": "List all matchmaking ticket Ids the user is a member of.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/listmatchmakingticketsforplayer\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity key for which to find the ticket Ids.\n\n\"QueueName\": The name of the queue to find a match for.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Entity\": {\n \"Id\": \"123123123\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"QueueName\": \"custom123\"\n}" }, { "id": "multiplayer-ListMultiplayerServers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/ListMultiplayerServers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListMultiplayerServers", "description": "Lists multiplayer server sessions for a build.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listmultiplayerservers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BuildId\": The guid string build ID of the multiplayer servers to list.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PageSize\": The page size for the request.\n\n\"Region\": The region the multiplayer servers to list.\n\n\"SkipToken\": The skip token for the paged request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"Region\": \"SouthCentralUs\"\n}" }, { "id": "multiplayer-ListPartyQosServers", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/ListPartyQosServers?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListPartyQosServers", "description": "Lists quality of service servers for party.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listpartyqosservers\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Version\": \"1.0.0\"\n}" }, { "id": "multiplayer-ListQosServersForTitle", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/ListQosServersForTitle?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListQosServersForTitle", "description": "Lists quality of service servers for the title. By default, servers are only returned for regions where a Multiplayer Servers build has been deployed.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listqosserversfortitle\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"IncludeAllRegions\": Indicates that the response should contain Qos servers for all regions, including those where there are no builds deployed for the title.\n\n\"RoutingPreference\": Indicates the Routing Preference used by the Qos servers. The default Routing Preference is Microsoft\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"IncludeAllRegions\": true,\n \"RoutingPreference\": \"Microsoft\"\n}" }, { "id": "multiplayer-ListServerBackfillTicketsForPlayer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/ListServerBackfillTicketsForPlayer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListServerBackfillTicketsForPlayer", "description": "List all server backfill ticket Ids the user is a member of.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/listserverbackfillticketsforplayer\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity key for which to find the ticket Ids.\n\n\"QueueName\": The name of the queue the tickets are in.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Entity\": {\n \"Id\": \"123123123\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"QueueName\": \"custom123\"\n}" }, { "id": "multiplayer-ListTitleMultiplayerServersQuotaChanges", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/ListTitleMultiplayerServersQuotaChanges?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListTitleMultiplayerServersQuotaChanges", "description": "List all server quota change requests for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listtitlemultiplayerserversquotachanges\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{}" }, { "id": "multiplayer-ListVirtualMachineSummaries", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/ListVirtualMachineSummaries?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ListVirtualMachineSummaries", "description": "Lists virtual machines for a title.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/listvirtualmachinesummaries\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BuildId\": The guid string build ID of the virtual machines to list.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"PageSize\": The page size for the request.\n\n\"Region\": The region of the virtual machines to list.\n\n\"SkipToken\": The skip token for the paged request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"Region\": \"SouthCentralUs\",\n \"PageSize\": 10\n}" }, { "id": "multiplayer-RemoveMatchmakingQueue", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/RemoveMatchmakingQueue?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemoveMatchmakingQueue", "description": "SDK support is limited to C# and Java for this API. Remove a matchmaking queue config.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking-admin/removematchmakingqueue\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"QueueName\": The Id of the matchmaking queue to remove.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"QueueName\": \"custom123\"\n}" }, { "id": "multiplayer-RemoveMember", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/RemoveMember?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RemoveMember", "description": "Remove a member from a lobby.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/removemember\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"LobbyId\": The id of the lobby.\n\n\"MemberEntity\": The member entity to be removed from the lobby.\n\n\"PreventRejoin\": If true, removed member can never rejoin this lobby.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\",\n \"MemberEntity\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"PreventRejoin\": false\n}" }, { "id": "multiplayer-RequestMultiplayerServer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/RequestMultiplayerServer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RequestMultiplayerServer", "description": "Request a multiplayer server session. Accepts tokens for title and if game client access is enabled, allows game client to request a server with player entity token.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/requestmultiplayerserver\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BuildAliasParams\": The identifiers of the build alias to use for the request.\n\n\"BuildId\": The guid string build ID of the multiplayer server to request.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"InitialPlayers\": Initial list of players (potentially matchmade) allowed to connect to the game. This list is passed to the game server when requested (via GSDK) and can be used to validate players connecting to it.\n\n\"PreferredRegions\": The preferred regions to request a multiplayer server from. The Multiplayer Service will iterate through the regions in the specified order and allocate a server from the first one that has servers available.\n\n\"SessionCookie\": Data encoded as a string that is passed to the game server when requested. This can be used to to communicate information such as game mode or map through the request flow.\n\n\"SessionId\": A guid string session ID created track the multiplayer server session over its life.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"SessionId\": \"02bdef0e-e01e-4b29-8efe-ff9f47a06d8c\",\n \"SessionCookie\": \"U2Vzc2lvbkNvb2tpZQ==\",\n \"InitialPlayers\": [\n \"gamer1\",\n \"gamer2\"\n ],\n \"PreferredRegions\": [\n \"SouthCentralUs\",\n \"WestUs\"\n ]\n}" }, { "id": "multiplayer-RequestPartyService", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Party/RequestPartyService?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RequestPartyService", "description": "Request a party session.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/requestpartyservice\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"NetworkConfiguration\": The network configuration for this request.\n\n\"PartyId\": A guid string party ID created track the party session over its life.\n\n\"PreferredRegions\": The preferred regions to request a party session from. The party service will iterate through the regions in the specified order and allocate a party session from the first one that is available.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"TitleId\": \"{{TitleId}}\",\n \"PartyId\": \"23781fa9-e01e-4b29-4f0b-dd9f37a06a1e\",\n \"PreferredRegions\": [\n \"EastUs\",\n \"WestUs\"\n ],\n \"NetworkConfiguration\": {\n \"MaxUsers\": 256,\n \"MaxDevices\": 32,\n \"MaxUsersPerDevice\": 8,\n \"MaxDevicesPerUser\": 32,\n \"MaxEndpointsPerDevice\": 32,\n \"DirectPeerConnectivityOptions\": \"None\",\n \"PartyInvitationConfiguration\": {\n \"Identifier\": \"f8b73a15-6ec2-48f8-b5fb-6c5946dc10be\",\n \"Revocability\": \"Anyone\",\n \"EntityKeys\": []\n }\n }\n}" }, { "id": "multiplayer-RolloverContainerRegistryCredentials", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/RolloverContainerRegistryCredentials?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "RolloverContainerRegistryCredentials", "description": "Rolls over the credentials to the container registry.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/rollovercontainerregistrycredentials\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{}" }, { "id": "multiplayer-SetMatchmakingQueue", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/SetMatchmakingQueue?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetMatchmakingQueue", "description": "SDK support is limited to C# and Java for this API. Create or update a matchmaking queue configuration.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking-admin/setmatchmakingqueue\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"MatchmakingQueue\": The matchmaking queue config.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"MatchmakingQueue\": {\n \"Name\": \"ExampleQueueName\",\n \"MinMatchSize\": 7,\n \"MaxMatchSize\": 8,\n \"MaxTicketSize\": 2,\n \"ServerAllocationEnabled\": true,\n \"BuildId\": \"065a3208-39af-4691-8794-5f774c367ac2\",\n \"DifferenceRules\": [\n {\n \"Difference\": 10,\n \"MergeFunction\": \"Average\",\n \"DefaultAttributeValue\": 0,\n \"LinearExpansion\": {\n \"Delta\": 0.5,\n \"Limit\": 20,\n \"SecondsBetweenExpansions\": 5\n },\n \"Attribute\": {\n \"Path\": \"ExampleAttributeDifference\",\n \"Source\": \"User\"\n },\n \"AttributeNotSpecifiedBehavior\": \"UseDefault\",\n \"Weight\": 1,\n \"Name\": \"ExampleNameDifference\",\n \"SecondsUntilOptional\": 50\n }\n ],\n \"StringEqualityRules\": [\n {\n \"DefaultAttributeValue\": \"ExampleDefault\",\n \"Expansion\": {\n \"EnabledOverrides\": [\n false,\n true,\n true,\n false\n ],\n \"SecondsBetweenExpansions\": 5\n },\n \"Attribute\": {\n \"Path\": \"ExampleAttributeStringEquality\",\n \"Source\": \"User\"\n },\n \"AttributeNotSpecifiedBehavior\": \"UseDefault\",\n \"Weight\": 1,\n \"Name\": \"ExampleNameStringEquality\",\n \"SecondsUntilOptional\": 50\n }\n ],\n \"MatchTotalRules\": [\n {\n \"Attribute\": {\n \"Path\": \"ExampleAttribute\",\n \"Source\": \"User\"\n },\n \"Min\": 2,\n \"Max\": 0,\n \"Weight\": 1,\n \"Expansion\": {\n \"MaxOverrides\": [\n {\n \"Value\": 4\n },\n {\n \"Value\": 4\n },\n null\n ],\n \"SecondsBetweenExpansions\": 5\n },\n \"Name\": \"MatchTotalRule\",\n \"SecondsUntilOptional\": 50\n }\n ],\n \"SetIntersectionRules\": [\n {\n \"DefaultAttributeValue\": [\n \"a\",\n \"b\",\n \"c\"\n ],\n \"MinIntersectionSize\": 2,\n \"LinearExpansion\": {\n \"Delta\": 2,\n \"SecondsBetweenExpansions\": 5\n },\n \"Attribute\": {\n \"Path\": \"ExampleAttributeSetIntersectionRule\",\n \"Source\": \"User\"\n },\n \"AttributeNotSpecifiedBehavior\": \"UseDefault\",\n \"Weight\": 1,\n \"Name\": \"ExampleNameSetIntersectionRule\",\n \"SecondsUntilOptional\": 50\n }\n ],\n \"RegionSelectionRule\": {\n \"MaxLatency\": 250,\n \"Path\": \"Latencies\",\n \"LinearExpansion\": {\n \"Delta\": 10,\n \"Limit\": 300,\n \"SecondsBetweenExpansions\": 5\n },\n \"Weight\": 1,\n \"Name\": \"RegionSelectionRule\",\n \"SecondsUntilOptional\": 50\n },\n \"TeamSizeBalanceRule\": {\n \"Difference\": 1,\n \"LinearExpansion\": {\n \"Delta\": 1,\n \"Limit\": 5,\n \"SecondsBetweenExpansions\": 5\n },\n \"Name\": \"TeamSizeBalanceRule\",\n \"SecondsUntilOptional\": 50\n },\n \"TeamDifferenceRules\": [\n {\n \"Attribute\": {\n \"Path\": \"ExampleAttribute\",\n \"Source\": \"User\"\n },\n \"Difference\": 2,\n \"DefaultAttributeValue\": 0,\n \"LinearExpansion\": {\n \"Delta\": 1,\n \"Limit\": 5,\n \"SecondsBetweenExpansions\": 5\n },\n \"Name\": \"TeamDifferenceRule\",\n \"SecondsUntilOptional\": 50\n }\n ],\n \"TeamTicketSizeSimilarityRule\": {\n \"Name\": \"TeamTicketSizeSimilarityRule\",\n \"SecondsUntilOptional\": 180\n },\n \"Teams\": [\n {\n \"Name\": \"monster\",\n \"MinTeamSize\": 1,\n \"MaxTeamSize\": 1\n },\n {\n \"Name\": \"hunters\",\n \"MinTeamSize\": 4,\n \"MaxTeamSize\": 8\n }\n ],\n \"StatisticsVisibilityToPlayers\": {\n \"ShowNumberOfPlayersMatching\": true,\n \"ShowTimeToMatch\": true\n }\n }\n}" }, { "id": "multiplayer-ShutdownMultiplayerServer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/ShutdownMultiplayerServer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "ShutdownMultiplayerServer", "description": "Shuts down a multiplayer server session.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/shutdownmultiplayerserver\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"SessionId\": A guid string session ID of the multiplayer server to shut down.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Region\": \"AustraliaEast\",\n \"SessionId\": \"02bdef0e-e01e-4b29-8efe-ff9f47a06d8c\"\n}" }, { "id": "multiplayer-SubscribeToLobbyResource", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/SubscribeToLobbyResource?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SubscribeToLobbyResource", "description": "Subscribe to lobby resource notifications.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/subscribetolobbyresource\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EntityKey\": The entity performing the subscription.\n\n\"PubSubConnectionHandle\": Opaque string, given to a client upon creating a connection with PubSub.\n\n\"ResourceId\": The name of the resource to subscribe to.\n\n\"SubscriptionVersion\": Version number for the subscription of this resource.\n\n\"Type\": Subscription type.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Type\": \"LobbyChange\",\n \"ResourceId\": \"5c905725-0184-4112-a563-2f4187710d06\",\n \"SubscriptionVersion\": 1,\n \"PubSubConnectionHandle\": \"PubSubConnection\",\n \"EntityKey\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "multiplayer-SubscribeToMatchmakingResource", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/SubscribeToMatchmakingResource?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SubscribeToMatchmakingResource", "description": "Subscribe to match resource notifications.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/subscribetomatchmakingresource\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EntityKey\": The entity performing the subscription. The entity must be authorized to use this connectionHandle.\n\n\"PubSubConnectionHandle\": Opaque string, given to a client upon creating a connection with PubSub. Notifications will be sent to the connection associated with this handle.\n\n\"ResourceId\": The name of the resource to subscribe to. It follows the format {queueName}|{ticketId} for MatchTicketStatusChange. For MatchInvite, ResourceId is @me.\n\n\"SubscriptionVersion\": Version number for the subscription of this resource. Current supported version must be 1.\n\n\"Type\": Subscription type. MatchInvite subscriptions are per-player. MatchTicketStatusChange subscriptions are per-ticket. Subscribe calls are idempotent. Subscribing on the same resource for the same connection results in success.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Type\": \"MatchTicketStatusChange\",\n \"ResourceId\": \"5a58afee-a9d7-4a47-875b-48bae4dc0590\",\n \"SubscriptionVersion\": 1,\n \"PubSubConnectionHandle\": \"PubSubConnection\",\n \"EntityKey\": {}\n}" }, { "id": "multiplayer-UnsubscribeFromLobbyResource", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/UnsubscribeFromLobbyResource?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnsubscribeFromLobbyResource", "description": "Unsubscribe from lobby notifications.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/unsubscribefromlobbyresource\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EntityKey\": The entity which performed the subscription.\n\n\"PubSubConnectionHandle\": Opaque string, given to a client upon creating a connection with PubSub.\n\n\"ResourceId\": The name of the resource to unsubscribe from.\n\n\"SubscriptionVersion\": Version number passed for the subscription of this resource.\n\n\"Type\": Subscription type.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Type\": \"LobbyChange\",\n \"ResourceId\": \"5c905725-0184-4112-a563-2f4187710d06\",\n \"SubscriptionVersion\": 1,\n \"PubSubConnectionHandle\": \"PubSubConnection\",\n \"EntityKey\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "multiplayer-UnsubscribeFromMatchmakingResource", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Match/UnsubscribeFromMatchmakingResource?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UnsubscribeFromMatchmakingResource", "description": "Unsubscribe from match resource notifications.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/matchmaking/unsubscribefrommatchmakingresource\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"EntityKey\": The entity performing the unsubscription. The entity must be authorized to use this connectionHandle.\n\n\"PubSubConnectionHandle\": Opaque string, given to a client upon creating a connection with PubSub.\n\n\"ResourceId\": The name of the resource to unsubscribe from. It follows the format {queueName}|{ticketId} for MatchTicketStatusChange. For MatchInvite, ResourceId is @me.\n\n\"SubscriptionVersion\": Version number for the unsubscription from this resource.\n\n\"Type\": Type of the subscription to be canceled.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"Type\": \"MatchTicketStatusChange\",\n \"ResourceId\": \"5a58afee-a9d7-4a47-875b-48bae4dc0590\",\n \"SubscriptionVersion\": 1,\n \"PubSubConnectionHandle\": \"PubSubConnection\",\n \"EntityKey\": {}\n}" }, { "id": "multiplayer-UntagContainerImage", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/UntagContainerImage?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UntagContainerImage", "description": "Untags a container image.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/untagcontainerimage\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ImageName\": The container image which tag we want to remove.\n\n\"Tag\": The tag we want to remove.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"ImageName\": \"imageName1\",\n \"Tag\": \"tag1\"\n}" }, { "id": "multiplayer-UpdateBuildAlias", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/UpdateBuildAlias?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateBuildAlias", "description": "Creates a multiplayer server build alias.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/updatebuildalias\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AliasId\": The guid string alias Id of the alias to be updated.\n\n\"AliasName\": The alias name.\n\n\"BuildSelectionCriteria\": Array of build selection criteria.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"AliasName\": \"AliasName\",\n \"BuildSelectionCriteria\": [\n {\n \"BuildWeightDistribution\": {\n \"53781fa8-006d-4e9c-b733-57433d579285\": 1\n }\n }\n ],\n \"AliasId\": \"21781fa8-096d-4d9c-b699-75433d579285\"\n}" }, { "id": "multiplayer-UpdateBuildName", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/UpdateBuildName?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateBuildName", "description": "Updates a multiplayer server build's name.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/updatebuildname\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BuildId\": The guid string ID of the build we want to update the name of.\n\n\"BuildName\": The build name.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"BuildName\": \"GameBuildName\"\n}" }, { "id": "multiplayer-UpdateBuildRegion", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/UpdateBuildRegion?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateBuildRegion", "description": "Updates a multiplayer server build's region. If the region is not yet created, it will be created\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/updatebuildregion\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BuildId\": The guid string ID of the build we want to update regions for.\n\n\"BuildRegion\": The updated region configuration that should be applied to the specified build.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"BuildRegion\": {\n \"Region\": \"NorthEurope\",\n \"MaxServers\": 7,\n \"StandbyServers\": 3\n }\n}" }, { "id": "multiplayer-UpdateBuildRegions", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/UpdateBuildRegions?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateBuildRegions", "description": "Updates a multiplayer server build's regions.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/updatebuildregions\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"BuildId\": The guid string ID of the build we want to update regions for.\n\n\"BuildRegions\": The updated region configuration that should be applied to the specified build.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"BuildId\": \"21781fa8-096d-4d9c-b699-75433d579285\",\n \"BuildRegions\": [\n {\n \"Region\": \"EastUs\",\n \"MaxServers\": 10,\n \"StandbyServers\": 5\n },\n {\n \"Region\": \"WestUs\",\n \"MaxServers\": 12,\n \"StandbyServers\": 8\n },\n {\n \"Region\": \"NorthEurope\",\n \"MaxServers\": 7,\n \"StandbyServers\": 3\n }\n ]\n}" }, { "id": "multiplayer-UpdateLobby", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/UpdateLobby?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateLobby", "description": "Update a lobby.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/updatelobby\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"AccessPolicy\": The policy indicating who is allowed to join the lobby, and the visibility to queries. May be 'Public', 'Friends' or 'Private'. Public means the lobby is both visible in queries and any player may join, including invited players. Friends means that users who are bidirectional friends of members in the lobby may search to find friend lobbies, to retrieve its connection string. Private means the lobby is not visible in queries, and a player must receive an invitation to join. Defaults to 'Public' on creation. Can only be changed by the lobby owner.\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"LobbyData\": The private key-value pairs which are visible to all entities in the lobby. Optional. Sets or updates key-value pairs on the lobby. Only the current lobby owner can set lobby data. Keys may be an arbitrary string of at most 30 characters. The total size of all lobbyData values may not exceed 4096 bytes. Values are not individually limited. There can be up to 30 key-value pairs stored here. Keys are case sensitive.\n\n\"LobbyDataToDelete\": The keys to delete from the lobby LobbyData. Optional. Behaves similar to searchDataToDelete, but applies to lobbyData.\n\n\"LobbyId\": The id of the lobby.\n\n\"MaxPlayers\": The maximum number of players allowed in the lobby. Updates the maximum allowed number of players in the lobby. Only the current lobby owner can set this. If set, the value must be greater than or equal to the number of members currently in the lobby.\n\n\"MemberData\": The private key-value pairs used by the member to communicate information to other members and the owner. Optional. Sets or updates new key-value pairs on the caller's member data. New keys will be added with their values and existing keys will be updated with the new values. Visible to all entities in the lobby. At most 30 key-value pairs may be stored here, keys are limited to 30 characters and values to 1000. The total size of all memberData values may not exceed 4096 bytes. Keys are case sensitive. Servers cannot specifiy this.\n\n\"MemberDataToDelete\": The keys to delete from the lobby MemberData. Optional. Deletes key-value pairs on the caller's member data. All the specified keys will be removed from the caller's member data. Keys that do not exist are a no-op. If the key to delete exists in the memberData (same request) it will result in a bad request. Servers cannot specifiy this.\n\n\"MemberEntity\": The member entity whose data is being modified. Servers cannot specify this.\n\n\"MembershipLock\": A setting indicating whether the lobby is locked. May be 'Unlocked' or 'Locked'. When Locked new members are not allowed to join. Defaults to 'Unlocked' on creation. Can only be changed by the lobby owner.\n\n\"Owner\": The lobby owner. Optional. Set to transfer ownership of the lobby. If client - owned and 'Automatic' - The Lobby service will automatically assign another connected owner when the current owner leaves or disconnects. useConnections must be true. If client - owned and 'Manual' - Ownership is protected as long as the current owner is connected. If the current owner leaves or disconnects any member may set themselves as the current owner. The useConnections property must be true. If client-owned and 'None' - Any member can set ownership. The useConnections property can be either true or false. For all client-owned lobbies when the owner leaves and a new owner can not be automatically selected - The owner field is set to null. For all client-owned lobbies when the owner disconnects and a new owner can not be automatically selected - The owner field remains unchanged and the current owner retains all owner abilities for the lobby. If server-owned (must be 'Server') - Any server can set ownership. The useConnections property must be true.\n\n\"SearchData\": The public key-value pairs which allow queries to differentiate between lobbies. Optional. Sets or updates key-value pairs on the lobby for use with queries. Only the current lobby owner can set search data. New keys will be added with their values and existing keys will be updated with the new values. There can be up to 30 key-value pairs stored here. Keys are of the format string_key1, string_key2... string_key30 for string values, or number_key1, number_key2, ... number_key30 for numeric values. Numeric values are floats. Values can be at most 256 characters long. The total size of all searchData values may not exceed 1024 bytes.Keys are case sensitive.\n\n\"SearchDataToDelete\": The keys to delete from the lobby SearchData. Optional. Deletes key-value pairs on the lobby. Only the current lobby owner can delete search data. All the specified keys will be removed from the search data. Keys that do not exist in the lobby are a no-op.If the key to delete exists in the searchData (same request) it will result in a bad request.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\",\n \"MaxPlayers\": 50,\n \"AccessPolicy\": \"Friends\",\n \"MembershipLock\": \"Locked\",\n \"SearchData\": {\n \"string_key1\": \"searchable value\"\n },\n \"LobbyData\": {\n \"MyGameKey\": \"MyGameKey value\"\n },\n \"MemberEntity\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n \"MemberData\": {\n \"MyDataKey\": \"MyDataKey updated value\"\n },\n \"SearchDataToDelete\": [\n \"number_key1\"\n ],\n \"LobbyDataToDelete\": [\n \"MyOldGameKey\"\n ],\n \"MemberDataToDelete\": []\n}" }, { "id": "multiplayer-UpdateLobbyAsServer", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Lobby/UpdateLobbyAsServer?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UpdateLobbyAsServer", "description": "Preview: Update fields related to a joined server in the lobby the server is in. Servers can keep a lobby from expiring by being the one to \"update\" the lobby in some way. Servers have no impact on last member leave/last member disconnect behavior.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/lobby/updatelobbyasserver\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"LobbyId\": The id of the lobby.\n\n\"ServerData\": The private key-value pairs which are visible to all entities in the lobby and modifiable by the joined server. Optional. Sets or updates key-value pairs on the lobby. Only the current lobby lobby server can set serverData. Keys may be an arbitrary string of at most 30 characters. The total size of all serverData values may not exceed 4096 bytes. Values are not individually limited. There can be up to 30 key-value pairs stored here. Keys are case sensitive.\n\n\"ServerDataToDelete\": The keys to delete from the lobby serverData. Optional. Optional. Deletes key-value pairs on the lobby. Only the current joined lobby server can delete serverData. All the specified keys will be removed from the serverData. Keys that do not exist in the lobby are a no-op. If the key to delete exists in the serverData (same request) it will result in a bad request.\n\n\"ServerEntity\": The lobby server. Optional. Set a different server as the joined server of the lobby (there can only be 1 joined server). When changing the server the previous server will automatically be unsubscribed.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"LobbyId\": \"12345678-1234-1234-1234-123456789ABC\",\n \"ServerEntity\": {\n \"Id\": \"1234\",\n \"Type\": \"game_server\",\n \"TypeString\": \"game_server\"\n },\n \"ServerData\": {\n \"MyDataKey\": \"MyDataKey value\"\n },\n \"ServerDataToDelete\": [\n \"MyOldGameKey\"\n ]\n}" }, { "id": "multiplayer-UploadCertificate", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/MultiplayerServer/UploadCertificate?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "UploadCertificate", "description": "Uploads a multiplayer server game certificate.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/multiplayer/multiplayerserver/uploadcertificate\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"ForceUpdate\": Forces the certificate renewal if the certificate already exists. Default is false\n\n\"GameCertificate\": The game certificate to upload.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-multiplayerFolder", "rawModeData": "{\n \"GameCertificate\": {\n \"Name\": \"GameCertificate1\",\n \"Base64EncodedValue\": \"UGxheUZhYlJvY2tzISEhTGV0J3NtYWtlYWxvdG9mZ2FtZXMh\",\n \"Password\": \"PasswordForPFXCertificate\"\n },\n \"ForceUpdate\": false\n}" }, { "id": "profiles-GetGlobalPolicy", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Profile/GetGlobalPolicy?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetGlobalPolicy", "description": "Gets the global title access policy \n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/profiles/account-management/getglobalpolicy\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-profilesFolder", "rawModeData": "{}" }, { "id": "profiles-GetProfile", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Profile/GetProfile?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetProfile", "description": "Retrieves the entity's profile.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/profiles/account-management/getprofile\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"DataAsObject\": Determines whether the objects will be returned as an escaped JSON string or as a un-escaped JSON object. Default is JSON string.\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-profilesFolder", "rawModeData": "{\n \"Entity\": {\n \"Id\": \"1234567787392\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "profiles-GetProfiles", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Profile/GetProfiles?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetProfiles", "description": "Retrieves the entity's profile.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/profiles/account-management/getprofiles\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"DataAsObject\": Determines whether the objects will be returned as an escaped JSON string or as a un-escaped JSON object. Default is JSON string.\n\n\"Entities\": Entity keys of the profiles to load. Must be between 1 and 25\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-profilesFolder", "rawModeData": "{\n \"Entities\": [\n {\n \"Id\": \"1234567787392\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n },\n {\n \"Id\": \"42434567785265\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n ]\n}" }, { "id": "profiles-GetTitlePlayersFromMasterPlayerAccountIds", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Profile/GetTitlePlayersFromMasterPlayerAccountIds?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTitlePlayersFromMasterPlayerAccountIds", "description": "Retrieves the title player accounts associated with the given master player account.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/profiles/account-management/gettitleplayersfrommasterplayeraccountids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"MasterPlayerAccountIds\": Master player account ids.\n\n\"TitleId\": Id of title to get players from.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-profilesFolder", "rawModeData": "{\n \"MasterPlayerAccountIds\": [\n \"1233455677\"\n ],\n \"TitleId\": \"{{TitleId}}\"\n}" }, { "id": "profiles-GetTitlePlayersFromXboxLiveIDs", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Profile/GetTitlePlayersFromXboxLiveIDs?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "GetTitlePlayersFromXboxLiveIDs", "description": "Retrieves the title player accounts associated with the given XUIDs.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/profiles/account-management/gettitleplayersfromxboxliveids\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Sandbox\": Xbox Sandbox the players had on their Xbox tokens.\n\n\"TitleId\": Optional ID of title to get players from, required if calling using a master_player_account.\n\n\"XboxLiveIds\": List of Xbox Live XUIDs\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-profilesFolder", "rawModeData": "{\n \"XboxLiveIds\": [\n \"1233455677\"\n ],\n \"Sandbox\": \"RETAIL\"\n}" }, { "id": "profiles-SetGlobalPolicy", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Profile/SetGlobalPolicy?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetGlobalPolicy", "description": "Sets the global title access policy \n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/profiles/account-management/setglobalpolicy\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Permissions\": The permissions that govern access to all entities under this title or namespace.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-profilesFolder", "rawModeData": "{\n \"Permissions\": [\n {\n \"Resource\": \"pfrn:data--title_player_account!90901000/Profile/SomethingCool\",\n \"Action\": \"*\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"ChildOf\": {\n \"EntityType\": \"[SELF]\"\n }\n },\n \"Comment\": \"An example policy\"\n }\n ]\n}" }, { "id": "profiles-SetProfileLanguage", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Profile/SetProfileLanguage?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetProfileLanguage", "description": "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.\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/profiles/account-management/setprofilelanguage\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The optional entity to perform this action on. Defaults to the currently logged in entity.\n\n\"ExpectedVersion\": The expected version of a profile to perform this update on\n\n\"Language\": The language to set on the given entity. Deletes the profile's language if passed in a null string.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-profilesFolder", "rawModeData": "{\n \"Language\": \"en\",\n \"ExpectedVersion\": 123,\n \"Entity\": {\n \"Id\": \"1234\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" }, { "id": "profiles-SetProfilePolicy", "headers": "X-PlayFabSDK: PostmanCollection-0.207.240412\nContent-Type: application/json\nX-EntityToken: {{EntityToken}}\n", "url": "https://{{TitleId}}.playfabapi.com/Profile/SetProfilePolicy?sdk=PostmanCollection-0.207.240412", "method": "POST", "collectionId": "PlayFabPostmanSDK", "dataMode": "raw", "name": "SetProfilePolicy", "description": "Sets the profiles access policy\n\nApi Documentation: https://docs.microsoft.com/rest/api/playfab/profiles/account-management/setprofilepolicy\n\n**The following case-sensitive environment variables are required for this call:**\n\n\"TitleId\" - The Title Id of your game, available in the Game Manager (https://developer.playfab.com)\n\n\"EntityToken\" - The string returned as \"EntityToken.EntityToken\" in response to any Login method.\n\n**The body of this api-call should be proper json-format. The api-body accepts the following case-sensitive parameters:**\n\n\"CustomTags\": The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).\n\n\"Entity\": The entity to perform this action on.\n\n\"Statements\": The statements to include in the access policy.\n\nTo set up an Environment, click the text next to the eye icon up top in Postman (it should say \"No environment\", if this is your first time using Postman). Select \"Manage environments\", then \"Add\". Type a name for your environment where it says \"New environment\", then enter each variable name above as the \"Key\", with the value as defined for each above.", "descriptionFormat": "html", "currentHelper": "normal", "folder": "PlayFabPostmanSDK-profilesFolder", "rawModeData": "{\n \"Statements\": [\n {\n \"Resource\": \"pfrn:data--*!*/Profile/Files/avatar.png\",\n \"Action\": \"Read\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"FriendOf\": \"true\"\n },\n \"Comment\": \"Allow my friends to read my avatar\"\n }\n ],\n \"Entity\": {\n \"Id\": \"90901000\",\n \"Type\": \"title_player_account\",\n \"TypeString\": \"title_player_account\"\n }\n}" } ] }