Ajouter un ami

Adds the Friend user to the friendlist of the user with PlayFabId. At least one of FriendPlayFabId,FriendUsername,FriendEmail, or FriendTitleDisplayName should be initialized.

Error codes

This operation may return the following PlayFab errors:

Error	Code
UsersAlreadyFriends	1183

POST

Server

AddFriend

Add Friend

curl --request POST \
  --url https://{titleId}.playfabapi.com/Server/AddFriend \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "PlayFabId": "10931252888739651331",
  "FriendPlayFabId": "20394883"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Server/AddFriend"

payload = {
    "PlayFabId": "10931252888739651331",
    "FriendPlayFabId": "20394883"
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({PlayFabId: '10931252888739651331', FriendPlayFabId: '20394883'})
};

fetch('https://{titleId}.playfabapi.com/Server/AddFriend', 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/Server/AddFriend",
  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([
    'PlayFabId' => '10931252888739651331',
    'FriendPlayFabId' => '20394883'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <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/Server/AddFriend"

	payload := strings.NewReader("{\n  \"PlayFabId\": \"10931252888739651331\",\n  \"FriendPlayFabId\": \"20394883\"\n}")

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

	req.Header.Add("X-SecretKey", "<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/Server/AddFriend")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"PlayFabId\": \"10931252888739651331\",\n  \"FriendPlayFabId\": \"20394883\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Server/AddFriend")

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

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

Autorisations

X-SecretKey

string

header

requis

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Corps

application/json

PlayFabId

string

requis

PlayFab identifier of the player to add a new friend.

FriendEmail

string

Email address of the user being added.

FriendPlayFabId

string

The PlayFab identifier of the user being added.

FriendTitleDisplayName

string

Title-specific display name of the user to being added.

FriendUsername

string

The PlayFab username of the user being added

Réponse

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

Dernière modification le 6 octobre 2026

Sujets connexes

Ajouter un ami Listes d'amis Supprimer un ami Jouer à une partie avec des amis (organigramme)Ajouter un ID générique

⌘I

Add Friend

curl --request POST \
  --url https://{titleId}.playfabapi.com/Server/AddFriend \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "PlayFabId": "10931252888739651331",
  "FriendPlayFabId": "20394883"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Server/AddFriend"

payload = {
    "PlayFabId": "10931252888739651331",
    "FriendPlayFabId": "20394883"
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({PlayFabId: '10931252888739651331', FriendPlayFabId: '20394883'})
};

fetch('https://{titleId}.playfabapi.com/Server/AddFriend', 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/Server/AddFriend",
  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([
    'PlayFabId' => '10931252888739651331',
    'FriendPlayFabId' => '20394883'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <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/Server/AddFriend"

	payload := strings.NewReader("{\n  \"PlayFabId\": \"10931252888739651331\",\n  \"FriendPlayFabId\": \"20394883\"\n}")

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

	req.Header.Add("X-SecretKey", "<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/Server/AddFriend")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"PlayFabId\": \"10931252888739651331\",\n  \"FriendPlayFabId\": \"20394883\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Server/AddFriend")

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

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"PlayFabId\": \"10931252888739651331\",\n  \"FriendPlayFabId\": \"20394883\"\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

Ajouter un ami

Error codes

Autorisations

Corps

Réponse