Landing Pages

Create a landing page display

Changed on

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.

post/v3/pages/{page_id}/page-displays

Request

  • Base URL
    https://api.scalev.com
  • URL
    https://api.scalev.com/v3/pages/{page_id}/page-displays
  • Auth
    • HTTP bearer
    • or API key in header authorization
    • or OAuth 2
      Authorization code: https://api.scalev.com/v3/oauth/authorize
      Token URL: https://api.scalev.com/v3/oauth/token scopes: page:update

Request body

tracking_config_write_version1 required

Required beside every supplied tracking_config, including new page creation. Version 1 declares that the writer preserves same-name channel bindings, initialization markers, legacy_document_only, legacy_document_server_only, parameter_variants and additional event metadata. It is a request capability, separate from tracking_config.schema_version. Missing or unsupported versions return 409; update the client and reload the current editor response before retrying. Omit for legacy-only writes.

tracking_config_revisionstring

Required with tracking_config for an existing owner. Use the current editor response revision and tracking_config_write_version; stale edits or unsupported writers are rejected with 409. Asset and trigger changes are atomic.

render_modeRenderMode (unresolved $ref)
html_documentstring nullable

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 <!doctype html><html><head></head><body></body></html> 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.

html_codeHtmlCode (unresolved $ref)
css_codeCssCode (unresolved $ref)
js_codeJsCode (unresolved $ref)
additional_head_codeAdditionalHeadCode (unresolved $ref)
metaMeta (unresolved $ref)
form_displayFormDisplay (unresolved $ref)
google_ads_destination_idsstring[]

Business-owned Scalev Google Ads destination IDs. Server purchase timing follows the store Meta CAPI triggers.

fb_pixel_idsFbPixelIds (unresolved $ref)
tiktok_pixel_idsTiktokPixelIds (unresolved $ref)
kwai_client_pixel_idsKwaiClientPixelIds (unresolved $ref)
kwai_server_pixel_idsKwaiServerPixelIds (unresolved $ref)
onload_fb_eventsOnloadFbEvents (unresolved $ref)
onload_tiktok_eventsOnloadTiktokEvents (unresolved $ref)
onload_kwai_client_eventsOnloadKwaiClientEvents (unresolved $ref)
onload_kwai_server_eventsOnloadKwaiServerEvents (unresolved $ref)
fb_events_onload_parametersFbEventsOnloadParameters (unresolved $ref)
tiktok_events_onload_parametersTiktokEventsOnloadParameters (unresolved $ref)
kwai_client_events_onload_parametersKwaiClientEventsOnloadParameters (unresolved $ref)
kwai_server_events_onload_parametersKwaiServerEventsOnloadParameters (unresolved $ref)

Response

Landing page display

tracking_form_delivery'server_v1'

Public runtime capability present only with a saved tracking_config, including an explicitly empty configuration. Absent for unmigrated displays and editor-only resolved defaults. A compatible runtime copies this value into checkout metadata, then waits for the accepted order's same-named acknowledgment before suppressing direct native server sends.

tracking_config_revisionstring nullable

Authoring revision from the editor response. Send it with tracking_config when creating the next display version; stale edits are rejected with 409. Asset and trigger changes are atomic. Public runtime responses may return null; do not use those responses as an editing revision.

tracking_config_errorstring nullable

An actionable compatibility-resolution problem. An unresolved owner remains unmigrated.

tracking_contextstring
idinteger
versioninteger
schema_versioninteger
created_atstring date-time
created_by_idinteger nullable
is_publishedboolean
published_atstring date-time nullable
render_mode'html_mode' | 'builder'
html_documentstring nullable

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 <!doctype html><html><head></head><body></body></html> 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.

html_codestring nullable
css_codestring nullable
js_codestring nullable
additional_head_codestring nullable
fb_pixelsobject[]
tiktok_pixelsobject[]
kwai_client_pixelsobject[]
kwai_server_pixelsobject[]

Example response

{
  "html_document": "<!doctype html><html lang=\"id\"><head><title>My page</title><style>main { color: #111827; }</style></head><body><main>Hello</main><script>console.log(Scalev.data.get());</script></body></html>"
}

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added subschema #1 subschema #2 to the request body anyOf list

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the new optional request property /////

    • info

      added the optional property ///// to the response with the status