CMS Page
Pages of the site — title, url_key, rich-text content and SEO metadata. An empty visible_view_ids means every view, not none.
List cms_pages
A page of the site — its title, its slug, its rich-text body and its SEO metadata. A page is one resource for the whole website: what one view says instead of the master lives in its views overlay, and which views show it at all is visible_view_ids. Which visitors may read it is audience.
path Parameters
website_idId of the parent website.
query Parameters
page_sizeRows per page. Over the maximum is clamped, not rejected.
page_tokenOpaque token from a previous next_page_token. A token minted under a different order_by/filter is rejected.
skipRows to skip before the page (AIP-158). skip + page_size is capped at 10000; beyond that is OUT_OF_RANGE.
order_byComma-separated field [asc|desc], at most 3 keys. Default: create_time desc. Sortable: create_time, title, url_key.
filterAIP-160 subset (§8). Filterable: audience, create_time, is_active, title, url_key, visible_view_ids. A field outside the list is INVALID_ARGUMENT.
List cms_pages › Responses
One page of cms_pages.
This page of cms_pages, in the requested order.
next_page_tokenOpaque. Absent or empty means this was the last page.
total_sizeRows in the whole filtered collection, not in this page.
Create cms_page
A page of the site — its title, its slug, its rich-text body and its SEO metadata. A page is one resource for the whole website: what one view says instead of the master lives in its views overlay, and which views show it at all is visible_view_ids. Which visitors may read it is audience.
path Parameters
website_idId of the parent website.
Create cms_page › Request Body
titleThe page's heading, and the label the admin lists it under.
url_keyThe page's slug — the last segment of its URL on the live site. Unique per view.
is_activeWhether the page is published. An inactive page stays in the admin and 404s on the site.
meta_titleThe <title> of the rendered page. Falls back to title when empty.
meta_descriptionThe <meta name="description"> of the rendered page, and what a search engine usually shows under the link.
meta_keywordsThe <meta name="keywords"> of the rendered page. Kept for sites that still fill it in.
contentThe page body as rich-text HTML. Links to other resources may be written as entity:// URLs, which the renderer resolves to the right URL for the view it is rendering.
background_media_idThe media resource used as the page's hero image. Empty means the theme decides.
background_positionWhere the hero image is anchored when it is cropped to the banner — a CSS background-position value such as center top.
visible_view_idsThe views this page appears in. Empty means every view, not none — a page is visible everywhere until it is restricted.
audienceWho the page is for. PUBLIC — everybody, the default. AUTHENTICATED — the website's signed-in customers. GROUPS — the customers in at least one of customer_group_ids. A page that is not PUBLIC is left out of the sitemap, the site search, the public API and every cached copy of the site, and is rendered only for a visitor it is for.
customer_group_idsThe customer_groups of the website a GROUPS page is shown to — at least one, at most 100. Empty for any other audience: setting the audience to anything else empties it, and a deleted group drops out of it on its own.
Create cms_page › Responses
The created resource.
nameThe resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
create_timeWhen the resource was created (RFC 3339, UTC).
update_timeWhen the resource last changed (RFC 3339, UTC).
etagVersion of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).
titleThe page's heading, and the label the admin lists it under.
url_keyThe page's slug — the last segment of its URL on the live site. Unique per view.
is_activeWhether the page is published. An inactive page stays in the admin and 404s on the site.
meta_titleThe <title> of the rendered page. Falls back to title when empty.
meta_descriptionThe <meta name="description"> of the rendered page, and what a search engine usually shows under the link.
meta_keywordsThe <meta name="keywords"> of the rendered page. Kept for sites that still fill it in.
contentThe page body as rich-text HTML. Links to other resources may be written as entity:// URLs, which the renderer resolves to the right URL for the view it is rendering.
background_media_idThe media resource used as the page's hero image. Empty means the theme decides.
background_positionWhere the hero image is anchored when it is cropped to the banner — a CSS background-position value such as center top.
visible_view_idsThe views this page appears in. Empty means every view, not none — a page is visible everywhere until it is restricted.
audienceWho the page is for. PUBLIC — everybody, the default. AUTHENTICATED — the website's signed-in customers. GROUPS — the customers in at least one of customer_group_ids. A page that is not PUBLIC is left out of the sitemap, the site search, the public API and every cached copy of the site, and is rendered only for a visitor it is for.
customer_group_idsThe customer_groups of the website a GROUPS page is shown to — at least one, at most 100. Empty for any other audience: setting the audience to anything else empties it, and a deleted group drops out of it on its own.
view_idDeprecated. Pages used to be duplicated per view; a page is now one master resource with an overlay per view, so this is empty on everything written since. Use views and visible_view_ids.
canonical_idDeprecated companion of view_id: which master a duplicated legacy page belonged to.
Get cms_page
A page of the site — its title, its slug, its rich-text body and its SEO metadata. A page is one resource for the whole website: what one view says instead of the master lives in its views overlay, and which views show it at all is visible_view_ids. Which visitors may read it is audience.
path Parameters
website_idId of the parent website.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
Headers
If-None-MatchA matching etag answers 304 with no body (§16).
Get cms_page › Responses
The resource.
nameThe resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
create_timeWhen the resource was created (RFC 3339, UTC).
update_timeWhen the resource last changed (RFC 3339, UTC).
etagVersion of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).
titleThe page's heading, and the label the admin lists it under.
url_keyThe page's slug — the last segment of its URL on the live site. Unique per view.
is_activeWhether the page is published. An inactive page stays in the admin and 404s on the site.
meta_titleThe <title> of the rendered page. Falls back to title when empty.
meta_descriptionThe <meta name="description"> of the rendered page, and what a search engine usually shows under the link.
meta_keywordsThe <meta name="keywords"> of the rendered page. Kept for sites that still fill it in.
contentThe page body as rich-text HTML. Links to other resources may be written as entity:// URLs, which the renderer resolves to the right URL for the view it is rendering.
background_media_idThe media resource used as the page's hero image. Empty means the theme decides.
background_positionWhere the hero image is anchored when it is cropped to the banner — a CSS background-position value such as center top.
visible_view_idsThe views this page appears in. Empty means every view, not none — a page is visible everywhere until it is restricted.
audienceWho the page is for. PUBLIC — everybody, the default. AUTHENTICATED — the website's signed-in customers. GROUPS — the customers in at least one of customer_group_ids. A page that is not PUBLIC is left out of the sitemap, the site search, the public API and every cached copy of the site, and is rendered only for a visitor it is for.
customer_group_idsThe customer_groups of the website a GROUPS page is shown to — at least one, at most 100. Empty for any other audience: setting the audience to anything else empties it, and a deleted group drops out of it on its own.
view_idDeprecated. Pages used to be duplicated per view; a page is now one master resource with an overlay per view, so this is empty on everything written since. Use views and visible_view_ids.
canonical_idDeprecated companion of view_id: which master a duplicated legacy page belonged to.
Delete cms_page
A page of the site — its title, its slug, its rich-text body and its SEO metadata. A page is one resource for the whole website: what one view says instead of the master lives in its views overlay, and which views show it at all is visible_view_ids. Which visitors may read it is audience.
path Parameters
website_idId of the parent website.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
Headers
If-MatchThe etag the client last read. A mismatch is ABORTED (409) with the current resource in the error details (§14).
Delete cms_page › Responses
Deleted. No body (§7).
Update cms_page
A page of the site — its title, its slug, its rich-text body and its SEO metadata. A page is one resource for the whole website: what one view says instead of the master lives in its views overlay, and which views show it at all is visible_view_ids. Which visitors may read it is audience.
path Parameters
website_idId of the parent website.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
query Parameters
update_maskComma-separated field paths to merge. A field named here and sent as null is cleared; without the mask a null is dropped (§7, §11).
Headers
If-MatchThe etag the client last read. A mismatch is ABORTED (409) with the current resource in the error details (§14).
Update cms_page › Request Body
titleThe page's heading, and the label the admin lists it under.
url_keyThe page's slug — the last segment of its URL on the live site. Unique per view.
is_activeWhether the page is published. An inactive page stays in the admin and 404s on the site.
meta_titleThe <title> of the rendered page. Falls back to title when empty.
meta_descriptionThe <meta name="description"> of the rendered page, and what a search engine usually shows under the link.
meta_keywordsThe <meta name="keywords"> of the rendered page. Kept for sites that still fill it in.
contentThe page body as rich-text HTML. Links to other resources may be written as entity:// URLs, which the renderer resolves to the right URL for the view it is rendering.
background_media_idThe media resource used as the page's hero image. Empty means the theme decides.
background_positionWhere the hero image is anchored when it is cropped to the banner — a CSS background-position value such as center top.
visible_view_idsThe views this page appears in. Empty means every view, not none — a page is visible everywhere until it is restricted.
audienceWho the page is for. PUBLIC — everybody, the default. AUTHENTICATED — the website's signed-in customers. GROUPS — the customers in at least one of customer_group_ids. A page that is not PUBLIC is left out of the sitemap, the site search, the public API and every cached copy of the site, and is rendered only for a visitor it is for.
customer_group_idsThe customer_groups of the website a GROUPS page is shown to — at least one, at most 100. Empty for any other audience: setting the audience to anything else empties it, and a deleted group drops out of it on its own.
Update cms_page › Responses
The updated resource.
nameThe resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.
idThe last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.
create_timeWhen the resource was created (RFC 3339, UTC).
update_timeWhen the resource last changed (RFC 3339, UTC).
etagVersion of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).
titleThe page's heading, and the label the admin lists it under.
url_keyThe page's slug — the last segment of its URL on the live site. Unique per view.
is_activeWhether the page is published. An inactive page stays in the admin and 404s on the site.
meta_titleThe <title> of the rendered page. Falls back to title when empty.
meta_descriptionThe <meta name="description"> of the rendered page, and what a search engine usually shows under the link.
meta_keywordsThe <meta name="keywords"> of the rendered page. Kept for sites that still fill it in.
contentThe page body as rich-text HTML. Links to other resources may be written as entity:// URLs, which the renderer resolves to the right URL for the view it is rendering.
background_media_idThe media resource used as the page's hero image. Empty means the theme decides.
background_positionWhere the hero image is anchored when it is cropped to the banner — a CSS background-position value such as center top.
visible_view_idsThe views this page appears in. Empty means every view, not none — a page is visible everywhere until it is restricted.
audienceWho the page is for. PUBLIC — everybody, the default. AUTHENTICATED — the website's signed-in customers. GROUPS — the customers in at least one of customer_group_ids. A page that is not PUBLIC is left out of the sitemap, the site search, the public API and every cached copy of the site, and is rendered only for a visitor it is for.
customer_group_idsThe customer_groups of the website a GROUPS page is shown to — at least one, at most 100. Empty for any other audience: setting the audience to anything else empties it, and a deleted group drops out of it on its own.
view_idDeprecated. Pages used to be duplicated per view; a page is now one master resource with an overlay per view, so this is empty on everything written since. Use views and visible_view_ids.
canonical_idDeprecated companion of view_id: which master a duplicated legacy page belonged to.