Account Management - Update User Title Display Name

Updates the title specific display name for the user

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

Request Header

Name Required Type Description
X-Authorization True
  • string

This API requires a client session ticket, available from any Client Login function.

Request Body

Name Required Type Description
DisplayName True
  • string

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

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-Authorization

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Definitions

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.

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.

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.

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
AccountNotFound 1001
InvalidPartnerResponse 1193
NameNotAvailable 1058
ProfaneDisplayName 1234