HubSpot · Schema

PageCreateRequest

Request body for creating a CMS page.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
name string The internal name of the page.
htmlTitle string The HTML title tag content.
slug string The URL slug for the page.
metaDescription string The meta description for SEO.
domain string The domain to host the page on.
language string The language code for the page content.
templatePath string The path to the template to use for the page.
layoutSections object The layout sections and widget data for the page content.
View JSON Schema on GitHub

JSON Schema

cms-pages-api-page-create-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/cms-pages-api-page-create-request-schema.json",
  "title": "PageCreateRequest",
  "description": "Request body for creating a CMS page.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The internal name of the page.",
      "example": "Example Record"
    },
    "htmlTitle": {
      "type": "string",
      "description": "The HTML title tag content.",
      "example": "Example Record"
    },
    "slug": {
      "type": "string",
      "description": "The URL slug for the page.",
      "example": "example-value"
    },
    "metaDescription": {
      "type": "string",
      "description": "The meta description for SEO.",
      "example": "This is an example description."
    },
    "domain": {
      "type": "string",
      "description": "The domain to host the page on.",
      "example": "example.hubspot.com"
    },
    "language": {
      "type": "string",
      "description": "The language code for the page content.",
      "example": "en"
    },
    "templatePath": {
      "type": "string",
      "description": "The path to the template to use for the page.",
      "example": "/content/templates/example"
    },
    "layoutSections": {
      "type": "object",
      "description": "The layout sections and widget data for the page content.",
      "additionalProperties": true,
      "example": {
        "key": "value"
      }
    }
  },
  "required": [
    "name",
    "slug"
  ]
}