Account Management - Update User Title Display Name

Reference

Service:: Admin

API Version:: 240412

Updates the title specific display name for a user

POST https://titleId.playfabapi.com/Admin/UpdateUserTitleDisplayName

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
DisplayName	True	string	New title display name for the user - must be between 3 and 25 characters
PlayFabId	True	string	PlayFab unique identifier of the user whose title specific display name is to be changed
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	UpdateUserTitleDisplayNameResult
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
UpdateUserTitleDisplayNameRequest	In addition to the PlayFab username, titles can make use of a DisplayName which is also a unique identifier, but specific to the title. This allows for unique names which more closely match the theme or genre of a title, for example. This API enables changing that name, whether due to a customer request, an offensive name choice, etc.
UpdateUserTitleDisplayNameResult

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

UpdateUserTitleDisplayNameRequest

In addition to the PlayFab username, titles can make use of a DisplayName which is also a unique identifier, but specific to the title. This allows for unique names which more closely match the theme or genre of a title, for example. This API enables changing that name, whether due to a customer request, an offensive name choice, etc.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
DisplayName	string	New title display name for the user - must be between 3 and 25 characters
PlayFabId	string	PlayFab unique identifier of the user whose title specific display name is to be changed

UpdateUserTitleDisplayNameResult

Name	Type	Description
DisplayName	string	current title display name for the user (this will be the original display name if the rename attempt failed)

Error Codes

Name	Code
InsufficientFunds	1059
NameNotAvailable	1058