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

# PATCH /screens/{id}

> Workspace-owned resources only. No unsupported query parameters on details or writes. Required permissions: screens.update. Use Postman or your backend. Keep your API key private; do not enter it in this public documentation page.

Required permissions: `screens.update`.

Send an `Idempotency-Key` for this change. It is an operation ID, not an API key. [Generate a UUID](https://docs.layarva.com/developers/platform-request-keys.md) and reuse it when retrying the same request.

> [!NOTE]
>
> Use your Platform API key in Postman or your backend. Keep it private; do not enter it in this public page. Your workspace permissions and plan limits apply.

See the [quickstart](https://docs.layarva.com/developers/platform-quickstart.md) for request examples. Required fields and responses are listed below.


## OpenAPI

````yaml api/platform-workspace.openapi.json PATCH /screens/{id}
openapi: 3.1.0
info:
  title: Layarva Platform / Workspace API
  version: 1.1.0
  description: >-
    Manage Library, Playlists, Channels, Locations, Edges, Screens and
    Schedules. Use a Platform key, not a Widget key. See
    https://docs.layarva.com/developers/platform-quickstart. Upload supported
    files, export eligible offline packages and receive signed Platform
    webhooks. Permissions, plan limits and publishing rules apply. If a request
    returns 503, stop that workflow and contact support with its requestId.
servers:
  - url: https://api.layarva.com/api/platform/v1/workspaces/{workspaceId}
    variables:
      workspaceId:
        default: workspace_example
security:
  - PlatformBearer: []
paths:
  /screens/{id}:
    patch:
      tags:
        - screens
      summary: PATCH /screens/{id}
      description: >-
        Workspace-owned resources only. No unsupported query parameters on
        details or writes. Required permissions: screens.update. Use Postman or
        your backend. Keep your API key private; do not enter it in this public
        documentation page.
      operationId: patch__screens_id
      parameters:
        - name: id
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Id'
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            pattern: ^[A-Za-z0-9._:-]{1,128}$
          description: >-
            An operation ID, not your API key. Generate a UUID for each new
            change and reuse it when retrying the same request. See
            https://docs.layarva.com/developers/platform-request-keys for
            Postman, PowerShell and Node.js examples. Upload instructions are
            refreshed when requested again.
      requestBody:
        required: true
        description: >-
          Send application/json using the fields below. JSON requests must be no
          larger than 64 KiB.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreenUpdate'
      responses:
        '200':
          description: Safe live-authorized result
          headers:
            X-Request-Id:
              schema:
                type: string
            Cache-Control:
              schema:
                const: private, no-store
            X-RateLimit-Limit:
              schema:
                type: string
            X-RateLimit-Remaining:
              schema:
                type: string
            Idempotency-Replayed:
              schema:
                enum:
                  - 'true'
                  - 'false'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Screen'
                required:
                  - data
                additionalProperties: false
        default:
          description: >-
            Error with code, message and requestId. Follow Retry-After when
            present. Contact support with the requestId if the problem
            continues.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            X-Request-Id:
              schema:
                type: string
            Retry-After:
              schema:
                type: string
components:
  schemas:
    Id:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: string
      pattern: ^[A-Za-z0-9_-]{1,100}$
    ScreenUpdate:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
        channelId:
          anyOf:
            - type: string
              pattern: ^[A-Za-z0-9_-]{1,100}$
            - type: 'null'
        locationId:
          anyOf:
            - type: string
              pattern: ^[A-Za-z0-9_-]{1,100}$
            - type: 'null'
        clientId:
          anyOf:
            - type: string
              pattern: ^[A-Za-z0-9_-]{1,100}$
            - type: 'null'
        displayConfig:
          type: object
          properties:
            targetWidthPx:
              type: integer
              minimum: 320
              maximum: 7680
            targetHeightPx:
              type: integer
              minimum: 240
              maximum: 4320
            contentFitMode:
              type: string
              enum:
                - FIT
                - FILL
                - STRETCH
                - CUSTOM
            contentAnchor:
              type: string
              enum:
                - TOP_LEFT
                - TOP
                - TOP_RIGHT
                - LEFT
                - CENTER
                - RIGHT
                - BOTTOM_LEFT
                - BOTTOM
                - BOTTOM_RIGHT
            contentZoomPct:
              type: integer
              minimum: 25
              maximum: 400
            contentOffsetXPct:
              type: integer
              minimum: -100
              maximum: 100
            contentOffsetYPct:
              type: integer
              minimum: -100
              maximum: 100
          required:
            - targetWidthPx
            - targetHeightPx
            - contentFitMode
            - contentAnchor
            - contentZoomPct
            - contentOffsetXPct
            - contentOffsetYPct
          additionalProperties: false
      additionalProperties: false
    Screen:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        channelId:
          anyOf:
            - type: string
            - type: 'null'
        locationId:
          anyOf:
            - type: string
            - type: 'null'
        clientId:
          anyOf:
            - type: string
            - type: 'null'
        status:
          enum:
            - ONLINE
            - OFFLINE
        storedStatus:
          type: string
        paired:
          type: boolean
        deliveryMode:
          enum:
            - CLOUD
            - EDGE
            - OFFLINE
        edgeDeviceId:
          anyOf:
            - type: string
            - type: 'null'
        playbackEnabled:
          type: boolean
        videoMuted:
          type: boolean
        targetWidthPx:
          type: number
        targetHeightPx:
          type: number
        contentFitMode:
          type: string
        contentAnchor:
          type: string
        contentZoomPct:
          type: number
        contentOffsetXPct:
          type: number
        contentOffsetYPct:
          type: number
        unlockConfigured:
          type: boolean
        lastPingAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        createdAt:
          type: string
          format: date-time
      required:
        - id
      additionalProperties: false
      description: >-
        List/detail projection excludes clientId/unlockConfigured; mutation
        projection may include them. status is derived from current heartbeat,
        storedStatus is historical; paired has no device token.
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            requestId:
              type: string
          required:
            - code
            - message
            - requestId
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    PlatformBearer:
      type: http
      scheme: bearer
      bearerFormat: lv_platform_<43 base64url characters>
      description: >-
        Platform API key for one workspace. Create it in Settings with an expiry
        date or Never expire. Keep it private; use it from Postman or your
        backend, not browser code. Widget keys are not accepted.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.