build-pages

Build and change pages in Agility CMS

Explore

• get_sitemaps lists the sitemaps (channels) for a locale.
• get_sitemap returns the page tree. Use pathPrefix, maxDepth or flat mode to keep large sites readable.
• get_page returns one page with its zones and modules.

Before creating a page, gather

1. The locale (get_locales).
2. The sitemap ID (get_sitemaps).
3. The page model name (get_page_models). Request its module zones too. Zone names must match the model exactly, including case. Do not guess them; a component placed in an unknown zone is rejected.
4. The parent page ID, from get_sitemap. Never guess it.
5. For each component to add, its model ID and fields: call get_component_models, then get_component_model_details.

Ask the user for anything still missing, such as the page title or URL path.

Create or update a page

• Call save_page with pageType: static (a regular page), dynamic (one page per item in a content list), folder (groups pages, no content) or link (a redirect).
• To add new components, put them in the page's zones with their fields and componentModelID. save_page creates the page and those content items in one step. Do not call save_content_items for them first.
• Referencing an existing content ID on a new page creates a copy of that content with a new ID. Tell the user.
• SEO and visibility fields: leave a field out to keep its stored value; null clears it.
• Saving does not publish. The page lands in the default state, usually Staging. Return the page ID and editor link from the result.

Reorder components

save_page does not change the order of existing components. Use reorder_page_modules with the page ID, the zone name, and the full list of content IDs in the new order. Read the page with get_page first and include every module in the zone.

Then read the page again and check the order. A reorder has been seen to report success without changing anything. If the order did not change, tell the user, and offer the fallback: save the page with only the components that should come first, then save it again with the rest appended in order. Components re-added this way get new content IDs, so report the new IDs.