> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Set Display Name

> Update the display name of the entity

## Error codes

This operation may return the following PlayFab errors:

| Error | Code |
| --- | --- |
| AccountNotFound | 1001 |
| CharacterNotFound | 1135 |
| ConcurrentEditError | 1133 |
| EntityProfileConstraintValidationFailed | 1398 |
| EntityProfileVersionMismatch | 1352 |
| InvalidPartnerResponse | 1193 |
| NameNotAvailable | 1058 |
| ProfaneDisplayName | 1234 |




## OpenAPI

````yaml post /Profile/SetDisplayName
openapi: 3.0.0
info:
  version: '260922'
  title: PlayFab Profiles API
  description: >-
    All PlayFab entities have profiles, which hold top-level properties about
    the entity. These APIs give you the tools needed to manage entity profiles.
  termsOfService: https://playfab.com/terms/
  contact:
    url: https://community.playfab.com/index.html
  license:
    name: Apache 2.0
    url: https://github.com/PlayFab/API_Specs/blob/master/LICENSE
servers:
  - url: https://{titleId}.playfabapi.com
    description: PlayFab title endpoint
    variables:
      titleId:
        default: your_title_id
        description: Your PlayFab title ID (hex).
security: []
tags:
  - name: Account Management
    description: Account Management APIs
paths:
  /Profile/SetDisplayName:
    post:
      tags:
        - Account Management
      summary: Set Display Name
      description: |
        Update the display name of the entity

        ## Error codes

        This operation may return the following PlayFab errors:

        | Error | Code |
        | --- | --- |
        | AccountNotFound | 1001 |
        | CharacterNotFound | 1135 |
        | ConcurrentEditError | 1133 |
        | EntityProfileConstraintValidationFailed | 1398 |
        | EntityProfileVersionMismatch | 1352 |
        | InvalidPartnerResponse | 1193 |
        | NameNotAvailable | 1058 |
        | ProfaneDisplayName | 1234 |
      operationId: SetDisplayName
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetDisplayNameRequest'
        description: >-
          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
      responses:
        '200':
          $ref: '#/components/responses/SetDisplayNameResponse'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security:
        - EntityToken: []
components:
  schemas:
    SetDisplayNameRequest:
      description: >-
        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
      type: object
      properties:
        CustomTags:
          description: >-
            The optional custom tags associated with the request (e.g. build
            number, external trace identifiers, etc.).
          type: object
        DisplayName:
          description: The new value to be set on Entity Profile's display name
          type: string
        Entity:
          allOf:
            - $ref: '#/components/schemas/EntityKey'
          description: >-
            The optional entity to perform this action on. Defaults to the
            currently logged in entity.
        ExpectedVersion:
          description: The expected version of a profile to perform this update on
          type: number
          x-actualtype: int32
      example:
        DisplayName: My new display name
        ExpectedVersion: 123
        Entity:
          Id: '90901000'
          Type: title_player_account
          TypeString: title_player_account
    EntityKey:
      description: >-
        Combined entity type and ID structure which uniquely identifies a single
        entity.
      type: object
      properties:
        Id:
          description: Unique ID of the entity.
          type: string
        Type:
          description: >-
            Entity type. See
            https://learn.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types
          type: string
      required:
        - Id
    SetDisplayNameResponse:
      type: object
      properties:
        OperationResult:
          allOf:
            - $ref: '#/components/schemas/OperationTypes'
          description: The type of operation that occured on the profile's display name
        VersionNumber:
          description: The updated version of the profile after the display name update
          type: number
          x-actualtype: int32
      example:
        VersionNumber: 42
        OperationResult: Updated
    ApiErrorWrapper:
      description: The basic wrapper around every failed API response
      type: object
      properties:
        code:
          description: Numerical HTTP code
          type: integer
        status:
          description: String HTTP code
          type: string
        error:
          description: Playfab error code
          type: string
        errorCode:
          description: Numerical PlayFab error code
          type: integer
        errorMessage:
          description: Description for the PlayFab errorCode
          type: string
        errorDetails:
          description: Detailed description of individual issues with the request object
          type: object
      required:
        - code
        - errorCode
    OperationTypes:
      type: string
      enum:
        - Created
        - Updated
        - Deleted
        - None
  responses:
    SetDisplayNameResponse:
      description: ''
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: integer
                description: >-
                  The Http status code. If X-ReportErrorAsSuccess header is set
                  to true, this will report the actual http error code.
              status:
                type: string
                description: The Http status code as a string.
              data:
                $ref: '#/components/schemas/SetDisplayNameResponse'
            example:
              code: 200
              status: OK
              data:
                VersionNumber: 42
                OperationResult: Updated
    ApiErrorWrapper:
      description: This is the outer wrapper for all responses with errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorWrapper'
  securitySchemes:
    EntityToken:
      type: apiKey
      in: header
      name: X-EntityToken
      description: >-
        This API requires an Entity Session Token, available from the Entity
        GetEntityToken method.

````

## Related topics

- [Set Display Name](/api-reference/account-management/set-display-name.md)
- [XFrontPanelSetDisplayName](/reference/devkit/xfrontpaneldisplay/functions/xfrontpanelsetdisplayname.md)
- [PFAccountManagementSetDisplayNameRequest](/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementsetdisplaynamerequest.md)
- [PFAccountManagementSetDisplayNameResponse](/services/playfab/api-references/c/pfaccountmanagementtypes/structs/pfaccountmanagementsetdisplaynameresponse.md)
- [PFAccountManagementSetDisplayNameAsync](/services/playfab/api-references/c/pfaccountmanagement/functions/pfaccountmanagementsetdisplaynameasync.md)
