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

# Delete Player Custom Properties

> Deletes title-specific custom properties for a player

## Error codes

This operation may return the following PlayFab errors:

| Error | Code |
| --- | --- |
| PlayerCustomPropertiesVersionMismatch | 19004 |
| ProductDisabledForTitle | 1609 |




## OpenAPI

````yaml post /Admin/DeletePlayerCustomProperties
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/DeletePlayerCustomProperties:
    post:
      tags:
        - Player Data Management
      summary: Delete Player Custom Properties
      description: |
        Deletes title-specific custom properties for a player

        ## Error codes

        This operation may return the following PlayFab errors:

        | Error | Code |
        | --- | --- |
        | PlayerCustomPropertiesVersionMismatch | 19004 |
        | ProductDisabledForTitle | 1609 |
      operationId: DeletePlayerCustomProperties
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeletePlayerCustomPropertiesRequest'
        description: >-
          Deletes custom properties for the specified player. The list of
          provided property names must be non-empty.
      responses:
        '200':
          $ref: '#/components/responses/DeletePlayerCustomPropertiesResult'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security:
        - SecretKey: []
components:
  schemas:
    DeletePlayerCustomPropertiesRequest:
      description: >-
        Deletes custom properties for the specified player. The list of provided
        property names must be non-empty.
      type: object
      properties:
        CustomTags:
          description: >-
            The optional custom tags associated with the request (e.g. build
            number, external trace identifiers, etc.).
          type: object
        ExpectedPropertiesVersion:
          description: >-
            Optional field used for concurrency control. One can ensure that the
            delete operation will only be performed if the player's properties
            have not been updated by any other clients since the last version.
          type: number
          x-actualtype: int32
        PlayFabId:
          description: >-
            Unique PlayFab assigned ID of the user on whom the operation will be
            performed.
          type: string
        PropertyNames:
          description: >-
            A list of property names denoting which properties should be
            deleted.
          type: array
          items:
            type: string
      required:
        - PlayFabId
        - PropertyNames
      example:
        PlayFabId: '2039475'
        PropertyNames:
          - level
          - created
        ExpectedPropertiesVersion: 12
    DeletePlayerCustomPropertiesResult:
      type: object
      properties:
        DeletedProperties:
          description: The list of properties requested to be deleted.
          type: array
          items:
            $ref: '#/components/schemas/DeletedPropertyDetails'
          x-isclass: true
        PlayFabId:
          description: PlayFab unique identifier of the user whose properties were deleted.
          type: string
        PropertiesVersion:
          description: >-
            Indicates the current version of a player's properties that have
            been set. This is incremented after updates and deletes. This
            version can be provided in update and delete calls for concurrency
            control.
          type: number
          x-actualtype: int32
      required:
        - PropertiesVersion
      example:
        PlayFabId: '2039475'
        DeletedProperties:
          - Name: level
            WasDeleted: true
          - Name: class
        PropertiesVersion: 13
    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
    DeletedPropertyDetails:
      type: object
      properties:
        Name:
          description: The name of the property which was requested to be deleted.
          type: string
        WasDeleted:
          description: >-
            Indicates whether or not the property was deleted. If false, no
            property with that name existed.
          type: boolean
      required:
        - WasDeleted
  responses:
    DeletePlayerCustomPropertiesResult:
      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/DeletePlayerCustomPropertiesResult'
            example:
              code: 200
              status: OK
              data:
                PlayFabId: '2039475'
                DeletedProperties:
                  - Name: level
                    WasDeleted: true
                  - Name: class
                PropertiesVersion: 13
    ApiErrorWrapper:
      description: This is the outer wrapper for all responses with errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorWrapper'
  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

- [Delete Player Custom Properties](/services/playfab/api-references/rest/client/player-data-management/delete-player-custom-properties.md)
- [Player Custom Properties](/services/playfab/live-service-management/game-configuration/segmentation/player-custom-properties.md)
- [PFPlayerDataManagementServerDeletePlayerCustomPropertiesAsync](/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementserverdeleteplayercustompropertiesasync.md)
- [PFPlayerDataManagementClientDeletePlayerCustomPropertiesAsync](/services/playfab/api-references/c/pfplayerdatamanagement/functions/pfplayerdatamanagementclientdeleteplayercustompropertiesasync.md)
- [PFPlayerDataManagementServerDeletePlayerCustomPropertiesRequest](/services/playfab/api-references/c/pfplayerdatamanagementtypes/structs/pfplayerdatamanagementserverdeleteplayercustompropertiesrequest.md)
