Developers

Pages

Markdown

Update a page

Updating a published page also requires pages.publish:write.

PATCH/stores/{storeId}/v1/pages/{id}

Path parameters

idstringrequired

Headers

If-Matchstringrequired
ETag from a GET of this same resource projection.

Request body

titlestring
slugstring
contentstring
seo_titlestring
seo_descriptionstring
seo_keywordsstring
indexableboolean

Response

dataobjectrequired
idinteger
titlestring
slugstring
contentstring
is_activeboolean
seo_titlestring | null
seo_descriptionstring | null
seo_keywordsstring | null
indexableboolean
created_atstring (date-time)
updated_atstring (date-time)
executionobject
Who executed the request: the app, version, installation and store. Field names here are camelCase.
appIdstring (uuid)
versionIdstring (uuid)
installationIdstring (uuid)
storeIdstring (uuid)
requestIdstring (uuid)
generationinteger
routeEpochinteger
appAuthEpochinteger
grantRevisioninteger
metaobjectrequired
request_idstring (uuid)
The request ID; include it in any support request.

Errors

HTTPCodeMeaning
503APPS_SCOPE_RUNTIME_NOT_READYThe resource is not enabled on this merchant's store yet.

Shared codes are listed in Errors.

    ↑↓ moveEnter openEsc close