Documentation

UpdateUserTitleDisplayName

Updates the title specific display name for a user

Request Details

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.

UpdateUserTitleDisplayNameRequest
Request Properties
DisplayName (required) String

New title display name for the user - must be between 3 and 25 characters

PlayFabId (required) String

PlayFab unique identifier of the user whose title specific display name is to be changed

POST https://{{TitleID}}.playfabapi.com/Admin/UpdateUserTitleDisplayName
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PlayFabId": "293438",
  "DisplayName": "New Display Name"
}
        

Response Details

UpdateUserTitleDisplayNameResult
Result Properties
DisplayName String

current title display name for the user (this will be the original display name if the rename attempt failed)

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "DisplayName": "New Display Name"
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
InsufficientFunds 1059
NameNotAvailable 1058