Join Lobby

Join a lobby.

Allowed entity token types: title_player_account, title

Error codes

This operation may return the following PlayFab errors:

Error	Code
LobbyBadRequest	13007
LobbyDoesNotExist	13000
LobbyMemberCannotRejoin	13004
LobbyNotJoinable	13003
LobbyPlayerAlreadyJoined	13002
LobbyPlayerMaxLobbyLimitExceeded	13008
LobbyRateLimitExceeded	13001

POST

Lobby

JoinLobby

Join Lobby

curl --request POST \
  --url https://{titleId}.playfabapi.com/Lobby/JoinLobby \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "MemberEntity": {
    "Id": "1234",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  },
  "ConnectionString": "connString",
  "MemberData": {
    "MyDataKey": "MyDataKey value"
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Lobby/JoinLobby"

payload = {
    "MemberEntity": {
        "Id": "1234",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
    },
    "ConnectionString": "connString",
    "MemberData": { "MyDataKey": "MyDataKey value" }
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    MemberEntity: {Id: '1234', Type: 'title_player_account', TypeString: 'title_player_account'},
    ConnectionString: 'connString',
    MemberData: {MyDataKey: 'MyDataKey value'}
  })
};

fetch('https://{titleId}.playfabapi.com/Lobby/JoinLobby', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Lobby/JoinLobby",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'MemberEntity' => [
        'Id' => '1234',
        'Type' => 'title_player_account',
        'TypeString' => 'title_player_account'
    ],
    'ConnectionString' => 'connString',
    'MemberData' => [
        'MyDataKey' => 'MyDataKey value'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Lobby/JoinLobby"

	payload := strings.NewReader("{\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}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Lobby/JoinLobby")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Lobby/JoinLobby")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\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}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {
    "LobbyId": "<string>"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Authorizations

X-EntityToken

string

header

required

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

Body

application/json

Request to join a lobby. Only a client can join a lobby.

ConnectionString

string

A field which indicates which lobby the user will be joining. This field is opaque to everyone except the Lobby service.

CustomTags

object

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

MemberData

object

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.

MemberEntity

object

The member entity who is joining the lobby.

Show child attributes

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

Show child attributes

Last modified on October 1, 2026

⌘I

Join Lobby

curl --request POST \
  --url https://{titleId}.playfabapi.com/Lobby/JoinLobby \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "MemberEntity": {
    "Id": "1234",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  },
  "ConnectionString": "connString",
  "MemberData": {
    "MyDataKey": "MyDataKey value"
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Lobby/JoinLobby"

payload = {
    "MemberEntity": {
        "Id": "1234",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
    },
    "ConnectionString": "connString",
    "MemberData": { "MyDataKey": "MyDataKey value" }
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    MemberEntity: {Id: '1234', Type: 'title_player_account', TypeString: 'title_player_account'},
    ConnectionString: 'connString',
    MemberData: {MyDataKey: 'MyDataKey value'}
  })
};

fetch('https://{titleId}.playfabapi.com/Lobby/JoinLobby', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Lobby/JoinLobby",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'MemberEntity' => [
        'Id' => '1234',
        'Type' => 'title_player_account',
        'TypeString' => 'title_player_account'
    ],
    'ConnectionString' => 'connString',
    'MemberData' => [
        'MyDataKey' => 'MyDataKey value'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Lobby/JoinLobby"

	payload := strings.NewReader("{\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}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Lobby/JoinLobby")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Lobby/JoinLobby")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\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}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {
    "LobbyId": "<string>"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Join Lobby

Error codes

Authorizations

Body

Response