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

# Send a playback lifecycle or progress update

> A watched stop additionally requires history:write because it creates watch history.



## OpenAPI

````yaml /openapi.yaml post /api/platform/v1/playback/{action}
openapi: 3.1.0
info:
  title: PunchPlay API
  version: 1.0.0-beta.3
  description: >-
    Complete beta contract for native and third-party clients, plus the stable
    read-only public profile API. OAuth access tokens use explicit per-operation
    scopes.
  summary: Platform and public API surface for PunchPlay developers.
servers:
  - url: https://punchplay.tv
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: Authentication
  - name: Profile
  - name: Titles
  - name: History
  - name: Ratings
  - name: Lists
  - name: Collection
  - name: Playback
  - name: Calendar
  - name: Community
  - name: Notifications
  - name: Trophies
  - name: Public Catalog
  - name: Public Users
paths:
  /api/platform/v1/playback/{action}:
    parameters:
      - $ref: '#/components/parameters/PlaybackAction'
    post:
      tags:
        - Playback
      summary: Send a playback lifecycle or progress update
      description: >-
        A watched stop additionally requires history:write because it creates
        watch history.
      operationId: sendPlaybackAction
      requestBody:
        $ref: '#/components/requestBodies/PlaybackUpdate'
      responses:
        '200':
          $ref: '#/components/responses/PlaybackActionSuccess'
        '202':
          $ref: '#/components/responses/PlaybackActionSuccess'
        '400':
          $ref: '#/components/responses/ApiError'
        '401':
          $ref: '#/components/responses/ApiError'
        '403':
          $ref: '#/components/responses/ApiError'
        '408':
          $ref: '#/components/responses/ApiError'
        '413':
          $ref: '#/components/responses/ApiError'
        '429':
          $ref: '#/components/responses/ApiError'
      security:
        - oauth2:
            - playback:write
components:
  parameters:
    PlaybackAction:
      in: path
      name: action
      required: true
      schema:
        type: string
        enum:
          - start
          - pause
          - resume
          - stop
          - progress
  requestBodies:
    PlaybackUpdate:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlaybackInput'
  responses:
    PlaybackActionSuccess:
      description: Processed playback action
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlaybackActionResponse'
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Ceiling of the most constraining bucket for this request.
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requests remaining in the current window.
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Unix time in seconds when the current window resets.
    ApiError:
      description: API error
      headers:
        X-PunchPlay-Request-Id:
          schema:
            type: string
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Ceiling of the most constraining bucket for this request.
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requests remaining in the current window.
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Unix time in seconds when the current window resets.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    PlaybackInput:
      type: object
      properties:
        event_id:
          type: string
        media_type:
          type: string
          enum:
            - movie
            - episode
        title:
          type: string
        year:
          type: integer
        imdb_id:
          type: string
        tmdb_id:
          type: integer
        tvdb_id:
          type: integer
        punchplay_id:
          type: string
        season:
          type: integer
        episode:
          type: integer
        episode_end:
          type: integer
        absolute_episode:
          type: integer
        episode_title:
          type: string
        multi_episode:
          type: boolean
        anime:
          type: boolean
        progress:
          type: number
        duration_seconds:
          type: number
        position_seconds:
          type: number
        device_id:
          type: string
        playback_session_id:
          type: string
        event_created_at:
          type: number
        client_version:
          type: string
        watched:
          type: boolean
        watched_threshold:
          type: number
        raw_filename:
          type: string
        jellyfin_user_id:
          type: string
    PlaybackActionResponse:
      type: object
      required:
        - ok
        - media_type
        - tmdb_id
        - tvdb_id
        - imdb_id
        - punchplay_id
      properties:
        ok:
          type: boolean
          const: true
        media_type:
          type: string
          enum:
            - movie
            - episode
        tmdb_id:
          type:
            - integer
            - 'null'
        tvdb_id:
          type:
            - integer
            - 'null'
        imdb_id:
          type:
            - string
            - 'null'
        punchplay_id:
          type:
            - string
            - 'null'
        deduped:
          type: boolean
        ignored:
          type: string
        season:
          type: integer
        episode:
          type: integer
        episode_end:
          type: integer
        absolute_episode:
          type: integer
        anime:
          type: boolean
      additionalProperties: false
    ApiError:
      type: object
      required:
        - error
        - message
        - request_id
      properties:
        error:
          type: string
        message:
          type: string
        request_id:
          type:
            - string
            - 'null'
        required_scope:
          type: string
      additionalProperties: true
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /api/platform/v1/oauth/authorize
          tokenUrl: /api/platform/v1/oauth/token
          scopes:
            profile:read: Read basic profile and title metadata
            history:read: Read watch history
            history:write: Log, edit, and delete watches
            lists:read: Read lists
            lists:write: Create and edit lists
            ratings:read: Read ratings, favourites, and statuses
            ratings:write: Rate, favourite, and change statuses
            collection:read: Read collection items
            collection:write: Add and remove collection items
            notifications:read: Read notifications and notification preferences
            notifications:write: Manage notification read state and preferences
            trophies:read: Read trophy progress
            profile:write: Update profile details and preferences
            playback:read: Read playback and continue-watching state
            playback:write: Update playback state
            events:read: Subscribe to playback events

````