Page Object v2

Primary Object

{
  "uuid": "string",
  "collection_name": "string",
  "type": "REGULAR" | "DYNAMIC",
  "title": "string",
  "path": "string",
  "seo": {
    "title": "string",
    "description": "string",
    "no_index": true,
    "og_image": "string"
  },
  "header_html": "string",
  "draft_status":"STAGED_DRAFT" | "DRAFT"
}

Field

Description

uuid string

The internal unique identifier of a specific page. This value is used to update or delete a page with other API calls.

collection_name
string

The name of the source collection for the dynamic page. This property will only be returned if the type property is "DYNAMIC". This property cannot be updated via API.

type
enum

Can be: REGULAR or DYNAMIC. The type of page, dynamic pages will be backed by a site collection. Pages created using the Create Page API endpoint will always have a type of "REGULAR". This property cannot be updated via API.

title
string

The title of a page. It's used in the navigation of the site and pages menu.

path
string

The path / URL to a page on the website.

seo
object

See the section below for details.

header_html
string

Contains the custom header HTML set for a specific page.

draft_status
enum

Can be: STAGED_DRAFT or DRAFT. If marked as STAGED_DRAFT, the page will be published alongside the next publish of the site. If DRAFT, then the page will not be published and a currently published page will be unpublished. You cannot set the home page as draft.

seo

Field

Description

title string

Set the <title> on this page. Should be less than 60 characters in length.

description
string

The meta description of the page. Should be around 155 characters in length.

no_index
boolean

Set if this page should be indexed by search engines or not. This will apply a meta robots noindex tag to this page.

og_image
string

URL to the image to be used as the Open Graph sharing image.