Sign in

v2

latestOpenAPI 3.0.3Proprietary2026-07-263483431.1 MB
Landing Pages

Create a landing page

Creates a business-scoped landing page using the same page creation behavior as Landing Page Studio. The request body below documents the HTML Mode payload. To create and publish an HTML Mode page in one call, include is_published: true with page_display. If is_published is omitted or false, the nested page_display is saved as an unpublished draft and is not returned as the page's current display; create or pick a page display, then call PATCH /v3/pages/{id} with is_published: true and current_page_display_id to publish it.

post/v3/pages

Request body

namestring required
slugstring required
is_publishedboolean

When true, publishes the created nested page_display and makes it the current display. When omitted or false, the nested display is saved as an unpublished draft; the page response will have current_page_display_id: null, page_display: null, and a page-level render_mode fallback until a display is published.

store_idinteger nullable

Optional top-level store association. HTML Checkout store context is configured through page_display.form_display.store_id.

Example request

{
  "name": "API HTML Page",
  "slug": "api-html-page"
}

Response

Landing page

idinteger
unique_idstring
namestring
slugstring
render_mode'builder' | 'html_mode'
is_publishedboolean
published_atstring date-time nullable
store_idinteger nullable
storeobject nullable
tagsstring[]
is_pinnedboolean
created_byobject nullable
last_updated_byobject nullable
created_atstring date-time
last_updated_atstring date-time
uuidstring
businessobject nullable
is_sending_email_invoiceboolean
is_disable_custom_fontboolean
is_disable_client_taggingboolean
client_analytics_config'head' | 'body_close_delay' | 'web_worker' nullable
custom_domainsobject[]
homepage_custom_domainsobject[]
current_page_display_idinteger nullable