> ## 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.

# Update User Data

> Updates the title-specific custom data for the user which is readable and writable by the client



## OpenAPI

````yaml post /Admin/UpdateUserData
openapi: 3.0.0
info:
  version: '260922'
  title: PlayFab Admin API
  description: >-
    APIs for managing title configurations, uploaded Game Server code
    executables, and user data
  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
  - name: Authentication
    description: Authentication APIs
  - name: Characters
    description: Characters APIs
  - name: Content
    description: Content Service APIs
  - name: Custom Server Management
    description: Custom Server Management APIs
  - name: Matchmaking
    description: Matchmaking APIs
  - name: Player Data Management
    description: Player Data Management APIs
  - name: Player Item Management
    description: Player Item Management APIs
  - name: PlayStream
    description: PlayStream Management APIs
  - name: ScheduledTask
    description: Task management APIs
  - name: Segments
    description: Segment management APIs
  - name: Server-Side Cloud Script
    description: Server-Side Cloud Script APIs
  - name: Shared Group Data
    description: Shared Group Data APIs
  - name: Title-Wide Data Management
    description: Title-Wide Data Management APIs
  - name: Xbox Store
    description: Xbox Store APIs
paths:
  /Admin/UpdateUserData:
    post:
      tags:
        - Player Data Management
      summary: Update User Data
      description: >-
        Updates the title-specific custom data for the user which is readable
        and writable by the client
      operationId: UpdateUserData
      requestBody:
        $ref: '#/components/requestBodies/UpdateUserDataRequest'
      responses:
        '200':
          $ref: '#/components/responses/UpdateUserDataResult'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security:
        - SecretKey: []
components:
  requestBodies:
    UpdateUserDataRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UpdateUserDataRequest'
      description: >-
        This function performs an additive update of the arbitrary JSON object
        containing the custom data for the user. In updating the custom data
        object, keys which already exist in the object will have their values
        overwritten, while keys with null values will be removed. No other
        key-value pairs will be changed apart from those specified in the call.
  responses:
    UpdateUserDataResult:
      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/UpdateUserDataResult'
            example:
              code: 200
              status: OK
              data:
                DataVersion: 8
    ApiErrorWrapper:
      description: This is the outer wrapper for all responses with errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorWrapper'
  schemas:
    UpdateUserDataRequest:
      description: >-
        This function performs an additive update of the arbitrary JSON object
        containing the custom data for the user. In updating the custom data
        object, keys which already exist in the object will have their values
        overwritten, while keys with null values will be removed. No other
        key-value pairs will be changed apart from those specified in the call.
      type: object
      properties:
        CustomTags:
          description: >-
            The optional custom tags associated with the request (e.g. build
            number, external trace identifiers, etc.).
          type: object
        Data:
          description: >-
            Key-value pairs to be written to the custom data. Note that keys are
            trimmed of whitespace, are limited in size, and may not begin with a
            '!' character or be null.
          type: object
        KeysToRemove:
          description: >-
            Optional list of Data-keys to remove from UserData. Some SDKs cannot
            insert null-values into Data due to language constraints. Use this
            to delete the keys directly.
          type: array
          items:
            type: string
        Permission:
          allOf:
            - $ref: '#/components/schemas/UserDataPermission'
          description: >-
            Permission to be applied to all user data keys written in this
            request. Defaults to "private" if not set.
        PlayFabId:
          description: >-
            Unique PlayFab assigned ID of the user on whom the operation will be
            performed.
          type: string
      required:
        - PlayFabId
      example:
        PlayFabId: '2039475'
        Data:
          Class: Fighter
          Gender: Female
          Icon: Guard 3
          Theme: Colorful
        Permission: Public
    UpdateUserDataResult:
      type: object
      properties:
        DataVersion:
          description: >-
            Indicates the current version of the data that has been set. This is
            incremented with every set call for that type of data (read-only,
            internal, etc). This version can be provided in Get calls to find
            updated data.
          type: number
          x-actualtype: uint32
      required:
        - DataVersion
      example:
        DataVersion: 8
    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
    UserDataPermission:
      description: >-
        Indicates whether a given data key is private (readable only by the
        player) or public (readable by all players). When a player makes a
        GetUserData request about another player, only keys marked Public will
        be returned.
      type: string
      enum:
        - Private
        - Public
  securitySchemes:
    SecretKey:
      type: apiKey
      in: header
      name: X-SecretKey
      description: >-
        This API requires a title secret key, available to title admins, from
        PlayFab Game Manager.

````

## Related topics

- [Update User Data](/api-reference/player-data-management/update-user-data.md)
- [PFPlayerDataManagementUpdateUserDataResult](/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementupdateuserdataresult.md)
- [PFPlayerDataManagementServerUpdateUserDataAsync](/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverupdateuserdataasync.md)
- [PFPlayerDataManagementClientUpdateUserDataRequest](/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementclientupdateuserdatarequest.md)
- [PFPlayerDataManagementServerUpdateUserDataRequest](/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementserverupdateuserdatarequest.md)
