Play Stream - Add Player Tag

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

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

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
PlayFabId True
  • string

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

TagName True
  • string

Unique tag for player profile.

CustomTags
  • object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

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

AddPlayerTagRequest

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.

AddPlayerTagResult
ApiErrorWrapper

The basic wrapper around every failed API response

AddPlayerTagRequest

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.

Name Type Description
CustomTags
  • object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

PlayFabId
  • string

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

TagName
  • string

Unique tag for player profile.

AddPlayerTagResult

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

Error Codes

Name Code
PlayerTagCountLimitExceeded 1248