Sign in

v1

latestOpenAPI 3.1.02026-08-04177151.5 KB
page

Create Page

Creates a new page in a site.

post/v6/pages

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

siteIdstring uuid required

The site ID to create the page for.

pathnamestring required

The page pathname.

namestring required

The page name.

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.

sitemapFrequency'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never' required

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.