Account Management - Set Display Name
Update the display name of the entity
POST https://titleId.playfabapi.com/Profile/SetDisplayNameRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-EntityToken | True |
string |
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| DisplayName |
string |
The new value to be set on Entity Profile's display name |
| Entity |
The optional entity to perform this action on. Defaults to the currently logged in entity. |
|
| ExpectedVersion |
number |
The expected version of a profile to perform this update on |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-EntityToken
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
|
Operation |
|
|
Set |
Given an entity profile, will update its display name to the one passed in if the profile's version is equal to the specified value |
|
Set |
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 |
EntityKey
Combined entity type and ID structure which uniquely identifies a single entity.
| Name | Type | Description |
|---|---|---|
| Id |
string |
Unique ID of the entity. |
| Type |
string |
Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types |
OperationTypes
| Name | Type | Description |
|---|---|---|
| Created |
string |
|
| Deleted |
string |
|
| None |
string |
|
| Updated |
string |
SetDisplayNameRequest
Given an entity profile, will update its display name to the one passed in if the profile's version is equal to the specified value
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| DisplayName |
string |
The new value to be set on Entity Profile's display name |
| Entity |
The optional entity to perform this action on. Defaults to the currently logged in entity. |
|
| ExpectedVersion |
number |
The expected version of a profile to perform this update on |
SetDisplayNameResponse
| Name | Type | Description |
|---|---|---|
| OperationResult |
The type of operation that occured on the profile's display name |
|
| VersionNumber |
number |
The updated version of the profile after the display name update |
Error Codes
| Name | Code |
|---|---|
| EntityProfileConstraintValidationFailed | 1398 |
| InvalidPartnerResponse | 1193 |
| ProfaneDisplayName | 1234 |