Remove Members
Removes members from a group.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| RoleDoesNotExist | 1358 |
POST
/
Group
/
RemoveMembers
Remove Members
curl --request POST \
--url https://{titleId}.playfabapi.com/Group/RemoveMembers \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"Group": {
"Id": "ABC1234ABC"
},
"RoleId": "ABC1234DEF",
"Members": [
{
"Id": "90901000",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
]
}
'import requests
url = "https://{titleId}.playfabapi.com/Group/RemoveMembers"
payload = {
"Group": { "Id": "ABC1234ABC" },
"RoleId": "ABC1234DEF",
"Members": [
{
"Id": "90901000",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
]
}
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({
Group: {Id: 'ABC1234ABC'},
RoleId: 'ABC1234DEF',
Members: [
{
Id: '90901000',
Type: 'title_player_account',
TypeString: 'title_player_account'
}
]
})
};
fetch('https://{titleId}.playfabapi.com/Group/RemoveMembers', 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/Group/RemoveMembers",
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([
'Group' => [
'Id' => 'ABC1234ABC'
],
'RoleId' => 'ABC1234DEF',
'Members' => [
[
'Id' => '90901000',
'Type' => 'title_player_account',
'TypeString' => 'title_player_account'
]
]
]),
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/Group/RemoveMembers"
payload := strings.NewReader("{\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}")
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/Group/RemoveMembers")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Group/RemoveMembers")
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 \"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}"
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
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Body
application/json
Removes members from a group. A member can always remove themselves from a group, regardless of permissions. Returns nothing if successful.
Removes members from a group. A member can always remove themselves from a group, regardless of permissions. Returns nothing if successful.
The identifier of the group
Show child attributes
Show child attributes
List of entities to remove
Show child attributes
Show child attributes
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
The ID of the role to remove the entities from.
Last modified on October 1, 2026
Was this page helpful?
⌘I
Remove Members
curl --request POST \
--url https://{titleId}.playfabapi.com/Group/RemoveMembers \
--header 'Content-Type: application/json' \
--header 'X-EntityToken: <api-key>' \
--data '
{
"Group": {
"Id": "ABC1234ABC"
},
"RoleId": "ABC1234DEF",
"Members": [
{
"Id": "90901000",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
]
}
'import requests
url = "https://{titleId}.playfabapi.com/Group/RemoveMembers"
payload = {
"Group": { "Id": "ABC1234ABC" },
"RoleId": "ABC1234DEF",
"Members": [
{
"Id": "90901000",
"Type": "title_player_account",
"TypeString": "title_player_account"
}
]
}
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({
Group: {Id: 'ABC1234ABC'},
RoleId: 'ABC1234DEF',
Members: [
{
Id: '90901000',
Type: 'title_player_account',
TypeString: 'title_player_account'
}
]
})
};
fetch('https://{titleId}.playfabapi.com/Group/RemoveMembers', 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/Group/RemoveMembers",
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([
'Group' => [
'Id' => 'ABC1234ABC'
],
'RoleId' => 'ABC1234DEF',
'Members' => [
[
'Id' => '90901000',
'Type' => 'title_player_account',
'TypeString' => 'title_player_account'
]
]
]),
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/Group/RemoveMembers"
payload := strings.NewReader("{\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}")
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/Group/RemoveMembers")
.header("X-EntityToken", "<api-key>")
.header("Content-Type", "application/json")
.body("{\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}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{titleId}.playfabapi.com/Group/RemoveMembers")
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 \"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}"
response = http.request(request)
puts response.read_body{
"code": 123,
"status": "<string>",
"data": {}
}{
"code": 123,
"errorCode": 123,
"status": "<string>",
"error": "<string>",
"errorMessage": "<string>",
"errorDetails": {}
}