Add Members

Error	Code
RoleDoesNotExist	1358

POST

Group

AddMembers

Add Members

curl --request POST \
  --url https://{titleId}.playfabapi.com/Group/AddMembers \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Group": {
    "Id": "ABC1234ABC"
  },
  "Members": [
    {
      "Id": "90901000",
      "Type": "title_player_account",
      "TypeString": "title_player_account"
    }
  ]
}
'

import requests

url = "https://{titleId}.playfabapi.com/Group/AddMembers"

payload = {
    "Group": { "Id": "ABC1234ABC" },
    "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'},
    Members: [
      {
        Id: '90901000',
        Type: 'title_player_account',
        TypeString: 'title_player_account'
      }
    ]
  })
};

fetch('https://{titleId}.playfabapi.com/Group/AddMembers', 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/AddMembers",
  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'
    ],
    '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/AddMembers"

	payload := strings.NewReader("{\n  \"Group\": {\n    \"Id\": \"ABC1234ABC\"\n  },\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/AddMembers")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Group\": {\n    \"Id\": \"ABC1234ABC\"\n  },\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/AddMembers")

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

X-EntityToken

string

header

required

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

Body

application/json

Adds members to a group or role. Existing members of the group will added to roles within the group, but if the user is not already a member of the group, only title claimants may add them to the group, and others must use the group application or invite system to add new members to a group. Returns nothing if successful.

Group

object

required

The identifier of the group

Show child attributes

Members

object[]

required

List of entities to add to the group. Only entities of type title_player_account and character may be added to groups.

Show child attributes

CustomTags

object

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

RoleId

string

Optional: The ID of the existing role to add the entities to. If this is not specified, the default member role for the group will be used. Role IDs must be between 1 and 64 characters long.

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

Add Members

curl --request POST \
  --url https://{titleId}.playfabapi.com/Group/AddMembers \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Group": {
    "Id": "ABC1234ABC"
  },
  "Members": [
    {
      "Id": "90901000",
      "Type": "title_player_account",
      "TypeString": "title_player_account"
    }
  ]
}
'

import requests

url = "https://{titleId}.playfabapi.com/Group/AddMembers"

payload = {
    "Group": { "Id": "ABC1234ABC" },
    "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'},
    Members: [
      {
        Id: '90901000',
        Type: 'title_player_account',
        TypeString: 'title_player_account'
      }
    ]
  })
};

fetch('https://{titleId}.playfabapi.com/Group/AddMembers', 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/AddMembers",
  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'
    ],
    '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/AddMembers"

	payload := strings.NewReader("{\n  \"Group\": {\n    \"Id\": \"ABC1234ABC\"\n  },\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/AddMembers")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Group\": {\n    \"Id\": \"ABC1234ABC\"\n  },\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/AddMembers")

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

PlayFab API

PlayFab REST API References

Error codes

Authorizations

Body

Response