> ## 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 Leaderboard Entries

> Adds or updates entries on the specified leaderboard.

Allowed entity token types: title, game_server, title_player_account

## Error codes

This operation may return the following PlayFab errors:

| Error | Code |
| --- | --- |
| APINotEnabledForGameClientAccess | 1082 |
| LeaderboardColumnLengthMismatch | 1562 |
| LeaderboardNotFound | 1567 |
| LeaderboardUpdateNotAllowedWhileLinked | 1578 |
| MetadataLengthExceeded | 23014 |




## OpenAPI

````yaml post /Leaderboard/UpdateLeaderboardEntries
openapi: 3.0.0
info:
  version: '260922'
  title: PlayFab Progression API
  description: Manage entity statistics Manage entity leaderboards
  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: Leaderboards
    description: Leaderboards APIs
  - name: Statistics
    description: Statistics APIs
paths:
  /Leaderboard/UpdateLeaderboardEntries:
    post:
      tags:
        - Leaderboards
      summary: Update Leaderboard Entries
      description: |
        Adds or updates entries on the specified leaderboard.

        Allowed entity token types: title, game_server, title_player_account

        ## Error codes

        This operation may return the following PlayFab errors:

        | Error | Code |
        | --- | --- |
        | APINotEnabledForGameClientAccess | 1082 |
        | LeaderboardColumnLengthMismatch | 1562 |
        | LeaderboardNotFound | 1567 |
        | LeaderboardUpdateNotAllowedWhileLinked | 1578 |
        | MetadataLengthExceeded | 23014 |
      operationId: UpdateLeaderboardEntries
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLeaderboardEntriesRequest'
      responses:
        '200':
          $ref: '#/components/responses/EmptyResponse'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security:
        - EntityToken: []
components:
  schemas:
    UpdateLeaderboardEntriesRequest:
      type: object
      properties:
        CustomTags:
          description: >-
            The optional custom tags associated with the request (e.g. build
            number, external trace identifiers, etc.).
          type: object
        Entries:
          description: The entries to add or update on the leaderboard.
          type: array
          items:
            $ref: '#/components/schemas/LeaderboardEntryUpdate'
          x-isclass: true
        LeaderboardName:
          description: The name of the leaderboard.
          type: string
      required:
        - LeaderboardName
      example:
        LeaderboardName: Points
        Entries:
          - Scores:
              - '100'
              - '200'
            EntityId: '12802710371'
          - Scores:
              - '120'
              - '200'
            EntityId: '01849174301'
    LeaderboardEntryUpdate:
      type: object
      properties:
        EntityId:
          description: >-
            The unique Id for the entry. If using PlayFab Entities, this would
            be the entityId of the entity.
          type: string
        Metadata:
          description: >-
            Arbitrary metadata to store along side the leaderboard entry, will
            be returned by all Leaderboard APIs.
          type: string
        Scores:
          description: >-
            The scores for the leaderboard. The number of values provided here
            must match the number of columns in the Leaderboard definition.
          type: array
          items:
            type: string
      required:
        - EntityId
    EmptyResponse:
      type: object
      properties: {}
    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
  responses:
    EmptyResponse:
      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/EmptyResponse'
    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

- [Update Leaderboard Entries](/api-reference/leaderboards/update-leaderboard-entries.md)
- [PFLeaderboardsUpdateLeaderboardEntriesRequest](/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsupdateleaderboardentriesrequest.md)
- [PFLeaderboardsUpdateLeaderboardEntriesAsync](/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsupdateleaderboardentriesasync.md)
- [Leaderboards Meters](/services/playfab/pricing/meters/leaderboard-meters.md)
- [PFLeaderboardsDeleteLeaderboardEntriesAsync](/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsdeleteleaderboardentriesasync.md)