Sign in

v1

latestOpenAPI 3.0.32026-07-26120117318.1 KB
Screens

Update a screen

Updates a screen's name. All mutable fields must be provided.

put/screens/{screen_id}

Path parameters

screen_idstring required

Screen identifier.

Request body

namestring required

New name for the screen. Must be 1–256 characters.

Example request

{
  "name": "Updated Paywall Name"
}

Response

Updated screen.

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"
}