Update Lobby As Server

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.

Allowed entity token types: game_server

Error codes

This operation may return the following PlayFab errors:

Error	Code
LobbyBadRequest	13007
LobbyDoesNotExist	13000
LobbyRateLimitExceeded	13001
LobbyServerMismatch	13012
LobbyServerNotFound	13013

POST

Lobby

UpdateLobbyAsServer

Update Lobby As Server

curl --request POST \
  --url https://{titleId}.playfabapi.com/Lobby/UpdateLobbyAsServer \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "LobbyId": "12345678-1234-1234-1234-123456789ABC",
  "ServerEntity": {
    "Id": "1234",
    "Type": "game_server",
    "TypeString": "game_server"
  },
  "ServerData": {
    "MyDataKey": "MyDataKey value"
  },
  "ServerDataToDelete": [
    "MyOldGameKey"
  ]
}
'

import requests

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

payload = {
    "LobbyId": "12345678-1234-1234-1234-123456789ABC",
    "ServerEntity": {
        "Id": "1234",
        "Type": "game_server",
        "TypeString": "game_server"
    },
    "ServerData": { "MyDataKey": "MyDataKey value" },
    "ServerDataToDelete": ["MyOldGameKey"]
}
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({
    LobbyId: '12345678-1234-1234-1234-123456789ABC',
    ServerEntity: {Id: '1234', Type: 'game_server', TypeString: 'game_server'},
    ServerData: {MyDataKey: 'MyDataKey value'},
    ServerDataToDelete: ['MyOldGameKey']
  })
};

fetch('https://{titleId}.playfabapi.com/Lobby/UpdateLobbyAsServer', 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/UpdateLobbyAsServer",
  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([
    'LobbyId' => '12345678-1234-1234-1234-123456789ABC',
    'ServerEntity' => [
        'Id' => '1234',
        'Type' => 'game_server',
        'TypeString' => 'game_server'
    ],
    'ServerData' => [
        'MyDataKey' => 'MyDataKey value'
    ],
    'ServerDataToDelete' => [
        'MyOldGameKey'
    ]
  ]),
  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/UpdateLobbyAsServer"

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

	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/UpdateLobbyAsServer")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"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}"

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

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

{
  "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

Preview: Request to update the serverData and serverEntity in case of migration. Only a game_server entity can update this information and this is restricted to client owned lobbies which are using connections.

LobbyId

string

required

The id of the lobby.

CustomTags

object

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

ServerData

object

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.

ServerDataToDelete

string[]

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.

ServerEntity

object

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.

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

Last modified on October 1, 2026

⌘I

Update Lobby As Server

curl --request POST \
  --url https://{titleId}.playfabapi.com/Lobby/UpdateLobbyAsServer \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "LobbyId": "12345678-1234-1234-1234-123456789ABC",
  "ServerEntity": {
    "Id": "1234",
    "Type": "game_server",
    "TypeString": "game_server"
  },
  "ServerData": {
    "MyDataKey": "MyDataKey value"
  },
  "ServerDataToDelete": [
    "MyOldGameKey"
  ]
}
'

import requests

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

payload = {
    "LobbyId": "12345678-1234-1234-1234-123456789ABC",
    "ServerEntity": {
        "Id": "1234",
        "Type": "game_server",
        "TypeString": "game_server"
    },
    "ServerData": { "MyDataKey": "MyDataKey value" },
    "ServerDataToDelete": ["MyOldGameKey"]
}
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({
    LobbyId: '12345678-1234-1234-1234-123456789ABC',
    ServerEntity: {Id: '1234', Type: 'game_server', TypeString: 'game_server'},
    ServerData: {MyDataKey: 'MyDataKey value'},
    ServerDataToDelete: ['MyOldGameKey']
  })
};

fetch('https://{titleId}.playfabapi.com/Lobby/UpdateLobbyAsServer', 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/UpdateLobbyAsServer",
  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([
    'LobbyId' => '12345678-1234-1234-1234-123456789ABC',
    'ServerEntity' => [
        'Id' => '1234',
        'Type' => 'game_server',
        'TypeString' => 'game_server'
    ],
    'ServerData' => [
        'MyDataKey' => 'MyDataKey value'
    ],
    'ServerDataToDelete' => [
        'MyOldGameKey'
    ]
  ]),
  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/UpdateLobbyAsServer"

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

	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/UpdateLobbyAsServer")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"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}"

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

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

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

PlayFab API

PlayFab REST API References

Update Lobby As Server

Error codes

Authorizations

Body

Response