Page

Representation of a page object

Developer CommunityArticlesBloggingSocialContentOpen Source

Properties

Name	Type	Description
title	string	Title of the page
slug	string	Used to link to this page in URLs, must be unique and URL-safe
description	string	For internal use, helps similar pages from one another
body_markdown	string	The text (in markdown) of the ad (required)
body_json	string	For JSON pages, the JSON body
is_top_level_path	boolean	If true, the page is available at '/{slug}' instead of '/page/{slug}', use with caution
social_image	object
template	string	Controls what kind of layout the page is rendered in

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Page",
  "description": "Representation of a page object",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Title of the page"
    },
    "slug": {
      "type": "string",
      "description": "Used to link to this page in URLs, must be unique and URL-safe"
    },
    "description": {
      "type": "string",
      "description": "For internal use, helps similar pages from one another"
    },
    "body_markdown": {
      "type": "string",
      "description": "The text (in markdown) of the ad (required)",
      "nullable": true
    },
    "body_json": {
      "type": "string",
      "description": "For JSON pages, the JSON body",
      "nullable": true
    },
    "is_top_level_path": {
      "type": "boolean",
      "description": "If true, the page is available at '/{slug}' instead of '/page/{slug}', use with caution"
    },
    "social_image": {
      "type": "object",
      "nullable": true
    },
    "template": {
      "type": "string",
      "enum": [
        "contained",
        "full_within_layout",
        "nav_bar_included",
        "json",
        "css",
        "txt"
      ],
      "default": "contained",
      "description": "Controls what kind of layout the page is rendered in"
    }
  },
  "required": [
    "title",
    "slug",
    "description",
    "template"
  ]
}