Skip to main content
POST
Add Friend

Authorizations

X-Authorization
string
header
required

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

Body

application/json
FriendEmail
string

Email address of the user to attempt to add to the local user's friend list.

FriendPlayFabId
string

PlayFab identifier of the user to attempt to add to the local user's friend list.

FriendTitleDisplayName
string

Title-specific display name of the user to attempt to add to the local user's friend list.

FriendUsername
string

PlayFab username of the user to attempt to add to the local user's friend list.

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
Example:
Last modified on October 1, 2026