Skip to main content
POST
Render a system screen in the selected member site's theme

Authorizations

Authorization
string
header
required

Bearer token authentication

Body

application/json
system_screen_key
enum<string>
required

Shipped screen key.

Available options:
messaging,
contacts,
my-site,
profile,
orders,
subscriptions
members_site_id
integer
required

Site belonging to the selected theme in the authenticated company.

preview_audience
object

Builder-only synthetic viewer. Does not authenticate a member.

resources
object[]
version
integer
country_id
integer | null

Render the page as a visitor from this active company country. Falls back to the company default when absent, unknown, inactive, or not enabled for the company. When preview_audience is supplied, an unavailable explicit country ID returns 404 instead; an omitted or null ID still uses the company default.

language_id
integer | null

Render the page in this active company language. Falls back to the company default when absent, unknown, inactive, or not enabled for the company. When preview_audience is supplied, an unavailable explicit language ID returns 404 instead; an omitted or null ID still uses the company default. Content not yet translated for the selected language renders its English version.

navbar_template_id
integer | null

Pin a specific navbar template to preview alongside this page. When set, the pinned template wins over the country-scoped auto-pick unless its own country tags exclude the preview country.

Pin a specific footer template to preview alongside this page. Same semantics as navbar_template_id.

translations
object
application_theme_template
object

Response

Rendered HTML and styles using the selected theme

liquid_content
string | null
html_content
string
page_stylesheet
string

Stylesheet for the rendered page. Includes all the css needed by the page.

template_stylesheet
string

Stylesheet for the template itself.

preview_audience
object
preview_url
string | null

Preview URL for the rendered resource. System screens return their account-subdomain URL without a template ID or version.

meta
object