CMS Block
Reusable fragments of content, addressed by identifier and pulled into pages, themes and smart links.
List cms_blocks
A reusable fragment of content, addressed by its identifier and pulled into pages, themes and smart links rather than into a URL of its own. Footers, contact strips, banners — anything that has to say the same thing in several places and change in one.
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, identifier, title.
filterAIP-160 subset (§8). Filterable: create_time, identifier, is_active, title. A field outside the list is INVALID_ARGUMENT.
List cms_blocks › Responses
One page of cms_blocks.
This page of cms_blocks, 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_block
A reusable fragment of content, addressed by its identifier and pulled into pages, themes and smart links rather than into a URL of its own. Footers, contact strips, banners — anything that has to say the same thing in several places and change in one.
path Parameters
website_idId of the parent website.
Create cms_block › Request Body
titleThe block's label in the admin. Never rendered on the site — the block is its content.
identifierThe handle a page, a theme or a smart link pulls this block in by. Unique per website, and the one field worth keeping stable.
is_activeWhether the block renders. An inactive block is left out wherever it is referenced.
contentThe fragment itself, as rich-text HTML.
Create cms_block › 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 block's label in the admin. Never rendered on the site — the block is its content.
identifierThe handle a page, a theme or a smart link pulls this block in by. Unique per website, and the one field worth keeping stable.
is_activeWhether the block renders. An inactive block is left out wherever it is referenced.
contentThe fragment itself, as rich-text HTML.
Get cms_block
A reusable fragment of content, addressed by its identifier and pulled into pages, themes and smart links rather than into a URL of its own. Footers, contact strips, banners — anything that has to say the same thing in several places and change in one.
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_block › 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 block's label in the admin. Never rendered on the site — the block is its content.
identifierThe handle a page, a theme or a smart link pulls this block in by. Unique per website, and the one field worth keeping stable.
is_activeWhether the block renders. An inactive block is left out wherever it is referenced.
contentThe fragment itself, as rich-text HTML.
Delete cms_block
A reusable fragment of content, addressed by its identifier and pulled into pages, themes and smart links rather than into a URL of its own. Footers, contact strips, banners — anything that has to say the same thing in several places and change in one.
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_block › Responses
Deleted. No body (§7).
Update cms_block
A reusable fragment of content, addressed by its identifier and pulled into pages, themes and smart links rather than into a URL of its own. Footers, contact strips, banners — anything that has to say the same thing in several places and change in one.
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_block › Request Body
titleThe block's label in the admin. Never rendered on the site — the block is its content.
identifierThe handle a page, a theme or a smart link pulls this block in by. Unique per website, and the one field worth keeping stable.
is_activeWhether the block renders. An inactive block is left out wherever it is referenced.
contentThe fragment itself, as rich-text HTML.
Update cms_block › 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 block's label in the admin. Never rendered on the site — the block is its content.
identifierThe handle a page, a theme or a smart link pulls this block in by. Unique per website, and the one field worth keeping stable.
is_activeWhether the block renders. An inactive block is left out wherever it is referenced.
contentThe fragment itself, as rich-text HTML.