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

# Publish a screen

> Publishes a screen, setting its status to `published`.
No request body is required.




## OpenAPI

````yaml /api-reference/rest-api-v4.yaml post /screens/{screen_id}/publish
openapi: 3.0.3
info:
  title: Qonversion REST API v4
  version: '4.0'
  description: >-
    Qonversion REST API v4 follows REST standards. It has predictable
    resource-oriented URLs, accepts JSON-encoded request bodies, returns
    JSON-encoded responses, and uses standard HTTP response codes,
    authentication, and verbs.
servers:
  - url: https://api.qonversion.io/v4
    description: Production
security:
  - secretAuth: []
tags:
  - name: Users
    description: Retrieve Qonversion users
  - name: User Properties
    description: Manage user-level attributes
  - name: Identities
    description: Link Qonversion users to your own auth IDs
  - name: Entitlements
    description: Entitlement definitions and user grants
  - name: Purchases
    description: A user's purchase history
  - name: Products
    description: Products configured in the Qonversion dashboard
  - name: Customers
    description: Aggregated customer records, properties, permissions, and metrics
  - name: Segments
    description: Dynamic and system segments of users
  - name: Experiments
    description: Paywall and offering A/B experiments
  - name: Screens
    description: No-code paywall screens — CRUD, publish, analytics
  - name: Analytics
    description: Charts, cards, cohorts, LTV, and insights
  - name: Exports
    description: Asynchronous data exports
  - name: Events
    description: Event catalog
  - name: Scheduled Reports
    description: Recurring reports delivered to external destinations
  - name: Integrations
    description: Third-party integrations configuration
  - name: Automations
    description: Event-driven automations
  - name: Project Settings
    description: Project-level configuration, secret, and store credentials
paths:
  /screens/{screen_id}/publish:
    post:
      tags:
        - Screens
      summary: Publish a screen
      description: |
        Publishes a screen, setting its status to `published`.
        No request body is required.
      operationId: v4PublishScreen
      parameters:
        - name: screen_id
          in: path
          required: true
          description: Screen identifier.
          schema:
            type: string
            pattern: ^[a-zA-Z0-9._-]+$
            maxLength: 256
          example: scr_abc123
      responses:
        '200':
          description: Published screen.
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-cache
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Screen'
        '400':
          description: Invalid screen_id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '403':
          description: Insufficient permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '404':
          description: Screen not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '502':
          description: Upstream service failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
        '504':
          description: Upstream timeout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V4Error'
      security:
        - secretAuth: []
components:
  schemas:
    V4Screen:
      description: |
        Full screen representation returned by `GET /v4/screens/{screen_id}`.
        Extends `V4ScreenSummary` with the render-time fields an SDK needs
        to initialise and display a paywall (DEV-777).
      allOf:
        - $ref: '#/components/schemas/V4ScreenSummary'
        - type: object
          required:
            - background
            - default_lang
            - configs
            - prod_key
            - sandbox_key
            - content
            - used
          properties:
            background:
              type: string
              nullable: true
              description: CSS background for the paywall root element.
            default_lang:
              type: string
              nullable: true
              description: |
                Default localisation key. When the SDK can't match the user's
                locale it falls back to this language.
              example: en
            configs:
              description: |
                Base screen configuration. Opaque JSON blob consumed by the
                Qonversion SDK — shape is defined by the no-code editor and
                MAY evolve without a version bump.
            prod_key:
              type: string
              nullable: true
              description: |
                SDK integration key used in production builds. Load-bearing —
                the SDK cannot render the screen without it.
            sandbox_key:
              type: string
              nullable: true
              description: SDK integration key for sandbox / test builds.
            content:
              description: |
                Localised screen content keyed by language code
                (e.g. `{ "en": {...}, "ru": {...} }`). Each value is an
                opaque JSON blob consumed by the SDK renderer.
            used:
              type: array
              items:
                type: string
              description: UIDs of triggers currently targeting this screen.
    V4Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              enum:
                - request
                - resource
                - logical
                - internal
            code:
              type: string
              description: |
                Machine-readable snake_case error code. Examples include
                `invalid_data`, `invalid_request`, `invalid_product_id`,
                `not_found`, `already_exists`, `offering_already_exists`,
                `product_not_in_project`, `cannot_set_main_directly`,
                `cannot_demote_main`, `cannot_patch_experiment_variant`,
                `cannot_delete_experiment_variant`, and
                `cannot_setmain_experiment_variant`. Resource-specific codes
                are documented on the corresponding reference page.
            message:
              type: string
              description: Human-readable description. May change; do not parse.
            details:
              type: array
              nullable: true
              description: Per-field validation errors, present on 400 validation failures.
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
    V4ScreenSummary:
      type: object
      required:
        - object
        - id
        - url
        - name
        - status
        - is_web
        - created_at
        - updated_at
      description: |
        Lean screen representation used on list endpoints. Omits render-time
        fields (`configs`, `content`, `prod_key`, `sandbox_key`, `used`,
        etc.) to keep paginated walks cheap. Fetch `V4Screen` via
        `GET /v4/screens/{screen_id}` for the full render payload.
      properties:
        object:
          type: string
          enum:
            - screen
        id:
          type: string
          example: scr_abc123
        url:
          type: string
          example: /v4/screens/scr_abc123
        name:
          type: string
          example: Onboarding Paywall
        status:
          type: string
          x-extensible-enum:
            - legacy
            - draft
            - published
            - modified
          example: published
        type:
          type: string
          nullable: true
          x-extensible-enum:
            - paywall
            - web_flow
            - onboarding
        context_key:
          type: string
          nullable: true
        is_web:
          type: boolean
          default: false
        created_at:
          type: string
          format: date-time
          example: '2025-09-15T12:30:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2025-11-03T10:26:40Z'
  securitySchemes:
    secretAuth:
      type: http
      scheme: bearer
      bearerFormat: sk_…
      description: >-
        Bearer authentication using the project **Secret Key** (prefixed with
        `sk_`, or `test_sk_` for sandbox). All v4 public endpoints require the
        Secret Key — see [Authentication](/reference/v4/authentication). Never
        expose the Secret Key in client-side code.

````