Documentation

AddPlayerTag

Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag.

Request Details

This API will trigger a player_tag_added event and add a tag with the given TagName and PlayFabID to the corresponding player profile. TagName can be used for segmentation and it is limited to 256 characters. Also there is a limit on the number of tags a title can have.

AddPlayerTagRequest
Request Properties
PlayFabId (required) String

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

TagName (required) String

Unique tag for player profile.

POST https://{{TitleID}}.playfabapi.com/Server/AddPlayerTag
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PlayFabId": "10931252888739651331",
  "TagName": "MostKilled"
}
        

Response Details

AddPlayerTagResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

SecretKey

Possible Error Codes

Name Code
AccountNotFound 1001
PlayerTagCountLimitExceeded 1248