Create a new page | CMS Page Publishing API

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

Marketing

Required Scope:

Create a new page.

Required Parameters	How to use	Description
OAuth Access Token or API Key	Authorization: Bearer {token} header or hapikey={key} query parameter.	Used to authenticate the request. Please see this page for more details about authentication.

Allowed JSON Fields in the body

Parameter name	Type	Description
campaign	string	The guid of the marketing campaign this page is associated with
campaign_name	string	The name of the marketing campaign this page is associated with
footer_html	string	Custom HTML for embed codes, javascript that should be placed before the </body> tag of the page
head_html	string	Custom HTML for embed codes, javascript, etc. that goes in the <head> tag of the page
is_draft	string	True if the post is still a draft, invisible to the public. Gets changed when the /publish-action API endpoint is called
meta_description	string	A description that goes in <meta> tag on the page
meta_keywords	string	Keywords for the meta tag
name	string	The internal name of the page
password	string	Set this to create a password protected page. Entering the password will be required to view the page
publish_date	long	The date the page is to be published at in milliseconds since the unix epoch.
publish_immediately	string	Set this to true if you want to be published immediately when the schedule publish endpoint is called, and to ignore the publish_date setting
slug	string	The path of the URL on which the page will live. Changing this will change the URL.
subcategory	string	This is set to empty or to "landing_page" for landing pages, or to "site_page" for site pages
widget_containers	string	A data structure containing the data for all the modules inside the containers for this post. This will only be populated if the page has widget containers.
widgets	string	A data structure containing the data for all the modules for this page.

A successful request returns a 201 response.

JSON