Create Page

Create a new page with the provided details.

🔒

Requires write_shop_navigation access scope. More access scope

The Create Page API allows users to create a new page on the platform with content, SEO metadata, and URL configuration.

This API is especially useful for:

  1. Dynamically generating custom pages on a website.
  2. Managing SEO metadata (title, description, and keywords) for the page.
  3. Automating page creation during setup processes for new stores or websites.

Request Parameters

Public Request Parameters

📘

Body Parameters

ParameterTypeRequiredDescriptionExample
page.titlestringYesThe title of the page."My New Page"
page.contentstringYesThe HTML content of the page."<p>Hello!</p>"
page.urlstringYesThe URL of the page."/pages/about"
page.meta_titlestringNoThe SEO title of the page."About Us"
page.meta_keywordstringNoThe SEO keywords for the page."about, page"
page.meta_descriptionstringNoThe SEO description of the page."Learn about us."
page.independent_seobooleanNoWhether to manage SEO independently.true

Response Explanation

Public Response Parameters

📘

Successful Response

FieldTypeDescriptionExample
codestring"success"Status code of the response
messagestringDescriptive message of the response
data.idintUnique ID of the created page.15979
data.titlestringTitle of the created page."Test"
data.contentstringHTML content of the created page."<p>Welcome to my page!</p>"
data.statusintStatus of the page (1 for active).1
data.created_atstringTimestamp of when the page was created."1714377813"
data.updated_atstringTimestamp of the last update."1714377813"
data.urlstringURL of the created page."/pages/test1"
data.meta_titlestringSEO title of the page."Test"
data.meta_keywordstringSEO keywords for the page.""
data.meta_descriptionstringSEO description of the page."Welcome to my page!"
data.independent_seobooleanWhether SEO is managed independently.false

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!