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

# Update player game progress

> Update XP, level, currencies, or lives



## OpenAPI

````yaml /api-reference/openapi.json patch /players/{id}/progress
openapi: 3.0.0
info:
  title: EngageFabric API
  description: >-
    EngageFabric is a multi-tenant SaaS gamification framework. This API
    provides endpoints for managing players, tracking events, quests,
    adventures, leaderboards, lobbies, and real-time features.
  version: 1.0.0
  contact:
    name: EngageFabric Support
    url: https://engagefabric.com
    email: support@engagefabric.com
  license:
    name: Proprietary
    url: https://engagefabric.com/terms
servers:
  - url: https://api.engagefabric.com
    description: Production
  - url: http://localhost:3000
    description: Development
security: []
tags:
  - name: auth
    description: Authentication endpoints
  - name: tenants
    description: Tenant management
  - name: projects
    description: Project management
  - name: players
    description: Player management and game state
  - name: events
    description: Event ingestion and tracking
  - name: quests
    description: Quest management and progress
  - name: adventures
    description: Adventure/season management
  - name: leaderboards
    description: Leaderboard rankings
  - name: lobbies
    description: Multiplayer lobby management
  - name: chat
    description: Real-time chat
  - name: rules
    description: Rules engine configuration
paths:
  /players/{id}/progress:
    patch:
      tags:
        - players
      summary: Update player game progress
      description: Update XP, level, currencies, or lives
      operationId: PlayerController_updateProgress
      parameters:
        - name: id
          required: true
          in: path
          description: Player UUID
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePlayerProgressDto'
      responses:
        '200':
          description: Player progress updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlayerEntity'
        '404':
          description: Player not found
      security:
        - api-key: []
components:
  schemas:
    UpdatePlayerProgressDto:
      type: object
      properties:
        xp:
          type: number
          description: Player XP
          example: 1500
          minimum: 0
        level:
          type: number
          description: Player level
          example: 10
          minimum: 1
        lives:
          type: number
          description: Player lives/energy
          example: 3
          minimum: 0
        maxLives:
          type: number
          description: Maximum lives
          example: 5
          minimum: 1
        currencies:
          type: object
          description: Player currencies (key-value pairs)
          example:
            coins: 500
            gems: 50
    PlayerEntity:
      type: object
      properties:
        id:
          type: string
          description: Unique player identifier
          example: 123e4567-e89b-12d3-a456-426614174000
        projectId:
          type: string
          description: Project ID this player belongs to
          example: 123e4567-e89b-12d3-a456-426614174000
        externalUserId:
          type: string
          description: External user ID from client application
          example: user_12345
        displayName:
          type: object
          description: Player display name
          example: John Doe
        avatarUrl:
          type: object
          description: Player avatar URL
          example: https://example.com/avatars/johndoe.png
        locale:
          type: object
          description: Player locale
          example: en-US
        xp:
          type: number
          description: Player XP
          example: 1250
        level:
          type: number
          description: Player level
          example: 5
        lives:
          type: number
          description: Current lives/energy
          example: 3
        maxLives:
          type: number
          description: Maximum lives
          example: 5
        livesUpdatedAt:
          format: date-time
          type: string
          description: Last time lives were updated
          example: '2025-01-15T10:30:00Z'
        currencies:
          type: object
          description: Player currencies (key-value pairs)
          example:
            coins: 500
            gems: 50
        status:
          type: string
          description: Player status
          enum:
            - ACTIVE
            - SUSPENDED
            - BANNED
          example: ACTIVE
        isFlagged:
          type: boolean
          description: Whether player is flagged for review
          example: false
        flagReason:
          type: object
          description: Reason for flagging
          example: null
        metadata:
          type: object
          description: Additional player metadata
          example:
            accountType: premium
        createdAt:
          format: date-time
          type: string
          description: Creation timestamp
          example: '2025-01-15T10:30:00Z'
        updatedAt:
          format: date-time
          type: string
          description: Last update timestamp
          example: '2025-01-15T10:30:00Z'
        deletedAt:
          type: object
          description: Soft deletion timestamp
          example: null
        lastSeenAt:
          format: date-time
          type: string
          description: Last activity timestamp
          example: '2025-01-15T10:30:00Z'
      required:
        - id
        - projectId
        - externalUserId
        - xp
        - level
        - lives
        - maxLives
        - livesUpdatedAt
        - currencies
        - status
        - isFlagged
        - createdAt
        - updatedAt
        - lastSeenAt

````