Invite To Group

Invites a player to join a group

Error codes

This operation may return the following PlayFab errors:

Error	Code
EntityBlockedByGroup	1357
EntityIsAlreadyMember	1359
OutstandingApplicationAcceptedInstead	1364
RoleDoesNotExist	1358

POST

Group

InviteToGroup

Invite To Group

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

import requests

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

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

fetch('https://{titleId}.playfabapi.com/Group/InviteToGroup', 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/InviteToGroup",
  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' => 'awesomepeople',
    'Entity' => [
        '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/InviteToGroup"

	payload := strings.NewReader("{\n  \"Group\": {\n    \"Id\": \"ABC1234ABC\"\n  },\n  \"RoleId\": \"awesomepeople\",\n  \"Entity\": {\n    \"Id\": \"90901000\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\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/InviteToGroup")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Group\": {\n    \"Id\": \"ABC1234ABC\"\n  },\n  \"RoleId\": \"awesomepeople\",\n  \"Entity\": {\n    \"Id\": \"90901000\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Group/InviteToGroup")

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\": \"awesomepeople\",\n  \"Entity\": {\n    \"Id\": \"90901000\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "InvitedEntity": {
      "Key": {
        "Id": "90901000",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
      },
      "Lineage": {
        "master_player_account": {
          "Id": "800DED92",
          "Type": "master_player_account",
          "TypeString": "master_player_account"
        }
      }
    },
    "Group": {
      "Id": "ABC1234ABC"
    },
    "InvitedByEntity": {
      "Key": {
        "Id": "9023AFF3",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
      },
      "Lineage": {
        "master_player_account": {
          "Id": "366AD424",
          "Type": "master_player_account",
          "TypeString": "master_player_account"
        }
      }
    },
    "RoleId": "awesomepeople",
    "Expires": "2017-12-31T11:59:59"
  }
}

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

Invites a player to join a group, if they are not blocked by the group. An optional role can be provided to automatically assign the player to the role if they accept the invitation. By default, if the entity has an application to the group outstanding, this will accept the application instead and return an error indicating such, rather than creating a duplicate invitation to join that will need to be cleaned up later. Returns information about the new invitation or an error indicating an existing application to join was accepted.

Entity

object

required

The entity to perform this action on.

Show child attributes

Group

object

required

The identifier of the group

Show child attributes

AutoAcceptOutstandingApplication

boolean

Optional, default true. Automatically accept an application if one exists instead of creating an invitation

CustomTags

object

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

RoleId

string

Optional. ID of an existing a role in the group to assign the user to. The group's default member role is used if this is not specified. Role IDs must be between 1 and 64 characters long.

Response

Describes an invitation to a group.

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

Describes an invitation to a group.

Show child attributes

Example:

{
  "InvitedEntity": {
    "Key": {
      "Id": "90901000",
      "Type": "title_player_account",
      "TypeString": "title_player_account"
    },
    "Lineage": {
      "master_player_account": {
        "Id": "800DED92",
        "Type": "master_player_account",
        "TypeString": "master_player_account"
      }
    }
  },
  "Group": { "Id": "ABC1234ABC" },
  "InvitedByEntity": {
    "Key": {
      "Id": "9023AFF3",
      "Type": "title_player_account",
      "TypeString": "title_player_account"
    },
    "Lineage": {
      "master_player_account": {
        "Id": "366AD424",
        "Type": "master_player_account",
        "TypeString": "master_player_account"
      }
    }
  },
  "RoleId": "awesomepeople",
  "Expires": "2017-12-31T11:59:59"
}

Last modified on October 1, 2026

⌘I

Invite To Group

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

import requests

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

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

fetch('https://{titleId}.playfabapi.com/Group/InviteToGroup', 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/InviteToGroup",
  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' => 'awesomepeople',
    'Entity' => [
        '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/InviteToGroup"

	payload := strings.NewReader("{\n  \"Group\": {\n    \"Id\": \"ABC1234ABC\"\n  },\n  \"RoleId\": \"awesomepeople\",\n  \"Entity\": {\n    \"Id\": \"90901000\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\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/InviteToGroup")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Group\": {\n    \"Id\": \"ABC1234ABC\"\n  },\n  \"RoleId\": \"awesomepeople\",\n  \"Entity\": {\n    \"Id\": \"90901000\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Group/InviteToGroup")

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\": \"awesomepeople\",\n  \"Entity\": {\n    \"Id\": \"90901000\",\n    \"Type\": \"title_player_account\",\n    \"TypeString\": \"title_player_account\"\n  }\n}"

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

{
  "code": 200,
  "status": "OK",
  "data": {
    "InvitedEntity": {
      "Key": {
        "Id": "90901000",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
      },
      "Lineage": {
        "master_player_account": {
          "Id": "800DED92",
          "Type": "master_player_account",
          "TypeString": "master_player_account"
        }
      }
    },
    "Group": {
      "Id": "ABC1234ABC"
    },
    "InvitedByEntity": {
      "Key": {
        "Id": "9023AFF3",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
      },
      "Lineage": {
        "master_player_account": {
          "Id": "366AD424",
          "Type": "master_player_account",
          "TypeString": "master_player_account"
        }
      }
    },
    "RoleId": "awesomepeople",
    "Expires": "2017-12-31T11:59:59"
  }
}

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

PlayFab API

PlayFab REST API References

Invite To Group

Error codes

Authorizations

Body

Response