The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Page
Requires
content access scope.In addition to an online storefront, Shopify stores come with a tool for creating basic HTML web pages. Store owners can create any number of pages to hold static content, such as an About us page, a Contact us page, or a page with customer testimonials.
These web pages are represented by the Page resource, and their HTML content is contained in the value of the body_html property. The Page resource lets you retrieve, create, update, and delete web pages for a store.
Pages are meant to be used for long-term, static content that rarely changes. For creating content on a regular basis, use the Blog resource instead.
Was this section helpful?
#
Endpoints
- post/admin/api/latest/pages.
json Creates a page - get/admin/api/latest/pages.
json Retrieves a list of pages - get/admin/api/latest/pages/{page_
id}. json Retrieves a single page by its ID - get/admin/api/latest/pages/count.
json Retrieves a page count - put/admin/api/latest/pages/{page_
id}. json Updates a page - del/admin/api/latest/pages/{page_
id}. json Deletes a page
Anchor to
The Page resource
Anchor to
Properties
author
->
author
The name of the person who created the page.
body_html
->
bodyHtml
The text content of the page, complete with HTML markup.
handle
->
handle
A unique, human-friendly string for the page, generated automatically from its title. In themes, the Liquid templating language refers to a page by its handle.
The unique numeric identifier for the page.
metafield
Additional information attached to the Page object. It has the following properties:
Show metafield properties
Show metafield properties
- key: An identifier for the metafield. (maximum: 30 characters)
- namespace: A container for a set of metadata. Namespaces help distinguish between metadata created by different apps. (maximum: 20 characters)
- value: The information to be stored as metadata.
- type: The metafield's information type. Refer to the full list of types.
- description (optional): Additional information about the metafield.
For more information on attaching metadata to Shopify resources, see the Metafield resource.
published_at
The date and time (ISO 8601 format) when the page was published. Returns null when the page is hidden.
shop_id
read-only
deprecated
The ID of the shop to which the page belongs.
template_suffix
The suffix of the template that is used to render the page. If the value is an empty string or null, then the default page template is used.
title
->
title
The title of the page.
The GraphQL GID of the page.
Was this section helpful?
{}
The Page resource
{
"author": "Lydia",
"body_html": "Contact us at <a href='mailto:contact@example.com'>contact@example.com</a>.",
"created_at": "2008-07-15T20:00:00-04:00",
"handle": "contact-us",
"id": 131092082,
"metafield": {
"key": "new",
"value": "new value",
"type": "single_line_text_field",
"namespace": "global"
},
"published_at": "2014-07-16T20:00:00-04:00",
"shop_id": 548380009,
"template_suffix": "contact",
"title": "Contact us",
"updated_at": "2008-07-16T20:00:00-04:00",
"admin_graphql_api_id": "gid://shopify/OnlineStorePage/131092082"
}
Anchor to POST request, Creates a pagepostCreates a page
post
Creates a page
Creates a page
Anchor to Parameters of Creates a pageParameters
api_version
string
required
Was this section helpful?
Anchor to post-pages-examplesExamples
Create a page with HTML markup
Create a page with HTML markup
Create a page with a metafield
Create a page with a metafield
Create an unpublished page
Create an unpublished page
Creating a page without a title fails and returns an error
Creating a page without a title fails and returns an error
Was this section helpful?
post
/admin/api/2025-07/pages.
curl -d '{"page":{"title":"Warranty information","body_html":"<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>"}}' \
-X POST "https://your-development-store.myshopify.com/admin/api/2025-07/pages.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
{}
Response
JSON
HTTP/1.1 201 Created
{
"page": {
"id": 1025371370,
"title": "Warranty information",
"shop_id": 548380009,
"handle": "warranty-information",
"body_html": "<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>",
"author": "Shopify API",
"created_at": "2025-07-01T14:44:15-04:00",
"updated_at": "2025-07-01T14:44:15-04:00",
"published_at": "2025-07-01T14:44:15-04:00",
"template_suffix": null,
"admin_graphql_api_id": "gid://shopify/Page/1025371370"
}
}
examples
Create a page with HTML markup
curl -d '{"page":{"title":"Warranty information","body_html":"<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>"}}' \ -X POST "https://your-development-store.myshopify.com/admin/api/2025-07/pages.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const page = new admin.rest.resources.Page({session: session}); page.title = "Warranty information"; page.body_html = "<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>"; await page.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session page = ShopifyAPI::Page.new(session: test_session) page.title = "Warranty information" page.body_html = "<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>" page.save!// Session is built by the OAuth process const page = new shopify.rest.Page({session: session}); page.title = "Warranty information"; page.body_html = "<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>"; await page.save({ update: true, });response
HTTP/1.1 201 Created{"page":{"id":1025371370,"title":"Warranty information","shop_id":548380009,"handle":"warranty-information","body_html":"<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>","author":"Shopify API","created_at":"2025-07-01T14:44:15-04:00","updated_at":"2025-07-01T14:44:15-04:00","published_at":"2025-07-01T14:44:15-04:00","template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/1025371370"}}Create a page with a metafield
curl -d '{"page":{"title":"Warranty information","body_html":"<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>","metafields":[{"key":"new","value":"new value","type":"single_line_text_field","namespace":"global"}]}}' \ -X POST "https://your-development-store.myshopify.com/admin/api/2025-07/pages.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const page = new admin.rest.resources.Page({session: session}); page.title = "Warranty information"; page.body_html = "<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>"; page.metafields = [ { "key": "new", "value": "new value", "type": "single_line_text_field", "namespace": "global" } ]; await page.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session page = ShopifyAPI::Page.new(session: test_session) page.title = "Warranty information" page.body_html = "<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>" page.metafields = [ { "key" => "new", "value" => "new value", "type" => "single_line_text_field", "namespace" => "global" } ] page.save!// Session is built by the OAuth process const page = new shopify.rest.Page({session: session}); page.title = "Warranty information"; page.body_html = "<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>"; page.metafields = [ { "key": "new", "value": "new value", "type": "single_line_text_field", "namespace": "global" } ]; await page.save({ update: true, });response
HTTP/1.1 201 Created{"page":{"id":1025371369,"title":"Warranty information","shop_id":548380009,"handle":"warranty-information","body_html":"<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>","author":"Shopify API","created_at":"2025-07-01T14:44:14-04:00","updated_at":"2025-07-01T14:44:14-04:00","published_at":"2025-07-01T14:44:14-04:00","template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/1025371369"}}Create an unpublished page
curl -d '{"page":{"title":"Warranty information","body_html":"<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>","published":false}}' \ -X POST "https://your-development-store.myshopify.com/admin/api/2025-07/pages.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const page = new admin.rest.resources.Page({session: session}); page.title = "Warranty information"; page.body_html = "<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>"; page.published = false; await page.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session page = ShopifyAPI::Page.new(session: test_session) page.title = "Warranty information" page.body_html = "<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>" page.published = false page.save!// Session is built by the OAuth process const page = new shopify.rest.Page({session: session}); page.title = "Warranty information"; page.body_html = "<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>"; page.published = false; await page.save({ update: true, });response
HTTP/1.1 201 Created{"page":{"id":1025371368,"title":"Warranty information","shop_id":548380009,"handle":"warranty-information","body_html":"<h2>Warranty</h2>\n<p>Returns accepted if we receive items <strong>30 days after purchase</strong>.</p>","author":"Shopify API","created_at":"2025-07-01T14:44:09-04:00","updated_at":"2025-07-01T14:44:09-04:00","published_at":null,"template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/1025371368"}}Creating a page without a title fails and returns an error
curl -d '{"page":{"body":"foobar"}}' \ -X POST "https://your-development-store.myshopify.com/admin/api/2025-07/pages.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const page = new admin.rest.resources.Page({session: session}); page.body = "foobar"; await page.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session page = ShopifyAPI::Page.new(session: test_session) page.body = "foobar" page.save!// Session is built by the OAuth process const page = new shopify.rest.Page({session: session}); page.body = "foobar"; await page.save({ update: true, });response
HTTP/1.1 422 Unprocessable Entity{"errors":{"title":["can't be blank"]}}
Anchor to GET request, Retrieves a list of pagesgetRetrieves a list of pages
get
Retrieves a list of pages
Retrieve a list of all pages. Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.
api_version
string
required
created_at_max
Show pages created before date (format: 2014-04-25T16:15:47-04:00).
created_at_min
Show pages created after date (format: 2014-04-25T16:15:47-04:00).
fields
Show only certain fields, specified by a comma-separated list of field names.
handle
Retrieve a page with a given handle.
limit
≤ 250
default 50
The maximum number of results to show.
published_at_max
Show pages published before date (format: 2014-04-25T16:15:47-04:00).
published_at_min
Show pages published after date (format: 2014-04-25T16:15:47-04:00).
published_status
default any
Restrict results to pages with a given published status:
Show published_status properties
Show published_status properties
published: Show only published pages.
unpublished: Show only unpublished pages.
any: Show published and unpublished pages.
since_id
Restrict results to after the specified ID.
title
Retrieve pages with a given title.
updated_at_max
Show pages last updated before date (format: 2014-04-25T16:15:47-04:00).
updated_at_min
Show pages last updated after date (format: 2014-04-25T16:15:47-04:00).
Was this section helpful?
Anchor to get-pages-examplesExamples
Get all pages for a shop
Get all pages for a shop
Retrieve a list of all pages after the specified ID
Retrieve a list of all pages after the specified ID
Query parameters
since_
Restrict results to after the specified ID.
Was this section helpful?
get
/admin/api/2025-07/pages.
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/pages.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}
Response
JSON
HTTP/1.1 200 OK
{
"pages": [
{
"id": 108828309,
"title": "Sample Page",
"shop_id": 548380009,
"handle": "sample",
"body_html": "<p>this is a <strong>sample</strong> page.</p>",
"author": "Dennis",
"created_at": "2008-07-15T20:00:00-04:00",
"updated_at": "2008-07-16T20:00:00-04:00",
"published_at": null,
"template_suffix": null,
"admin_graphql_api_id": "gid://shopify/Page/108828309"
},
{
"id": 169524623,
"title": "Store hours",
"shop_id": 548380009,
"handle": "store-hours",
"body_html": "<p>We never close.</p>",
"author": "Jobs",
"created_at": "2013-12-31T19:00:00-05:00",
"updated_at": "2013-12-31T19:00:00-05:00",
"published_at": "2014-02-01T19:00:00-05:00",
"template_suffix": null,
"admin_graphql_api_id": "gid://shopify/Page/169524623"
},
{
"id": 322471,
"title": "Support",
"shop_id": 548380009,
"handle": "support",
"body_html": "<p>Come in store for support.</p>",
"author": "Dennis",
"created_at": "2009-07-15T20:00:00-04:00",
"updated_at": "2009-07-16T20:00:00-04:00",
"published_at": null,
"template_suffix": null,
"admin_graphql_api_id": "gid://shopify/Page/322471"
},
{
"id": 131092082,
"title": "Terms of Services",
"shop_id": 548380009,
"handle": "tos",
"body_html": "<p>We make <strong>perfect</strong> stuff, we don't need a warranty.</p>",
"author": "Dennis",
"created_at": "2008-07-15T20:00:00-04:00",
"updated_at": "2008-07-16T20:00:00-04:00",
"published_at": "2008-07-15T20:00:00-04:00",
"template_suffix": null,
"admin_graphql_api_id": "gid://shopify/Page/131092082"
}
]
}
examples
Get all pages for a shop
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/pages.json" \ -H "X-Shopify-Access-Token: {access_token}"await admin.rest.resources.Page.all({ session: session, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::Page.all( session: test_session, )// Session is built by the OAuth process await shopify.rest.Page.all({ session: session, });response
HTTP/1.1 200 OK{"pages":[{"id":108828309,"title":"Sample Page","shop_id":548380009,"handle":"sample","body_html":"<p>this is a <strong>sample</strong> page.</p>","author":"Dennis","created_at":"2008-07-15T20:00:00-04:00","updated_at":"2008-07-16T20:00:00-04:00","published_at":null,"template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/108828309"},{"id":169524623,"title":"Store hours","shop_id":548380009,"handle":"store-hours","body_html":"<p>We never close.</p>","author":"Jobs","created_at":"2013-12-31T19:00:00-05:00","updated_at":"2013-12-31T19:00:00-05:00","published_at":"2014-02-01T19:00:00-05:00","template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/169524623"},{"id":322471,"title":"Support","shop_id":548380009,"handle":"support","body_html":"<p>Come in store for support.</p>","author":"Dennis","created_at":"2009-07-15T20:00:00-04:00","updated_at":"2009-07-16T20:00:00-04:00","published_at":null,"template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/322471"},{"id":131092082,"title":"Terms of Services","shop_id":548380009,"handle":"tos","body_html":"<p>We make <strong>perfect</strong> stuff, we don't need a warranty.</p>","author":"Dennis","created_at":"2008-07-15T20:00:00-04:00","updated_at":"2008-07-16T20:00:00-04:00","published_at":"2008-07-15T20:00:00-04:00","template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/131092082"}]}Retrieve a list of all pages after the specified ID
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/pages.json?since_id=108828309" \ -H "X-Shopify-Access-Token: {access_token}"await admin.rest.resources.Page.all({ session: session, since_id: "108828309", });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::Page.all( session: test_session, since_id: "108828309", )// Session is built by the OAuth process await shopify.rest.Page.all({ session: session, since_id: "108828309", });response
HTTP/1.1 200 OK{"pages":[{"id":131092082,"title":"Terms of Services","shop_id":548380009,"handle":"tos","body_html":"<p>We make <strong>perfect</strong> stuff, we don't need a warranty.</p>","author":"Dennis","created_at":"2008-07-15T20:00:00-04:00","updated_at":"2008-07-16T20:00:00-04:00","published_at":"2008-07-15T20:00:00-04:00","template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/131092082"},{"id":169524623,"title":"Store hours","shop_id":548380009,"handle":"store-hours","body_html":"<p>We never close.</p>","author":"Jobs","created_at":"2013-12-31T19:00:00-05:00","updated_at":"2013-12-31T19:00:00-05:00","published_at":"2014-02-01T19:00:00-05:00","template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/169524623"}]}
Anchor to GET request, Retrieves a single page by its IDgetRetrieves a single page by its ID
get
Retrieves a single page by its ID
Retrieves a single page by its ID.
api_version
string
required
page_id
string
required
fields
Show only certain fields, specified by a comma-separated list of field names.
Was this section helpful?
Retrieve a single page
Retrieve a single page
Path parameters
page_
string
required
Was this section helpful?
get
/admin/api/2025-07/pages/131092082.
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/pages/131092082.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}
Response
JSON
HTTP/1.1 200 OK
{
"page": {
"id": 131092082,
"title": "Terms of Services",
"shop_id": 548380009,
"handle": "tos",
"body_html": "<p>We make <strong>perfect</strong> stuff, we don't need a warranty.</p>",
"author": "Dennis",
"created_at": "2008-07-15T20:00:00-04:00",
"updated_at": "2008-07-16T20:00:00-04:00",
"published_at": "2008-07-15T20:00:00-04:00",
"template_suffix": null,
"admin_graphql_api_id": "gid://shopify/Page/131092082"
}
}
examples
Retrieve a single page
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/pages/131092082.json" \ -H "X-Shopify-Access-Token: {access_token}"await admin.rest.resources.Page.find({ session: session, id: 131092082, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::Page.find( session: test_session, id: 131092082, )// Session is built by the OAuth process await shopify.rest.Page.find({ session: session, id: 131092082, });response
HTTP/1.1 200 OK{"page":{"id":131092082,"title":"Terms of Services","shop_id":548380009,"handle":"tos","body_html":"<p>We make <strong>perfect</strong> stuff, we don't need a warranty.</p>","author":"Dennis","created_at":"2008-07-15T20:00:00-04:00","updated_at":"2008-07-16T20:00:00-04:00","published_at":"2008-07-15T20:00:00-04:00","template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/131092082"}}
Anchor to GET request, Retrieves a page countgetRetrieves a page count
get
Retrieves a page count
Retrieves a page count.
api_version
string
required
created_at_max
Count pages created before date (format: 2014-04-25T16:15:47-04:00).
created_at_min
Count pages created after date (format: 2014-04-25T16:15:47-04:00).
published_at_max
Show pages published before date (format: 2014-04-25T16:15:47-04:00).
published_at_min
Show pages published after date (format: 2014-04-25T16:15:47-04:00).
published_status
default any
Count pages with a given published status:
Show published_status properties
Show published_status properties
published: Count published pages.
unpublished: Count unpublished pages.
any: Count published and unpublished pages.
title
Count pages with a given title.
updated_at_max
Count pages last updated before date (format: 2014-04-25T16:15:47-04:00).
updated_at_min
Count pages last updated after date (format: 2014-04-25T16:15:47-04:00).
Was this section helpful?
Retrieve a count of all pages
Retrieve a count of all pages
Was this section helpful?
get
/admin/api/2025-07/pages/count.
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/pages/count.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}
Response
JSON
HTTP/1.1 200 OK
{
"count": 4
}
examples
Retrieve a count of all pages
curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/pages/count.json" \ -H "X-Shopify-Access-Token: {access_token}"await admin.rest.resources.Page.count({ session: session, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::Page.count( session: test_session, )// Session is built by the OAuth process await shopify.rest.Page.count({ session: session, });response
HTTP/1.1 200 OK{"count":4}
Anchor to PUT request, Updates a pageputUpdates a page
put
Updates a page
Updates a page
Anchor to Parameters of Updates a pageParameters
api_version
string
required
page_id
string
required
Was this section helpful?
Add a metafield to a page
Add a metafield to a page
Path parameters
page_
string
required
Request body
page
Page resource
Show page properties
Show page properties
page.id:
read-only
The unique numeric identifier for the page.
Hide a published page
Hide a published page
Path parameters
page_
string
required
Request body
page
Page resource
Show page properties
Show page properties
page.id:
read-only
The unique numeric identifier for the page.
Update an existing page completely
Update an existing page completely
Path parameters
page_
string
required
Request body
page
Page resource
Show page properties
Show page properties
page.id:
read-only
The unique numeric identifier for the page.
page.body_
->
body
The text content of the page, complete with HTML markup.
page.author:
->
author
The name of the person who created the page.
page.title:
->
title
The title of the page.
page.handle:
->
handle
A unique, human-friendly string for the page, generated automatically from its title. In themes, the Liquid templating language refers to a page by its handle.
Update the body HTML of an existing page
Update the body HTML of an existing page
Path parameters
page_
string
required
Request body
page
Page resource
Show page properties
Show page properties
page.id:
read-only
The unique numeric identifier for the page.
page.body_
->
body
The text content of the page, complete with HTML markup.
Was this section helpful?
put
/admin/api/2025-07/pages/131092082.
curl -d '{"page":{"id":131092082,"metafields":[{"key":"new","value":"new value","type":"single_line_text_field","namespace":"global"}]}}' \
-X PUT "https://your-development-store.myshopify.com/admin/api/2025-07/pages/131092082.json" \
-H "X-Shopify-Access-Token: {access_token}" \
-H "Content-Type: application/json"
{}
Response
JSON
HTTP/1.1 200 OK
{
"page": {
"shop_id": 548380009,
"title": "Terms of Services",
"handle": "tos",
"body_html": "<p>We make <strong>perfect</strong> stuff, we don't need a warranty.</p>",
"id": 131092082,
"author": "Dennis",
"created_at": "2008-07-15T20:00:00-04:00",
"updated_at": "2008-07-16T20:00:00-04:00",
"published_at": "2008-07-15T20:00:00-04:00",
"template_suffix": null,
"admin_graphql_api_id": "gid://shopify/Page/131092082"
}
}
examples
Add a metafield to a page
curl -d '{"page":{"id":131092082,"metafields":[{"key":"new","value":"new value","type":"single_line_text_field","namespace":"global"}]}}' \ -X PUT "https://your-development-store.myshopify.com/admin/api/2025-07/pages/131092082.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const page = new admin.rest.resources.Page({session: session}); page.id = 131092082; page.metafields = [ { "key": "new", "value": "new value", "type": "single_line_text_field", "namespace": "global" } ]; await page.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session page = ShopifyAPI::Page.new(session: test_session) page.id = 131092082 page.metafields = [ { "key" => "new", "value" => "new value", "type" => "single_line_text_field", "namespace" => "global" } ] page.save!// Session is built by the OAuth process const page = new shopify.rest.Page({session: session}); page.id = 131092082; page.metafields = [ { "key": "new", "value": "new value", "type": "single_line_text_field", "namespace": "global" } ]; await page.save({ update: true, });response
HTTP/1.1 200 OK{"page":{"shop_id":548380009,"title":"Terms of Services","handle":"tos","body_html":"<p>We make <strong>perfect</strong> stuff, we don't need a warranty.</p>","id":131092082,"author":"Dennis","created_at":"2008-07-15T20:00:00-04:00","updated_at":"2008-07-16T20:00:00-04:00","published_at":"2008-07-15T20:00:00-04:00","template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/131092082"}}Hide a published page
curl -d '{"page":{"id":131092082,"published":false}}' \ -X PUT "https://your-development-store.myshopify.com/admin/api/2025-07/pages/131092082.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const page = new admin.rest.resources.Page({session: session}); page.id = 131092082; page.published = false; await page.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session page = ShopifyAPI::Page.new(session: test_session) page.id = 131092082 page.published = false page.save!// Session is built by the OAuth process const page = new shopify.rest.Page({session: session}); page.id = 131092082; page.published = false; await page.save({ update: true, });response
HTTP/1.1 200 OK{"page":{"shop_id":548380009,"published_at":null,"title":"Terms of Services","handle":"tos","body_html":"<p>We make <strong>perfect</strong> stuff, we don't need a warranty.</p>","id":131092082,"author":"Dennis","created_at":"2008-07-15T20:00:00-04:00","updated_at":"2025-07-01T14:44:24-04:00","template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/131092082"}}Show a hidden page
curl -d '{"page":{"id":131092082,"published":true}}' \ -X PUT "https://your-development-store.myshopify.com/admin/api/2025-07/pages/131092082.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const page = new admin.rest.resources.Page({session: session}); page.id = 131092082; page.published = true; await page.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session page = ShopifyAPI::Page.new(session: test_session) page.id = 131092082 page.published = true page.save!// Session is built by the OAuth process const page = new shopify.rest.Page({session: session}); page.id = 131092082; page.published = true; await page.save({ update: true, });response
HTTP/1.1 200 OK{"page":{"shop_id":548380009,"published_at":"2025-07-01T14:44:03-04:00","title":"Terms of Services","handle":"tos","body_html":"<p>We make <strong>perfect</strong> stuff, we don't need a warranty.</p>","id":131092082,"author":"Dennis","created_at":"2008-07-15T20:00:00-04:00","updated_at":"2025-07-01T14:44:03-04:00","template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/131092082"}}Update an existing page completely
curl -d '{"page":{"id":131092082,"body_html":"<p>Returns accepted if we receive the items <strong>14 days</strong> after purchase.</p>","author":"Christopher Gorski","title":"New warranty","handle":"new-warranty"}}' \ -X PUT "https://your-development-store.myshopify.com/admin/api/2025-07/pages/131092082.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const page = new admin.rest.resources.Page({session: session}); page.id = 131092082; page.body_html = "<p>Returns accepted if we receive the items <strong>14 days</strong> after purchase.</p>"; page.author = "Christopher Gorski"; page.title = "New warranty"; page.handle = "new-warranty"; await page.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session page = ShopifyAPI::Page.new(session: test_session) page.id = 131092082 page.body_html = "<p>Returns accepted if we receive the items <strong>14 days</strong> after purchase.</p>" page.author = "Christopher Gorski" page.title = "New warranty" page.handle = "new-warranty" page.save!// Session is built by the OAuth process const page = new shopify.rest.Page({session: session}); page.id = 131092082; page.body_html = "<p>Returns accepted if we receive the items <strong>14 days</strong> after purchase.</p>"; page.author = "Christopher Gorski"; page.title = "New warranty"; page.handle = "new-warranty"; await page.save({ update: true, });response
HTTP/1.1 200 OK{"page":{"shop_id":548380009,"author":"Christopher Gorski","body_html":"<p>Returns accepted if we receive the items <strong>14 days</strong> after purchase.</p>","handle":"new-warranty","title":"New warranty","id":131092082,"created_at":"2008-07-15T20:00:00-04:00","updated_at":"2025-07-01T14:44:23-04:00","published_at":"2008-07-15T20:00:00-04:00","template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/131092082"}}Update the body HTML of an existing page
curl -d '{"page":{"id":131092082,"body_html":"<p>Returns accepted if we receive the items 14 days after purchase.</p>"}}' \ -X PUT "https://your-development-store.myshopify.com/admin/api/2025-07/pages/131092082.json" \ -H "X-Shopify-Access-Token: {access_token}" \ -H "Content-Type: application/json"const { admin, session } = await authenticate.admin(request); const page = new admin.rest.resources.Page({session: session}); page.id = 131092082; page.body_html = "<p>Returns accepted if we receive the items 14 days after purchase.</p>"; await page.save({ update: true, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session page = ShopifyAPI::Page.new(session: test_session) page.id = 131092082 page.body_html = "<p>Returns accepted if we receive the items 14 days after purchase.</p>" page.save!// Session is built by the OAuth process const page = new shopify.rest.Page({session: session}); page.id = 131092082; page.body_html = "<p>Returns accepted if we receive the items 14 days after purchase.</p>"; await page.save({ update: true, });response
HTTP/1.1 200 OK{"page":{"shop_id":548380009,"body_html":"<p>Returns accepted if we receive the items 14 days after purchase.</p>","title":"Terms of Services","handle":"tos","id":131092082,"author":"Dennis","created_at":"2008-07-15T20:00:00-04:00","updated_at":"2025-07-01T14:44:19-04:00","published_at":"2008-07-15T20:00:00-04:00","template_suffix":null,"admin_graphql_api_id":"gid://shopify/Page/131092082"}}
Anchor to DELETE request, Deletes a pagedelDeletes a page
del
Deletes a page
Deletes a page.
Anchor to Parameters of Deletes a pageParameters
api_version
string
required
page_id
string
required
Was this section helpful?
Delete a page
Delete a page
Path parameters
page_
string
required
Was this section helpful?
del
/admin/api/2025-07/pages/131092082.
curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2025-07/pages/131092082.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}
Response
JSON
HTTP/1.1 200 OK
{}
examples
Delete a page
curl -X DELETE "https://your-development-store.myshopify.com/admin/api/2025-07/pages/131092082.json" \ -H "X-Shopify-Access-Token: {access_token}"await admin.rest.resources.Page.delete({ session: session, id: 131092082, });# Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::Page.delete( session: test_session, id: 131092082, )// Session is built by the OAuth process await shopify.rest.Page.delete({ session: session, id: 131092082, });response
HTTP/1.1 200 OK{}