Skip to content
RallyHere Docs
Search
Cancel
GitHub
Select theme
Dark
Light
Auto
Introduction
Developer Portal
Legacy Support Tool
Organizations, Products, and Sandboxes
Integration
Integration Layers
Game Host Adapter
Session Basics
Sessions / Game Flow Overview
Unofficial Engines and Languages
Unreal Integration
RallyHere Unreal Integration Overview
Extending Subsystems to Customize Integration
Recommended Engine Changes
RallyHere Unreal Integration QuickStart Guide
Unreal Sessions Integration
Unreal Plugin Reference
Ads
Catalog
Common
Config
Diagnostics
Entitlement
Friends
GameInstance
IntegrationBase
IntegrationSettings
Inventory
LocalPlayer
MatchmakingBrowser
Notifications
PlayerInfo
Polling
Purge
Session
SubsystemBase
WebRequest
models
RHAPI_AdditionalJoinParams
RHAPI_AdOpportunities
RHAPI_AdOpportunity
RHAPI_AgreementMessage
RHAPI_AppSetting
RHAPI_BaseModel
RHAPI_BlockedList
RHAPI_BlockedListV1
RHAPI_BlockedPlayer
RHAPI_BlockedPlayerV1
RHAPI_BodyBeginNewSession
RHAPI_BodyFindOpportunities
RHAPI_BodyUpdateOpportunityById
RHAPI_BrowserInfo
RHAPI_BrowserResponse
RHAPI_BrowserSessionInfo
RHAPI_CacheInfo
RHAPI_Catalog
RHAPI_ClaimKeyRequest
RHAPI_ClientSettings
RHAPI_ClientVisibleSettings
RHAPI_ConnectionInfo
RHAPI_CreateInventoryRequest
RHAPI_CreateInventoryRequests
RHAPI_CreateOrJoinRequest
RHAPI_Cross-playPreferences
RHAPI_DiscoveryResponse
RHAPI_FriendRelationship
RHAPI_FriendRelationshipV1
RHAPI_Friends
RHAPI_FriendsApiConfig
RHAPI_FriendsList
RHAPI_FriendsListV1
RHAPI_FriendsV1
RHAPI_HTTPAuthorizationCredentials
RHAPI_HTTPValidationError
RHAPI_HzApiErrorModel
RHAPI_InstanceFubar
RHAPI_InstanceInfo
RHAPI_InstanceInfoUpdate
RHAPI_InstanceLaunchTemplate
RHAPI_InstanceRequest
RHAPI_InstanceRequestTemplate
RHAPI_InstanceStartupParams
RHAPI_Inventory
RHAPI_InventoryBucketUseRuleSet
RHAPI_InventoryBucketUseRuleSets
RHAPI_InventoryContextResponse
RHAPI_InventoryPageMeta
RHAPI_InventoryRecord
RHAPI_InventorySession
RHAPI_InventorySessionCreateRequest
RHAPI_InventorySessionCreateResponse
RHAPI_Item
RHAPI_ItemInventory
RHAPI_Items
RHAPI_JoinParams
RHAPI_KeyClaim
RHAPI_KeyClaims
RHAPI_KeyType
RHAPI_KVsResponse
RHAPI_LocationInner
RHAPI_LoginRequestV1
RHAPI_LoginResult
RHAPI_LogoutRequest
RHAPI_LookupResults
RHAPI_Loot
RHAPI_Loots
RHAPI_MapConfig
RHAPI_MapConfigV2
RHAPI_MapSelectionList
RHAPI_MapSelectionListV2
RHAPI_MarketingCampaign
RHAPI_MarketingCampaigns
RHAPI_MatchCreateRequest
RHAPI_MatchCreateResponse
RHAPI_MatchInfo
RHAPI_MatchmakingInfo
RHAPI_MatchMakingProfile
RHAPI_MatchMakingProfileV2
RHAPI_MatchMakingRuleset
RHAPI_MatchMakingSessionRequest
RHAPI_MatchMakingTemplate
RHAPI_MatchMakingTemplateGroup
RHAPI_MatchMakingTemplateGroupV2
RHAPI_MatchMakingTemplateV2
RHAPI_MessageOnly
RHAPI_Notes
RHAPI_Notification
RHAPI_NotificationCreate
RHAPI_NotificationCreateResult
RHAPI_NotificationCreates
RHAPI_Notifications
RHAPI_OAuthTokenExchange
RHAPI_OAuthTokenResponse
RHAPI_PageMeta
RHAPI_PersonEmailListRequest
RHAPI_PersonEmailListResponse
RHAPI_PersonInfoResponse
RHAPI_PlatformEntitlement
RHAPI_PlatformEntitlementProcessRequest
RHAPI_PlatformEntitlementProcessResult
RHAPI_PlatformIdentityLookupResults
RHAPI_PlatformSession
RHAPI_PlatformSessionPlayer
RHAPI_PlatformSessionTemplate
RHAPI_PlayerIdWrapper
RHAPI_PlayerInventoryChange
RHAPI_PlayerIterateResponse
RHAPI_PlayerLastSeenUpdate
RHAPI_PlayerLinkedPortalsResponse
RHAPI_PlayerOrder
RHAPI_PlayerOrderCreate
RHAPI_PlayerOrderDetail
RHAPI_PlayerOrderEntry
RHAPI_PlayerOrderEntryCreate
RHAPI_PlayerOrdersResponse
RHAPI_PlayerPersonResponse
RHAPI_PlayerPresence
RHAPI_PlayerPresenceUpdateSelf
RHAPI_PlayerRankRequestResponse
RHAPI_PlayerRankResponse
RHAPI_PlayerRankUpdateRequest
RHAPI_PlayerRankUpdateResponse
RHAPI_PlayerResponse
RHAPI_PlayerSession
RHAPI_PlayerSessionInvite
RHAPI_PlayerSessions
RHAPI_PlayerUuidFromId
RHAPI_PortalTokenDetailsRequest
RHAPI_PortalUserInfo
RHAPI_PortalUserResponse
RHAPI_PortalUseRuleset
RHAPI_PortalUseRulesets
RHAPI_PriceBreakpoint
RHAPI_PricePoint
RHAPI_PricePoints
RHAPI_PublicKey
RHAPI_PublicKeyList
RHAPI_PurchasePrice
RHAPI_PurgeRequest
RHAPI_PurgeResponse
RHAPI_QueueConfig
RHAPI_QueueConfigV2
RHAPI_QueueJoinRequest
RHAPI_QueueJoinResponse
RHAPI_QueuesResponse
RHAPI_QueuesResponseV2
RHAPI_RankConfig
RHAPI_RankConfigRequestResponse
RHAPI_RankData
RHAPI_Region
RHAPI_RegionsResponse
RHAPI_Restriction
RHAPI_Role
RHAPI_Rule
RHAPI_SelfSessionPlayerUpdateRequest
RHAPI_SendInBlueContact
RHAPI_Session
RHAPI_SessionEvent
RHAPI_SessionEventCreateRequest
RHAPI_SessionEvents
RHAPI_SessionJoinResponse
RHAPI_SessionPlayer
RHAPI_SessionPlayerUpdateRequest
RHAPI_SessionPlayerUpdateResponse
RHAPI_SessionTeam
RHAPI_SessionTemplate
RHAPI_SessionTemplates
RHAPI_SessionUpdate
RHAPI_SetSinglePlayerSettingRequest
RHAPI_SettingData
RHAPI_SettingType
RHAPI_SettingTypeVersion
RHAPI_SiteSettings
RHAPI_TimeFrame
RHAPI_TimeFrames
RHAPI_TokenRequest
RHAPI_TokenResponse
RHAPI_TrueskillRank
RHAPI_TrueskillTeam
RHAPI_TrueskillUpdateRequest
RHAPI_UpdateInventoryRequest
RHAPI_UpdateInventoryRequestById
RHAPI_UpdateInventoryRequests
RHAPI_UpdatePersonInfoRequest
RHAPI_ValidationError
RHAPI_Vendor
RHAPI_Vendors
RHAPI_XpTable
RHAPI_XpTables
Environment OpenAPI Specification
Overview
ad
Begin New Session
Find Opportunities
Update Opportunity By Id
Unity Ad Watched
Unity Mediation Ad Watched
Friends V1
Get Friends List For Player
Delete Friends
Get Friend Relationship
Add Friend
Delete Friend
Add Notes
Delete Notes
Friends V2
Get Friends List For Player V2
Delete Friends V2
Get Friend Relationship V2
Add Friend V2
Delete Friend V2
Add Notes V2
Delete Notes V2
Blocked V1
Get Blocked List For Player
Get Blocked
Block
Unblock
Blocked V2
Get Blocked List For Player V2
Get Blocked V2
Block V2
Unblock V2
Configuration V1
Get Friends And Block Limits
settings
Get All Player Id Settings For Setting Type
Delete All Player Id Settings For Setting Type
Get All Player Uuid Settings For Setting Type Self
Delete All Player Uuid Settings For Setting Type Self
Get All Player Uuid Settings For Setting Type
Delete All Player Uuid Settings For Setting Type
Get Single Player Uuid Setting Self
Set Single Player Uuid Setting Self
Delete Single Player Uuid Setting Self
Get Single Player Uuid Setting
Set Single Player Uuid Setting
Delete Single Player Uuid Setting
Get Single Player Id Setting
Set Single Player Id Setting
Delete Single Player Id Setting
Get Config For All Setting Types
Get Config For Single Setting Type All Versions
Get Config For Single Setting Type And Version
auth
Verify
Login
Get Portal Token Details
Logout
Get All Public Keys
Get Public Key By Id
Generate Key
Oauth Login
Oauth Response
Oauth Token Exchange
Token
Sessions
Get All Session Templates
Get Session Template By Type
Get Browser Sessions By Type
Create Or Join Session
Get Session By Id
Update Session By Id
Get Session By Allocation Id
Post Browser Info
Delete Browser Info
Update Browser Info
Start Match
End Match
Update Match Info
Join Session By Id Self
Leave Session By Id Self
Update Session Player By Uuid V2
Kick Player From Session By Uuid V2
Update Session Player By Uuid
Kick Player From Session By Uuid
Update Session Player By Id
Kick Player From Session By Id
Get Session Events
Create Session Event
Get Player Sessions Self
Get Player Sessions By Uuid V2
Get Player Sessions By Uuid
Get Player Sessions
Get Connection Info Self
Join Queue
Leave Queue
Create Instance Request
End Instance
Update Instance Info
Instance Health Check
Instance Health Config
Report Fubar
Add Platform Session To Rally Here Session
Delete Platform Session From Rally Here Session
Get Platform Session Info
Join Session By Platform Session Id Self
Leave Session By Platform Session Self
Join Session By Platform Session By Uuid
Leave Session By Platform Session By Uuid
Backfill Config
Acknowledge Backfill Request
Update Backfill Request
Queues
Get All Queue Info
Get All Queue Info V2
Get All Map Game Info
Get Instance Request Template
Get Match Making Templates
Get Match Making Templates V2
Regions
Get All Regions
Inventory
Get Player Inventory Uuid Self
Modify Many Player Inventory Uuid Self
Create Player Inventory Uuid Self
Get Player Inventory Uuid
Modify Many Player Inventory Uuid
Create Player Inventory Uuid
Get Player Inventory Self
Modify Many Player Inventory Self
Create Player Inventory Self
Get Player Inventory
Modify Many Player Inventory
Create Player Inventory
Modify Player Inventory Uuid Self
Modify Player Inventory Uuid
Modify Player Inventory Self
Modify Player Inventory
Get Inventory Session Info By Player Uuid Self
Create New Inventory Session By Player Uuid Self
Get Inventory Session Info By Player Uuid
Create New Inventory Session By Player Uuid
Get Inventory Session Info Self
Create New Inventory Session Self
Get Inventory Session Info
Create New Inventory Session
Get Player Uuid Orders Self
Create New Player Uuid Order Self
Get Player Uuid Orders
Create New Player Uuid Order
Get Player Orders Self
Create New Player Order Self
Get Player Orders
Create New Player Order
Get Player Uuid Order By Id Self
Get Player Uuid Order By Id
Get Player Order By Id Self
Get Player Order By Id
Catalog
Get Catalog All
Get Catalog Xp All
Get Catalog Xp Table
Get Catalog Portal Use Rulesets All
Get Catalog Portal Use Ruleset
Get Catalog Inventory Bucket Use Rule Sets All
Get Catalog Inventory Bucket Use Rule Set
Get Catalog Price Points All
Get Catalog Price Point
Get Catalog Items All
Get Catalog Item
Get Catalog Vendors All
Get Catalog Vendor
Get Catalog Loots All
Get Catalog Loot
Get Catalog Time Frames All
Get Catalog Time Frame
Entitlements
Process Platform Entitlement For Me
Process Platform Entitlements By Player Uuid
Retrieve Entitlements For Me
Retrieve Entitlements By Player Uuid
Key Claims
Get Key Claims For My Uuid
Get Player Uuid Key Claims
Get Key Claims For Me
Get Key Claims
Get Player Uuid Key Claim Self
Claim Player Uuid Unclaimed Key Claim For Me
Get Player Uuid Key Claim
Claim Player Uuid Unclaimed Key Claim
Get Key Claim For Me
Claim Unclaimed Key Claim For Me
Get Key Claim
Claim Unclaimed Key Claim
Marketing
Get Marketing Campaigns
presence
Get Player Presence Self
Update Player Presence Self
Get Player Presence Public By Uuid
Get Player Presence Public By Id
Get Presence Settings
presence-admin
Admin Update Player Last Seen
Admin Update Player Last Seen Id
Admin Get Player Presence
Admin Get Player Presence Id
Admin Get Total Ccu
Admin Get Total Ccu Individual
Admin Get Requesting Ccu
Admin Get Requesting Ccu Individual
Admin Get Updating Ccu
Admin Get Updating Ccu Individual
Admin Get Known Platforms
Admin Get Total Ccu All Platform Individual
Admin Get Total Ccu All Platform Combined
Admin Get Requesting Ccu All Platform Individual
Admin Get Requesting Ccu All Platform Combined
Admin Get Updating Ccu All Platform Individual
Admin Get Updating Ccu All Platform Combined
Admin Get Total Ccu Platform Individual
Admin Get Total Ccu Platform Combined
Admin Get Requesting Ccu Platform Individual
Admin Get Requesting Ccu Platform Combined
Admin Get Updating Ccu Platform Individual
Admin Get Updating Ccu Platform Combined
player-notification
Long Poll For Notifications Self
Long Poll For Notifications
Get Notifications Page Self
Get Notifications Page
Create Notification
Get Notification By Id Self
Get Notification By Id
player-id-notification
Long Poll For Notifications Self
Long Poll For Notifications
Get Notifications Page Self
Get Notifications Page
Create Notification
Get Notification By Id Self
Get Notification By Id
instance-notification
Long Poll For Notifications
Get Notifications Page
Create Notification
Get Notification By Id
rank
Update Rankings Trueskill V1
Get Player Uuid Rank Self
Update Player Uuid Rank Self
Get Player Uuid Rank
Update Player Uuid Rank
Get All Player Uuid Ranks Self
Get All Player Uuid Ranks
Get All Rank Config
Get Rank Config
Update V2 Rankings Trueskill
Get All Rank Config V2
Get Rank Config V2
Get Player Uuid Rank Self V2
Update Player Uuid Rank Self V2
Get Player Uuid Rank V2
Update Player Uuid Rank V2
Get All Player Uuid Ranks Self V2
Get All Player Uuid Ranks V2
config
Get App Settings Server
Get App Settings Client
Get App Settings All
discovery
Get Discovery
time
Get Utc Time
custom
Custom Endpoint Send
Events
Receive Events V1
users
Get Player Uuid From Player Id For Self
Get Player Uuid From Player Id
Get Player Uuid From Player Id For Self V2
Get Player Uuid From Player Id V2
Get Player Id From Player Uuid For Self
Get Player Id From Player Uuid
Get Player Links For Self
Get Player Links
Get Player Linked Portals
Lookup Player By Portal
Get Players Paged
Get Person For Self
Update Person For Self
Get Person
Update Person
Get Person Email List For Self
Update Person Email List For Self
Get Person Email List
Update Person Email List
Get Queue Purge Status For Me
Queue Me For Purge
Dequeue Me For Purge
Get Queue Purge Status For Person
Queue Person For Purge
Dequeue Person For Purge
Link
Unlink
Enable Cross Progression
Disable Cross Progression
Upsert Contact
Get All Roles
Key Entitlements
Process Player Uuid Entitlements Self
Process Key Entitlements Player Uuid
Process Key Entitlements Self
Process Key Entitlements
site
Get Site Settings
Select theme
Dark
Light
Auto
Verify
POST
/users/v1/verify
Authorizations
HTTPBearerHeadersOrCookie
Responses
200
Successful Response
Select media type
application/json
403
Forbidden
Select media type
application/json
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string
