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

# Increment Leaderboard Version

> Increment a leaderboard version.

Allowed entity token types: title, game_server

## Error codes

This operation may return the following PlayFab errors:

| Error | Code |
| --- | --- |
| ConcurrentEditError | 1133 |
| ExternalEntityNotAllowedForTier | 1580 |
| InvalidVersionResetForLinkedLeaderboard | 1601 |
| LeaderboardDefinitionModificationNotAllowedWhileLinked | 1576 |
| LeaderboardNotFound | 1567 |
| VersionIncrementRateExceeded | 1599 |




## OpenAPI

````yaml post /Leaderboard/IncrementLeaderboardVersion
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/IncrementLeaderboardVersion:
    post:
      tags:
        - Leaderboards
      summary: Increment Leaderboard Version
      description: |
        Increment a leaderboard version.

        Allowed entity token types: title, game_server

        ## Error codes

        This operation may return the following PlayFab errors:

        | Error | Code |
        | --- | --- |
        | ConcurrentEditError | 1133 |
        | ExternalEntityNotAllowedForTier | 1580 |
        | InvalidVersionResetForLinkedLeaderboard | 1601 |
        | LeaderboardDefinitionModificationNotAllowedWhileLinked | 1576 |
        | LeaderboardNotFound | 1567 |
        | VersionIncrementRateExceeded | 1599 |
      operationId: IncrementLeaderboardVersion
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncrementLeaderboardVersionRequest'
      responses:
        '200':
          $ref: '#/components/responses/IncrementLeaderboardVersionResponse'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security:
        - EntityToken: []
components:
  schemas:
    IncrementLeaderboardVersionRequest:
      type: object
      properties:
        CustomTags:
          description: >-
            The optional custom tags associated with the request (e.g. build
            number, external trace identifiers, etc.).
          type: object
        Name:
          description: The name of the leaderboard to increment the version for.
          type: string
      required:
        - Name
      example:
        Name: HighestScoresByLevel
    IncrementLeaderboardVersionResponse:
      type: object
      properties:
        Version:
          description: New Leaderboard version.
          type: number
          x-actualtype: uint32
      required:
        - Version
      example:
        Version: 89
    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:
    IncrementLeaderboardVersionResponse:
      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/IncrementLeaderboardVersionResponse'
            example:
              code: 200
              status: OK
              data:
                Version: 89
    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

- [Increment Leaderboard Version](/api-reference/leaderboards/increment-leaderboard-version.md)
- [PFLeaderboardsIncrementLeaderboardVersionRequest](/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsincrementleaderboardversionrequest.md)
- [PFLeaderboardsIncrementLeaderboardVersionAsync](/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsincrementleaderboardversionasync.md)
- [PFLeaderboardsIncrementLeaderboardVersionResponse](/services/playfab/api-references/c/pfleaderboardstypes/structs/pfleaderboardsincrementleaderboardversionresponse.md)
- [PFLeaderboardsIncrementLeaderboardVersionGetResult](/services/playfab/api-references/c/pfleaderboards/functions/pfleaderboardsincrementleaderboardversiongetresult.md)
