Skip to main content
PUT
Update Page

Update Page

Updates an existing page. Only provided fields are updated.

Request

Path Parameters

id
string
required
The unique page ID (pageId) to update

Body Parameters

All parameters are optional. Only provided fields are updated; any keys not listed below are ignored.
title
string
The page title
handle
string
URL-safe handle
content
string
Page content (HTML)
templateSuffix
string
Custom template suffix
Optional external link for the page
showtitle
boolean
Whether to display the page title on the storefront
seoTitle
string
Custom page title for search engines
seoDesc
string
Meta description for search engines
seoImage
string
Open Graph / social share image URL

Response

status
integer
HTTP status code (200 on success)
state
string
Outcome state, success on success
message
string
Human-readable message, null on success
data
object
Wrapper containing the updated page object

Example Response

Error Response

When no page matches the ID for the store, the request returns a 404 envelope:

Notes

  • Changing the handle will break existing links to the page.
  • Navigation menu links may need to be updated if the handle changes.

Error Codes

StatusStateDescription
401errorInvalid or missing access token
403errorApp doesn’t have write_content scope
404errorPage with the specified ID does not exist