Friend List Management - Remove Friend

Service:

Client

API Version:

240412

Removes a specified user from the friend list of the local user

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

Request Header

Name	Required	Type	Description
X-Authorization	True	string	This API requires a client session ticket, available from any Client Login function.

Request Body

Name	Required	Type	Description
FriendPlayFabId	True	string	PlayFab identifier of the friend account which is to be removed.

Responses

Name	Type	Description
200 OK	RemoveFriendResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-Authorization

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
RemoveFriendRequest
RemoveFriendResult

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

RemoveFriendRequest

Name	Type	Description
FriendPlayFabId	string	PlayFab identifier of the friend account which is to be removed.

RemoveFriendResult