Friend List Management - Set Friend Tags

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

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

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

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-Authorization

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

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

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.

SetFriendTagsResult

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

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.

Tags
  • string[]

Array of tags to set on the friend account.

SetFriendTagsResult