Friend List Management - Remove Friend

  • Reference
Service:
Server
API Version:
240412

Removes the specified friend from the the user's friend list

POST https://titleId.playfabapi.com/Server/RemoveFriend

Request Header

Name Required Type Description
X-SecretKey True

string

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

Request Body

Name Required Type Description
FriendPlayFabId True

string

PlayFab identifier of the friend account which is to be removed.
PlayFabId True

string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

Responses

Name Type Description
200 OK

EmptyResponse

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-SecretKey

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

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response
EmptyResponse
RemoveFriendRequest

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code
error

string

Playfab error code
errorCode

integer

Numerical PlayFab error code
errorDetails

object

Detailed description of individual issues with the request object
errorMessage

string

Description for the PlayFab errorCode
status

string

String HTTP code

EmptyResponse

RemoveFriendRequest

Name Type Description
FriendPlayFabId

string

PlayFab identifier of the friend account which is to be removed.
PlayFabId

string

Unique PlayFab assigned ID of the user on whom the operation will be performed.

Error Codes

Name Code
AccountNotFound 1001