Skip to main content
POST
Invite To Lobby

Authorizations

X-EntityToken
string
header
required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json

Request to invite a player to a lobby the caller is already a member of. Only a client can invite another player to a lobby.

Request to invite a player to a lobby the caller is already a member of. Only a client can invite another player to a lobby.

CustomTags
object

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

InviteeEntity
object

The entity invited to the lobby.

LobbyId
string

The id of the lobby.

MemberEntity
object

The member entity sending the invite. Must be a member of the lobby.

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Last modified on October 1, 2026