Create a landing page display

Creates a new display for an existing landing page. The request body below documents the HTML Mode page display payload. Saving the first checkout form initializes an unbound page's store_id from form_display.store_id immediately, before publication. The store must belong to the same business. An existing page store association is retained and cannot be changed or cleared by later display saves.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Numeric Scalev landing page ID.

Body Params

A new version for an existing landing page. Omitted HTML source, metadata, CSP policy and checkout configuration retain the preceding version's values. A supplied legacy code snapshot is converted on content save.

Settings-only versions may omit source fields. An omitted form_display preserves checkout configuration; explicit null removes the form only where the page's existing store-context rules allow it. Clearing an authoritative html_document is rejected with 422.

string
enum

HTML Mode requests use html_mode. Builder payload details are intentionally not documented here and remain unsupported for public integration guidance; use HTML Mode for API-created pages.

Allowed:
string | null

Complete authored HTML source for HTML Mode. A non-whitespace value is authoritative and replaces all legacy html_code, css_code, js_code and additional_head_code inputs for rendering. Null, empty and whitespace-only values on legacy records use the legacy source. Reading and validation do not persist migration. Existing clients may continue sending html_code, css_code and js_code instead of html_document, including after a previous version used unified source. Send all three fields for a complete legacy snapshot, using empty strings for intentionally blank sections. Include additional_head_code when needed; omitted snapshot sections are empty. Legacy snapshots are automatically assembled into a document on every HTML Mode content save. Settings-only version writes preserve the preceding source. Clearing an already migrated document returns 422; save for a deliberately blank page. Platform runtime, tokens, analytics and public data are injected only when rendered and must not be included in this field. External scripts, stylesheets, import maps and document attributes are retained. Dependencies still require directive-specific permission in csp_policy. CSP meta tags are retained in source but ignored at execution with a validation warning.

string
length ≤ 204800

Supported legacy body-only HTML input. Existing clients may continue sending html_code, css_code and js_code as a complete snapshot, including after unified versions. New integrations should send html_document. A new display version using legacy code fields uses snapshot semantics, so omitted code sections are empty rather than copied from a prior version.

string
length ≤ 102400

Supported legacy CSS input; include with html_code and js_code for a complete legacy snapshot. A nonempty html_document takes precedence.

string
length ≤ 102400

Supported legacy JavaScript input; include with html_code and css_code for a complete legacy snapshot. A nonempty html_document takes precedence.

string

Additional HTML Mode document head code. Supports title, meta, link, style, script, and noscript tags. User-authored entries override managed SEO, crawler, and favicon convenience tags with the same identity, but do not override Scalev runtime tags or the document language.

csp_policy
object

Supported HTML Mode CSP keys. Unsupported keys are rejected.

meta
object
form_display
object | null

HTML Checkout configuration. Omit or send null for HTML Sales pages.

fb_pixel_ids
array of integers

Scalev record IDs for Meta/Facebook pixels to attach to this page display. These are the numeric Scalev pixel records, not the provider pixel code. Send an empty array for no Meta/Facebook pixels.

fb_pixel_ids
tiktok_pixel_ids
array of integers

Scalev record IDs for TikTok pixels to attach to this page display. These are the numeric Scalev pixel records, not the provider pixel code. Send an empty array for no TikTok pixels.

tiktok_pixel_ids
kwai_client_pixel_ids
array of integers

Scalev record IDs for SnackVideo browser pixels to attach to this page display. Send an empty array for no SnackVideo browser pixels.

kwai_client_pixel_ids
kwai_server_pixel_ids
array of integers

Scalev record IDs for SnackVideo Events API pixels to attach to this page display. Send an empty array for no SnackVideo server pixels.

kwai_server_pixel_ids
onload_fb_events
array of strings

Meta/Facebook events fired automatically when the page loads.

onload_fb_events
onload_tiktok_events
array of strings

TikTok events fired automatically when the page loads.

onload_tiktok_events
onload_kwai_client_events
array of strings

SnackVideo browser events fired automatically when the page loads.

onload_kwai_client_events
onload_kwai_server_events
array of strings

SnackVideo server events fired automatically when the page loads.

onload_kwai_server_events
fb_events_onload_parameters
object
tiktok_events_onload_parameters
object
kwai_client_events_onload_parameters
object
kwai_server_events_onload_parameters
object
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json