v1

latestOpenAPI 3.0.32026-07-26120117318.1 KB

Screens

Create a screen

Creates a new screen skeleton for the authenticated project.

The created screen has no visual content yet — it is a placeholder you then open in the Qonversion dashboard to lay out components, upload media, and add localisations. Render-time fields (background, default_lang, configs, content, prod_key, sandbox_key) are populated by the dashboard editor, not by this endpoint.

Returns 201 Created with the newly created V4Screen and a Location header pointing at GET /v4/screens/{screen_id}.

post/screens

Request body

namestring required

Human-readable name for the new screen. Must be 1–256 characters.

Example request

{
  "name": "Summer Paywall"
}

Response

Screen created successfully.

object'screen' required

idstring required

urlstring required

namestring required

statusstring required

typestring nullable

context_keystring nullable

is_webboolean required

created_atstring date-time required

updated_atstring date-time required

backgroundstring nullable required

CSS background for the paywall root element.

default_langstring nullable required

Default localisation key. When the SDK can't match the user's locale it falls back to this language.

{"stackTrail":"components:schemas:V4Screen:allOf:properties:configs","oasType":"schema","type":"unknown","description":"Base screen configuration. Opaque JSON blob consumed by the\nQonversion SDK — shape is defined by the no-code editor and\nMAY evolve without a version bump.\n"}

prod_keystring nullable required

SDK integration key used in production builds. Load-bearing — the SDK cannot render the screen without it.

sandbox_keystring nullable required

SDK integration key for sandbox / test builds.

{"stackTrail":"components:schemas:V4Screen:allOf:properties:content","oasType":"schema","type":"unknown","description":"Localised screen content keyed by language code\n(e.g. `{ \"en\": {...}, \"ru\": {...} }`). Each value is an\nopaque JSON blob consumed by the SDK renderer.\n"}

usedstring[] required

UIDs of triggers currently targeting this screen.

Example response

{
  "id": "scr_abc123",
  "url": "/v4/screens/scr_abc123",
  "name": "Onboarding Paywall",
  "status": "published",
  "created_at": "2025-09-15T12:30:00Z",
  "updated_at": "2025-11-03T10:26:40Z",
  "default_lang": "en"
}