For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
        • Abandoned Cart Emails
        • Custom Template Associations
        • Email Templates
        • Pages
            • GETList Pages
            • POSTCreate Pages
            • PUTUpdate Pages
            • DELDelete Pages
            • GETGet Page
            • PUTUpdate Page
            • DELDelete Page
        • Marketing
        • Store Content
        • Themes
        • Widgets
        • Page Widgets
      • Payments
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
On this page
  • Overview
  • Bulk operations
  • Page types
RESTAdminContent

Pages V3

Was this page helpful?
Previous

Delete Email Template Override

Next

List Pages

Built with

Overview

A page appears on a site that is associated with a channel.

Some pages, such as blog pages, contact forms, and plain-text or HTML pages, are web pages in the traditional sense. They contain markup (a body) and load at a relative page location on the site itself (the url). Other pages, such as link pages, make external or non-visual content available from the menu of a parent page or by direct link.

Bulk operations

All endpoints without a pageId path parameter support bulk operations.

Page types

The following table describes the types of pages that the Pages API can manage:

Page TypeDescriptionBody
pageA user-defined plain-text page.text
contact_formA user-customizable page that contains a contact form.HTML
rawA user-defined page that contains HTML markup or other stringified code.HTML, other code
blogA page that contains blog posts. Use caution; blog-type pages can only be created in the store control panel, but you may be able to change the type of a blog page to something else with this API. Use the blog feature of the REST Content API to work with blog posts and tags.empty string
linkA link to an external absolute URL that follows RFC 3986 standards. Displays in the menu of other pages that contain markup.—