post https://{shopdomain}.myshoplaza.com/openapi/2022-01/pages
Requires
write_shop_navigationaccess 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:
- Dynamically generating custom pages on a website.
- Managing SEO metadata (title, description, and keywords) for the page.
- Automating page creation during setup processes for new stores or websites.
Request Parameters
Public Request Parameters
Body Parameters
| Parameter | Type | Description | Required | Example |
|---|---|---|---|---|
title | string | The title of the page. | Yes | "My New Page" |
content | string | The HTML content of the page. | Yes | "<p>Hello!</p>" |
url | string | The URL of the page. | Yes | "/pages/about" |
meta_title | string | The SEO title of the page. | No | "About Us" |
meta_keyword | string | The SEO keywords for the page. | No | "about, page" |
meta_description | string | The SEO description of the page. | No | "Learn about us." |
independent_seo | boolean | Whether to manage SEO independently. | No | true |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Description | Example |
|---|---|---|---|
id | int | Unique ID of the created page. | 15979 |
title | string | Title of the created page. | "Test" |
content | string | HTML content of the created page. | "<p>Welcome to my page!</p>" |
status | int | Status of the page (1 for active). | 1 |
created_at | string | Timestamp of when the page was created. | "1714377813" |
updated_at | string | Timestamp of the last update. | "1714377813" |
url | string | URL of the created page. | "/pages/test1" |
meta_title | string | SEO title of the page. | "Test" |
meta_keyword | string | SEO keywords for the page. | "" |
meta_description | string | SEO description of the page. | "Welcome to my page!" |
independent_seo | boolean | Whether SEO is managed independently. | false |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized |