Play Stream - Remove Player Tag

Reference

Service:: Server

API Version:: 240412

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

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

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	RemovePlayerTagResult
400 Bad Request	ApiErrorWrapper	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

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
RemovePlayerTagRequest	This API will trigger a player_tag_removed event and remove a tag with the given TagName and PlayFabID from the corresponding player profile. TagName can be used for segmentation and it is limited to 256 characters
RemovePlayerTagResult

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

RemovePlayerTagRequest

This API will trigger a player_tag_removed event and remove a tag with the given TagName and PlayFabID from the corresponding player profile. TagName can be used for segmentation and it is limited to 256 characters

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.