v1

latestOpenAPI 3.1.02026-08-04177151.5 KB

page

Update Page

Updates an existing page.

patch/v6/pages/{pageIdOrPathname}

Path parameters

pageIdOrPathnamestring required

The page ID or pathname for the page you are updating.

Query parameters

siteIdstring uuid

The site ID required when using a pathname instead of a page ID.

Headers

x-api-keystring required

API key authentication. Accepts either:

App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ)
Site API key (UUID format, e.g. 550e8400-e29b-41d4-a716-446655440000)

Request body

pathnamestring

The page pathname.

namestring

The page name.

isOnlineboolean

The flag that indicates whether the page is online.

Response

object'page' required

idstring uuid required

The ID of the page.

pathnamestring required

The page pathname.

canonicalUrlstring nullable required

The canonical URL of the page.

titlestring nullable required

The page title.

descriptionstring nullable required

The page description.

socialImageUrlstring nullable required

The social image URL of the page.

sitemapPrioritynumber double nullable required

The sitemap priority.

The sitemap update frequency.

createdAtstring date-time nullable required

The page creation date and time.

updatedAtstring date-time nullable required

The page last update date and time.

publishedAtstring date-time nullable required

The page publication date and time.

isOnlineboolean required

The flag that indicates whether the page is online.

excludedFromSearchEnginesboolean nullable required

The flag that indicates whether the page is excluded from search.

localestring

The page locale. This defaults to the default locale of the parent site.