Friend List Management - Set Friend Tags

Updates the tag list for a specified user in the friend list of another user

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

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 to which the tag(s) should be applied.

PlayFabId True
  • string

PlayFab identifier of the player whose friend is to be updated.

Tags True
  • string[]

Array of tags to set on the friend account.

Responses

Name Type Description
200 OK
400 Bad Request

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

ApiErrorWrapper

The basic wrapper around every failed API response

EmptyResponse
SetFriendTagsRequest

This operation is not additive. It will completely replace the tag list for the specified user. Please note that only users in the PlayFab friends list can be assigned tags. Attempting to set a tag on a friend only included in the friends list from a social site integration (such as Facebook or Steam) will return the AccountNotFound error.

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

SetFriendTagsRequest

This operation is not additive. It will completely replace the tag list for the specified user. Please note that only users in the PlayFab friends list can be assigned tags. Attempting to set a tag on a friend only included in the friends list from a social site integration (such as Facebook or Steam) will return the AccountNotFound error.

Name Type Description
FriendPlayFabId
  • string

PlayFab identifier of the friend account to which the tag(s) should be applied.

PlayFabId
  • string

PlayFab identifier of the player whose friend is to be updated.

Tags
  • string[]

Array of tags to set on the friend account.