Create website pages
curl --request POST \
--url https://api.hubapi.com/cms/v3/pages/site-pages/batch/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
{
"abTestId": "<string>",
"archivedAt": "2023-11-07T05:31:56Z",
"archivedInDashboard": true,
"attachedStylesheets": [
{}
],
"authorName": "<string>",
"campaign": "<string>",
"categoryId": 123,
"contentGroupId": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdById": "<string>",
"currentlyPublished": true,
"domain": "<string>",
"dynamicPageDataSourceId": "<string>",
"dynamicPageDataSourceType": 123,
"dynamicPageHubDbTableId": "<string>",
"enableDomainStylesheets": true,
"enableLayoutStylesheets": true,
"featuredImage": "<string>",
"featuredImageAltText": "<string>",
"folderId": "<string>",
"footerHtml": "<string>",
"headHtml": "<string>",
"htmlTitle": "<string>",
"id": "<string>",
"includeDefaultCustomCss": true,
"layoutSections": {},
"linkRelCanonicalUrl": "<string>",
"mabExperimentId": "<string>",
"metaDescription": "<string>",
"name": "<string>",
"pageExpiryDate": 123,
"pageExpiryEnabled": true,
"pageExpiryRedirectId": 123,
"pageExpiryRedirectUrl": "<string>",
"pageRedirected": true,
"password": "<string>",
"publicAccessRules": [
{}
],
"publicAccessRulesEnabled": true,
"publishDate": "2023-11-07T05:31:56Z",
"publishImmediately": true,
"slug": "<string>",
"state": "<string>",
"subcategory": "<string>",
"templatePath": "<string>",
"themeSettingsValues": {},
"translatedFromId": "<string>",
"translations": {},
"updated": "2023-11-07T05:31:56Z",
"updatedById": "<string>",
"url": "<string>",
"useFeaturedImage": true,
"widgetContainers": {},
"widgets": {}
}
]
}
'import requests
url = "https://api.hubapi.com/cms/v3/pages/site-pages/batch/create"
payload = { "inputs": [
{
"abTestId": "<string>",
"archivedAt": "2023-11-07T05:31:56Z",
"archivedInDashboard": True,
"attachedStylesheets": [{}],
"authorName": "<string>",
"campaign": "<string>",
"categoryId": 123,
"contentGroupId": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdById": "<string>",
"currentlyPublished": True,
"domain": "<string>",
"dynamicPageDataSourceId": "<string>",
"dynamicPageDataSourceType": 123,
"dynamicPageHubDbTableId": "<string>",
"enableDomainStylesheets": True,
"enableLayoutStylesheets": True,
"featuredImage": "<string>",
"featuredImageAltText": "<string>",
"folderId": "<string>",
"footerHtml": "<string>",
"headHtml": "<string>",
"htmlTitle": "<string>",
"id": "<string>",
"includeDefaultCustomCss": True,
"layoutSections": {},
"linkRelCanonicalUrl": "<string>",
"mabExperimentId": "<string>",
"metaDescription": "<string>",
"name": "<string>",
"pageExpiryDate": 123,
"pageExpiryEnabled": True,
"pageExpiryRedirectId": 123,
"pageExpiryRedirectUrl": "<string>",
"pageRedirected": True,
"password": "<string>",
"publicAccessRules": [{}],
"publicAccessRulesEnabled": True,
"publishDate": "2023-11-07T05:31:56Z",
"publishImmediately": True,
"slug": "<string>",
"state": "<string>",
"subcategory": "<string>",
"templatePath": "<string>",
"themeSettingsValues": {},
"translatedFromId": "<string>",
"translations": {},
"updated": "2023-11-07T05:31:56Z",
"updatedById": "<string>",
"url": "<string>",
"useFeaturedImage": True,
"widgetContainers": {},
"widgets": {}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inputs: [
{
abTestId: '<string>',
archivedAt: '2023-11-07T05:31:56Z',
archivedInDashboard: true,
attachedStylesheets: [{}],
authorName: '<string>',
campaign: '<string>',
categoryId: 123,
contentGroupId: '<string>',
created: '2023-11-07T05:31:56Z',
createdById: '<string>',
currentlyPublished: true,
domain: '<string>',
dynamicPageDataSourceId: '<string>',
dynamicPageDataSourceType: 123,
dynamicPageHubDbTableId: '<string>',
enableDomainStylesheets: true,
enableLayoutStylesheets: true,
featuredImage: '<string>',
featuredImageAltText: '<string>',
folderId: '<string>',
footerHtml: '<string>',
headHtml: '<string>',
htmlTitle: '<string>',
id: '<string>',
includeDefaultCustomCss: true,
layoutSections: {},
linkRelCanonicalUrl: '<string>',
mabExperimentId: '<string>',
metaDescription: '<string>',
name: '<string>',
pageExpiryDate: 123,
pageExpiryEnabled: true,
pageExpiryRedirectId: 123,
pageExpiryRedirectUrl: '<string>',
pageRedirected: true,
password: '<string>',
publicAccessRules: [{}],
publicAccessRulesEnabled: true,
publishDate: '2023-11-07T05:31:56Z',
publishImmediately: true,
slug: '<string>',
state: '<string>',
subcategory: '<string>',
templatePath: '<string>',
themeSettingsValues: {},
translatedFromId: '<string>',
translations: {},
updated: '2023-11-07T05:31:56Z',
updatedById: '<string>',
url: '<string>',
useFeaturedImage: true,
widgetContainers: {},
widgets: {}
}
]
})
};
fetch('https://api.hubapi.com/cms/v3/pages/site-pages/batch/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/cms/v3/pages/site-pages/batch/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'inputs' => [
[
'abTestId' => '<string>',
'archivedAt' => '2023-11-07T05:31:56Z',
'archivedInDashboard' => true,
'attachedStylesheets' => [
[
]
],
'authorName' => '<string>',
'campaign' => '<string>',
'categoryId' => 123,
'contentGroupId' => '<string>',
'created' => '2023-11-07T05:31:56Z',
'createdById' => '<string>',
'currentlyPublished' => true,
'domain' => '<string>',
'dynamicPageDataSourceId' => '<string>',
'dynamicPageDataSourceType' => 123,
'dynamicPageHubDbTableId' => '<string>',
'enableDomainStylesheets' => true,
'enableLayoutStylesheets' => true,
'featuredImage' => '<string>',
'featuredImageAltText' => '<string>',
'folderId' => '<string>',
'footerHtml' => '<string>',
'headHtml' => '<string>',
'htmlTitle' => '<string>',
'id' => '<string>',
'includeDefaultCustomCss' => true,
'layoutSections' => [
],
'linkRelCanonicalUrl' => '<string>',
'mabExperimentId' => '<string>',
'metaDescription' => '<string>',
'name' => '<string>',
'pageExpiryDate' => 123,
'pageExpiryEnabled' => true,
'pageExpiryRedirectId' => 123,
'pageExpiryRedirectUrl' => '<string>',
'pageRedirected' => true,
'password' => '<string>',
'publicAccessRules' => [
[
]
],
'publicAccessRulesEnabled' => true,
'publishDate' => '2023-11-07T05:31:56Z',
'publishImmediately' => true,
'slug' => '<string>',
'state' => '<string>',
'subcategory' => '<string>',
'templatePath' => '<string>',
'themeSettingsValues' => [
],
'translatedFromId' => '<string>',
'translations' => [
],
'updated' => '2023-11-07T05:31:56Z',
'updatedById' => '<string>',
'url' => '<string>',
'useFeaturedImage' => true,
'widgetContainers' => [
],
'widgets' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/cms/v3/pages/site-pages/batch/create"
payload := strings.NewReader("{\n \"inputs\": [\n {\n \"abTestId\": \"<string>\",\n \"archivedAt\": \"2023-11-07T05:31:56Z\",\n \"archivedInDashboard\": true,\n \"attachedStylesheets\": [\n {}\n ],\n \"authorName\": \"<string>\",\n \"campaign\": \"<string>\",\n \"categoryId\": 123,\n \"contentGroupId\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdById\": \"<string>\",\n \"currentlyPublished\": true,\n \"domain\": \"<string>\",\n \"dynamicPageDataSourceId\": \"<string>\",\n \"dynamicPageDataSourceType\": 123,\n \"dynamicPageHubDbTableId\": \"<string>\",\n \"enableDomainStylesheets\": true,\n \"enableLayoutStylesheets\": true,\n \"featuredImage\": \"<string>\",\n \"featuredImageAltText\": \"<string>\",\n \"folderId\": \"<string>\",\n \"footerHtml\": \"<string>\",\n \"headHtml\": \"<string>\",\n \"htmlTitle\": \"<string>\",\n \"id\": \"<string>\",\n \"includeDefaultCustomCss\": true,\n \"layoutSections\": {},\n \"linkRelCanonicalUrl\": \"<string>\",\n \"mabExperimentId\": \"<string>\",\n \"metaDescription\": \"<string>\",\n \"name\": \"<string>\",\n \"pageExpiryDate\": 123,\n \"pageExpiryEnabled\": true,\n \"pageExpiryRedirectId\": 123,\n \"pageExpiryRedirectUrl\": \"<string>\",\n \"pageRedirected\": true,\n \"password\": \"<string>\",\n \"publicAccessRules\": [\n {}\n ],\n \"publicAccessRulesEnabled\": true,\n \"publishDate\": \"2023-11-07T05:31:56Z\",\n \"publishImmediately\": true,\n \"slug\": \"<string>\",\n \"state\": \"<string>\",\n \"subcategory\": \"<string>\",\n \"templatePath\": \"<string>\",\n \"themeSettingsValues\": {},\n \"translatedFromId\": \"<string>\",\n \"translations\": {},\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedById\": \"<string>\",\n \"url\": \"<string>\",\n \"useFeaturedImage\": true,\n \"widgetContainers\": {},\n \"widgets\": {}\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/cms/v3/pages/site-pages/batch/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputs\": [\n {\n \"abTestId\": \"<string>\",\n \"archivedAt\": \"2023-11-07T05:31:56Z\",\n \"archivedInDashboard\": true,\n \"attachedStylesheets\": [\n {}\n ],\n \"authorName\": \"<string>\",\n \"campaign\": \"<string>\",\n \"categoryId\": 123,\n \"contentGroupId\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdById\": \"<string>\",\n \"currentlyPublished\": true,\n \"domain\": \"<string>\",\n \"dynamicPageDataSourceId\": \"<string>\",\n \"dynamicPageDataSourceType\": 123,\n \"dynamicPageHubDbTableId\": \"<string>\",\n \"enableDomainStylesheets\": true,\n \"enableLayoutStylesheets\": true,\n \"featuredImage\": \"<string>\",\n \"featuredImageAltText\": \"<string>\",\n \"folderId\": \"<string>\",\n \"footerHtml\": \"<string>\",\n \"headHtml\": \"<string>\",\n \"htmlTitle\": \"<string>\",\n \"id\": \"<string>\",\n \"includeDefaultCustomCss\": true,\n \"layoutSections\": {},\n \"linkRelCanonicalUrl\": \"<string>\",\n \"mabExperimentId\": \"<string>\",\n \"metaDescription\": \"<string>\",\n \"name\": \"<string>\",\n \"pageExpiryDate\": 123,\n \"pageExpiryEnabled\": true,\n \"pageExpiryRedirectId\": 123,\n \"pageExpiryRedirectUrl\": \"<string>\",\n \"pageRedirected\": true,\n \"password\": \"<string>\",\n \"publicAccessRules\": [\n {}\n ],\n \"publicAccessRulesEnabled\": true,\n \"publishDate\": \"2023-11-07T05:31:56Z\",\n \"publishImmediately\": true,\n \"slug\": \"<string>\",\n \"state\": \"<string>\",\n \"subcategory\": \"<string>\",\n \"templatePath\": \"<string>\",\n \"themeSettingsValues\": {},\n \"translatedFromId\": \"<string>\",\n \"translations\": {},\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedById\": \"<string>\",\n \"url\": \"<string>\",\n \"useFeaturedImage\": true,\n \"widgetContainers\": {},\n \"widgets\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/cms/v3/pages/site-pages/batch/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inputs\": [\n {\n \"abTestId\": \"<string>\",\n \"archivedAt\": \"2023-11-07T05:31:56Z\",\n \"archivedInDashboard\": true,\n \"attachedStylesheets\": [\n {}\n ],\n \"authorName\": \"<string>\",\n \"campaign\": \"<string>\",\n \"categoryId\": 123,\n \"contentGroupId\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdById\": \"<string>\",\n \"currentlyPublished\": true,\n \"domain\": \"<string>\",\n \"dynamicPageDataSourceId\": \"<string>\",\n \"dynamicPageDataSourceType\": 123,\n \"dynamicPageHubDbTableId\": \"<string>\",\n \"enableDomainStylesheets\": true,\n \"enableLayoutStylesheets\": true,\n \"featuredImage\": \"<string>\",\n \"featuredImageAltText\": \"<string>\",\n \"folderId\": \"<string>\",\n \"footerHtml\": \"<string>\",\n \"headHtml\": \"<string>\",\n \"htmlTitle\": \"<string>\",\n \"id\": \"<string>\",\n \"includeDefaultCustomCss\": true,\n \"layoutSections\": {},\n \"linkRelCanonicalUrl\": \"<string>\",\n \"mabExperimentId\": \"<string>\",\n \"metaDescription\": \"<string>\",\n \"name\": \"<string>\",\n \"pageExpiryDate\": 123,\n \"pageExpiryEnabled\": true,\n \"pageExpiryRedirectId\": 123,\n \"pageExpiryRedirectUrl\": \"<string>\",\n \"pageRedirected\": true,\n \"password\": \"<string>\",\n \"publicAccessRules\": [\n {}\n ],\n \"publicAccessRulesEnabled\": true,\n \"publishDate\": \"2023-11-07T05:31:56Z\",\n \"publishImmediately\": true,\n \"slug\": \"<string>\",\n \"state\": \"<string>\",\n \"subcategory\": \"<string>\",\n \"templatePath\": \"<string>\",\n \"themeSettingsValues\": {},\n \"translatedFromId\": \"<string>\",\n \"translations\": {},\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedById\": \"<string>\",\n \"url\": \"<string>\",\n \"useFeaturedImage\": true,\n \"widgetContainers\": {},\n \"widgets\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"abTestId": "<string>",
"archivedAt": "2023-11-07T05:31:56Z",
"archivedInDashboard": true,
"attachedStylesheets": [
{}
],
"authorName": "<string>",
"campaign": "<string>",
"categoryId": 123,
"contentGroupId": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdById": "<string>",
"currentlyPublished": true,
"domain": "<string>",
"dynamicPageDataSourceId": "<string>",
"dynamicPageDataSourceType": 123,
"dynamicPageHubDbTableId": "<string>",
"enableDomainStylesheets": true,
"enableLayoutStylesheets": true,
"featuredImage": "<string>",
"featuredImageAltText": "<string>",
"folderId": "<string>",
"footerHtml": "<string>",
"headHtml": "<string>",
"htmlTitle": "<string>",
"id": "<string>",
"includeDefaultCustomCss": true,
"layoutSections": {},
"linkRelCanonicalUrl": "<string>",
"mabExperimentId": "<string>",
"metaDescription": "<string>",
"name": "<string>",
"pageExpiryDate": 123,
"pageExpiryEnabled": true,
"pageExpiryRedirectId": 123,
"pageExpiryRedirectUrl": "<string>",
"pageRedirected": true,
"password": "<string>",
"publicAccessRules": [
{}
],
"publicAccessRulesEnabled": true,
"publishDate": "2023-11-07T05:31:56Z",
"publishImmediately": true,
"slug": "<string>",
"state": "<string>",
"subcategory": "<string>",
"templatePath": "<string>",
"themeSettingsValues": {},
"translatedFromId": "<string>",
"translations": {},
"updated": "2023-11-07T05:31:56Z",
"updatedById": "<string>",
"url": "<string>",
"useFeaturedImage": true,
"widgetContainers": {},
"widgets": {}
}
],
"startedAt": "2023-11-07T05:31:56Z",
"links": {},
"requestedAt": "2023-11-07T05:31:56Z"
}{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"abTestId": "<string>",
"archivedAt": "2023-11-07T05:31:56Z",
"archivedInDashboard": true,
"attachedStylesheets": [
{}
],
"authorName": "<string>",
"campaign": "<string>",
"categoryId": 123,
"contentGroupId": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdById": "<string>",
"currentlyPublished": true,
"domain": "<string>",
"dynamicPageDataSourceId": "<string>",
"dynamicPageDataSourceType": 123,
"dynamicPageHubDbTableId": "<string>",
"enableDomainStylesheets": true,
"enableLayoutStylesheets": true,
"featuredImage": "<string>",
"featuredImageAltText": "<string>",
"folderId": "<string>",
"footerHtml": "<string>",
"headHtml": "<string>",
"htmlTitle": "<string>",
"id": "<string>",
"includeDefaultCustomCss": true,
"layoutSections": {},
"linkRelCanonicalUrl": "<string>",
"mabExperimentId": "<string>",
"metaDescription": "<string>",
"name": "<string>",
"pageExpiryDate": 123,
"pageExpiryEnabled": true,
"pageExpiryRedirectId": 123,
"pageExpiryRedirectUrl": "<string>",
"pageRedirected": true,
"password": "<string>",
"publicAccessRules": [
{}
],
"publicAccessRulesEnabled": true,
"publishDate": "2023-11-07T05:31:56Z",
"publishImmediately": true,
"slug": "<string>",
"state": "<string>",
"subcategory": "<string>",
"templatePath": "<string>",
"themeSettingsValues": {},
"translatedFromId": "<string>",
"translations": {},
"updated": "2023-11-07T05:31:56Z",
"updatedById": "<string>",
"url": "<string>",
"useFeaturedImage": true,
"widgetContainers": {},
"widgets": {}
}
],
"startedAt": "2023-11-07T05:31:56Z",
"errors": [
{
"category": "<string>",
"context": {},
"errors": [
{
"message": "<string>",
"code": "<string>",
"context": "{missingScopes=[scope1, scope2]}",
"in": "<string>",
"subCategory": "<string>"
}
],
"links": {},
"message": "<string>",
"status": "<string>",
"id": "<string>",
"subCategory": {}
}
],
"links": {},
"numErrors": 123,
"requestedAt": "2023-11-07T05:31:56Z"
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}Batch
Create website pages
Create a batch of website pages as specified in the request body.
POST
/
cms
/
v3
/
pages
/
site-pages
/
batch
/
create
Create website pages
curl --request POST \
--url https://api.hubapi.com/cms/v3/pages/site-pages/batch/create \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputs": [
{
"abTestId": "<string>",
"archivedAt": "2023-11-07T05:31:56Z",
"archivedInDashboard": true,
"attachedStylesheets": [
{}
],
"authorName": "<string>",
"campaign": "<string>",
"categoryId": 123,
"contentGroupId": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdById": "<string>",
"currentlyPublished": true,
"domain": "<string>",
"dynamicPageDataSourceId": "<string>",
"dynamicPageDataSourceType": 123,
"dynamicPageHubDbTableId": "<string>",
"enableDomainStylesheets": true,
"enableLayoutStylesheets": true,
"featuredImage": "<string>",
"featuredImageAltText": "<string>",
"folderId": "<string>",
"footerHtml": "<string>",
"headHtml": "<string>",
"htmlTitle": "<string>",
"id": "<string>",
"includeDefaultCustomCss": true,
"layoutSections": {},
"linkRelCanonicalUrl": "<string>",
"mabExperimentId": "<string>",
"metaDescription": "<string>",
"name": "<string>",
"pageExpiryDate": 123,
"pageExpiryEnabled": true,
"pageExpiryRedirectId": 123,
"pageExpiryRedirectUrl": "<string>",
"pageRedirected": true,
"password": "<string>",
"publicAccessRules": [
{}
],
"publicAccessRulesEnabled": true,
"publishDate": "2023-11-07T05:31:56Z",
"publishImmediately": true,
"slug": "<string>",
"state": "<string>",
"subcategory": "<string>",
"templatePath": "<string>",
"themeSettingsValues": {},
"translatedFromId": "<string>",
"translations": {},
"updated": "2023-11-07T05:31:56Z",
"updatedById": "<string>",
"url": "<string>",
"useFeaturedImage": true,
"widgetContainers": {},
"widgets": {}
}
]
}
'import requests
url = "https://api.hubapi.com/cms/v3/pages/site-pages/batch/create"
payload = { "inputs": [
{
"abTestId": "<string>",
"archivedAt": "2023-11-07T05:31:56Z",
"archivedInDashboard": True,
"attachedStylesheets": [{}],
"authorName": "<string>",
"campaign": "<string>",
"categoryId": 123,
"contentGroupId": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdById": "<string>",
"currentlyPublished": True,
"domain": "<string>",
"dynamicPageDataSourceId": "<string>",
"dynamicPageDataSourceType": 123,
"dynamicPageHubDbTableId": "<string>",
"enableDomainStylesheets": True,
"enableLayoutStylesheets": True,
"featuredImage": "<string>",
"featuredImageAltText": "<string>",
"folderId": "<string>",
"footerHtml": "<string>",
"headHtml": "<string>",
"htmlTitle": "<string>",
"id": "<string>",
"includeDefaultCustomCss": True,
"layoutSections": {},
"linkRelCanonicalUrl": "<string>",
"mabExperimentId": "<string>",
"metaDescription": "<string>",
"name": "<string>",
"pageExpiryDate": 123,
"pageExpiryEnabled": True,
"pageExpiryRedirectId": 123,
"pageExpiryRedirectUrl": "<string>",
"pageRedirected": True,
"password": "<string>",
"publicAccessRules": [{}],
"publicAccessRulesEnabled": True,
"publishDate": "2023-11-07T05:31:56Z",
"publishImmediately": True,
"slug": "<string>",
"state": "<string>",
"subcategory": "<string>",
"templatePath": "<string>",
"themeSettingsValues": {},
"translatedFromId": "<string>",
"translations": {},
"updated": "2023-11-07T05:31:56Z",
"updatedById": "<string>",
"url": "<string>",
"useFeaturedImage": True,
"widgetContainers": {},
"widgets": {}
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inputs: [
{
abTestId: '<string>',
archivedAt: '2023-11-07T05:31:56Z',
archivedInDashboard: true,
attachedStylesheets: [{}],
authorName: '<string>',
campaign: '<string>',
categoryId: 123,
contentGroupId: '<string>',
created: '2023-11-07T05:31:56Z',
createdById: '<string>',
currentlyPublished: true,
domain: '<string>',
dynamicPageDataSourceId: '<string>',
dynamicPageDataSourceType: 123,
dynamicPageHubDbTableId: '<string>',
enableDomainStylesheets: true,
enableLayoutStylesheets: true,
featuredImage: '<string>',
featuredImageAltText: '<string>',
folderId: '<string>',
footerHtml: '<string>',
headHtml: '<string>',
htmlTitle: '<string>',
id: '<string>',
includeDefaultCustomCss: true,
layoutSections: {},
linkRelCanonicalUrl: '<string>',
mabExperimentId: '<string>',
metaDescription: '<string>',
name: '<string>',
pageExpiryDate: 123,
pageExpiryEnabled: true,
pageExpiryRedirectId: 123,
pageExpiryRedirectUrl: '<string>',
pageRedirected: true,
password: '<string>',
publicAccessRules: [{}],
publicAccessRulesEnabled: true,
publishDate: '2023-11-07T05:31:56Z',
publishImmediately: true,
slug: '<string>',
state: '<string>',
subcategory: '<string>',
templatePath: '<string>',
themeSettingsValues: {},
translatedFromId: '<string>',
translations: {},
updated: '2023-11-07T05:31:56Z',
updatedById: '<string>',
url: '<string>',
useFeaturedImage: true,
widgetContainers: {},
widgets: {}
}
]
})
};
fetch('https://api.hubapi.com/cms/v3/pages/site-pages/batch/create', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/cms/v3/pages/site-pages/batch/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'inputs' => [
[
'abTestId' => '<string>',
'archivedAt' => '2023-11-07T05:31:56Z',
'archivedInDashboard' => true,
'attachedStylesheets' => [
[
]
],
'authorName' => '<string>',
'campaign' => '<string>',
'categoryId' => 123,
'contentGroupId' => '<string>',
'created' => '2023-11-07T05:31:56Z',
'createdById' => '<string>',
'currentlyPublished' => true,
'domain' => '<string>',
'dynamicPageDataSourceId' => '<string>',
'dynamicPageDataSourceType' => 123,
'dynamicPageHubDbTableId' => '<string>',
'enableDomainStylesheets' => true,
'enableLayoutStylesheets' => true,
'featuredImage' => '<string>',
'featuredImageAltText' => '<string>',
'folderId' => '<string>',
'footerHtml' => '<string>',
'headHtml' => '<string>',
'htmlTitle' => '<string>',
'id' => '<string>',
'includeDefaultCustomCss' => true,
'layoutSections' => [
],
'linkRelCanonicalUrl' => '<string>',
'mabExperimentId' => '<string>',
'metaDescription' => '<string>',
'name' => '<string>',
'pageExpiryDate' => 123,
'pageExpiryEnabled' => true,
'pageExpiryRedirectId' => 123,
'pageExpiryRedirectUrl' => '<string>',
'pageRedirected' => true,
'password' => '<string>',
'publicAccessRules' => [
[
]
],
'publicAccessRulesEnabled' => true,
'publishDate' => '2023-11-07T05:31:56Z',
'publishImmediately' => true,
'slug' => '<string>',
'state' => '<string>',
'subcategory' => '<string>',
'templatePath' => '<string>',
'themeSettingsValues' => [
],
'translatedFromId' => '<string>',
'translations' => [
],
'updated' => '2023-11-07T05:31:56Z',
'updatedById' => '<string>',
'url' => '<string>',
'useFeaturedImage' => true,
'widgetContainers' => [
],
'widgets' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/cms/v3/pages/site-pages/batch/create"
payload := strings.NewReader("{\n \"inputs\": [\n {\n \"abTestId\": \"<string>\",\n \"archivedAt\": \"2023-11-07T05:31:56Z\",\n \"archivedInDashboard\": true,\n \"attachedStylesheets\": [\n {}\n ],\n \"authorName\": \"<string>\",\n \"campaign\": \"<string>\",\n \"categoryId\": 123,\n \"contentGroupId\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdById\": \"<string>\",\n \"currentlyPublished\": true,\n \"domain\": \"<string>\",\n \"dynamicPageDataSourceId\": \"<string>\",\n \"dynamicPageDataSourceType\": 123,\n \"dynamicPageHubDbTableId\": \"<string>\",\n \"enableDomainStylesheets\": true,\n \"enableLayoutStylesheets\": true,\n \"featuredImage\": \"<string>\",\n \"featuredImageAltText\": \"<string>\",\n \"folderId\": \"<string>\",\n \"footerHtml\": \"<string>\",\n \"headHtml\": \"<string>\",\n \"htmlTitle\": \"<string>\",\n \"id\": \"<string>\",\n \"includeDefaultCustomCss\": true,\n \"layoutSections\": {},\n \"linkRelCanonicalUrl\": \"<string>\",\n \"mabExperimentId\": \"<string>\",\n \"metaDescription\": \"<string>\",\n \"name\": \"<string>\",\n \"pageExpiryDate\": 123,\n \"pageExpiryEnabled\": true,\n \"pageExpiryRedirectId\": 123,\n \"pageExpiryRedirectUrl\": \"<string>\",\n \"pageRedirected\": true,\n \"password\": \"<string>\",\n \"publicAccessRules\": [\n {}\n ],\n \"publicAccessRulesEnabled\": true,\n \"publishDate\": \"2023-11-07T05:31:56Z\",\n \"publishImmediately\": true,\n \"slug\": \"<string>\",\n \"state\": \"<string>\",\n \"subcategory\": \"<string>\",\n \"templatePath\": \"<string>\",\n \"themeSettingsValues\": {},\n \"translatedFromId\": \"<string>\",\n \"translations\": {},\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedById\": \"<string>\",\n \"url\": \"<string>\",\n \"useFeaturedImage\": true,\n \"widgetContainers\": {},\n \"widgets\": {}\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/cms/v3/pages/site-pages/batch/create")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputs\": [\n {\n \"abTestId\": \"<string>\",\n \"archivedAt\": \"2023-11-07T05:31:56Z\",\n \"archivedInDashboard\": true,\n \"attachedStylesheets\": [\n {}\n ],\n \"authorName\": \"<string>\",\n \"campaign\": \"<string>\",\n \"categoryId\": 123,\n \"contentGroupId\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdById\": \"<string>\",\n \"currentlyPublished\": true,\n \"domain\": \"<string>\",\n \"dynamicPageDataSourceId\": \"<string>\",\n \"dynamicPageDataSourceType\": 123,\n \"dynamicPageHubDbTableId\": \"<string>\",\n \"enableDomainStylesheets\": true,\n \"enableLayoutStylesheets\": true,\n \"featuredImage\": \"<string>\",\n \"featuredImageAltText\": \"<string>\",\n \"folderId\": \"<string>\",\n \"footerHtml\": \"<string>\",\n \"headHtml\": \"<string>\",\n \"htmlTitle\": \"<string>\",\n \"id\": \"<string>\",\n \"includeDefaultCustomCss\": true,\n \"layoutSections\": {},\n \"linkRelCanonicalUrl\": \"<string>\",\n \"mabExperimentId\": \"<string>\",\n \"metaDescription\": \"<string>\",\n \"name\": \"<string>\",\n \"pageExpiryDate\": 123,\n \"pageExpiryEnabled\": true,\n \"pageExpiryRedirectId\": 123,\n \"pageExpiryRedirectUrl\": \"<string>\",\n \"pageRedirected\": true,\n \"password\": \"<string>\",\n \"publicAccessRules\": [\n {}\n ],\n \"publicAccessRulesEnabled\": true,\n \"publishDate\": \"2023-11-07T05:31:56Z\",\n \"publishImmediately\": true,\n \"slug\": \"<string>\",\n \"state\": \"<string>\",\n \"subcategory\": \"<string>\",\n \"templatePath\": \"<string>\",\n \"themeSettingsValues\": {},\n \"translatedFromId\": \"<string>\",\n \"translations\": {},\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedById\": \"<string>\",\n \"url\": \"<string>\",\n \"useFeaturedImage\": true,\n \"widgetContainers\": {},\n \"widgets\": {}\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/cms/v3/pages/site-pages/batch/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"inputs\": [\n {\n \"abTestId\": \"<string>\",\n \"archivedAt\": \"2023-11-07T05:31:56Z\",\n \"archivedInDashboard\": true,\n \"attachedStylesheets\": [\n {}\n ],\n \"authorName\": \"<string>\",\n \"campaign\": \"<string>\",\n \"categoryId\": 123,\n \"contentGroupId\": \"<string>\",\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdById\": \"<string>\",\n \"currentlyPublished\": true,\n \"domain\": \"<string>\",\n \"dynamicPageDataSourceId\": \"<string>\",\n \"dynamicPageDataSourceType\": 123,\n \"dynamicPageHubDbTableId\": \"<string>\",\n \"enableDomainStylesheets\": true,\n \"enableLayoutStylesheets\": true,\n \"featuredImage\": \"<string>\",\n \"featuredImageAltText\": \"<string>\",\n \"folderId\": \"<string>\",\n \"footerHtml\": \"<string>\",\n \"headHtml\": \"<string>\",\n \"htmlTitle\": \"<string>\",\n \"id\": \"<string>\",\n \"includeDefaultCustomCss\": true,\n \"layoutSections\": {},\n \"linkRelCanonicalUrl\": \"<string>\",\n \"mabExperimentId\": \"<string>\",\n \"metaDescription\": \"<string>\",\n \"name\": \"<string>\",\n \"pageExpiryDate\": 123,\n \"pageExpiryEnabled\": true,\n \"pageExpiryRedirectId\": 123,\n \"pageExpiryRedirectUrl\": \"<string>\",\n \"pageRedirected\": true,\n \"password\": \"<string>\",\n \"publicAccessRules\": [\n {}\n ],\n \"publicAccessRulesEnabled\": true,\n \"publishDate\": \"2023-11-07T05:31:56Z\",\n \"publishImmediately\": true,\n \"slug\": \"<string>\",\n \"state\": \"<string>\",\n \"subcategory\": \"<string>\",\n \"templatePath\": \"<string>\",\n \"themeSettingsValues\": {},\n \"translatedFromId\": \"<string>\",\n \"translations\": {},\n \"updated\": \"2023-11-07T05:31:56Z\",\n \"updatedById\": \"<string>\",\n \"url\": \"<string>\",\n \"useFeaturedImage\": true,\n \"widgetContainers\": {},\n \"widgets\": {}\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"abTestId": "<string>",
"archivedAt": "2023-11-07T05:31:56Z",
"archivedInDashboard": true,
"attachedStylesheets": [
{}
],
"authorName": "<string>",
"campaign": "<string>",
"categoryId": 123,
"contentGroupId": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdById": "<string>",
"currentlyPublished": true,
"domain": "<string>",
"dynamicPageDataSourceId": "<string>",
"dynamicPageDataSourceType": 123,
"dynamicPageHubDbTableId": "<string>",
"enableDomainStylesheets": true,
"enableLayoutStylesheets": true,
"featuredImage": "<string>",
"featuredImageAltText": "<string>",
"folderId": "<string>",
"footerHtml": "<string>",
"headHtml": "<string>",
"htmlTitle": "<string>",
"id": "<string>",
"includeDefaultCustomCss": true,
"layoutSections": {},
"linkRelCanonicalUrl": "<string>",
"mabExperimentId": "<string>",
"metaDescription": "<string>",
"name": "<string>",
"pageExpiryDate": 123,
"pageExpiryEnabled": true,
"pageExpiryRedirectId": 123,
"pageExpiryRedirectUrl": "<string>",
"pageRedirected": true,
"password": "<string>",
"publicAccessRules": [
{}
],
"publicAccessRulesEnabled": true,
"publishDate": "2023-11-07T05:31:56Z",
"publishImmediately": true,
"slug": "<string>",
"state": "<string>",
"subcategory": "<string>",
"templatePath": "<string>",
"themeSettingsValues": {},
"translatedFromId": "<string>",
"translations": {},
"updated": "2023-11-07T05:31:56Z",
"updatedById": "<string>",
"url": "<string>",
"useFeaturedImage": true,
"widgetContainers": {},
"widgets": {}
}
],
"startedAt": "2023-11-07T05:31:56Z",
"links": {},
"requestedAt": "2023-11-07T05:31:56Z"
}{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"abTestId": "<string>",
"archivedAt": "2023-11-07T05:31:56Z",
"archivedInDashboard": true,
"attachedStylesheets": [
{}
],
"authorName": "<string>",
"campaign": "<string>",
"categoryId": 123,
"contentGroupId": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdById": "<string>",
"currentlyPublished": true,
"domain": "<string>",
"dynamicPageDataSourceId": "<string>",
"dynamicPageDataSourceType": 123,
"dynamicPageHubDbTableId": "<string>",
"enableDomainStylesheets": true,
"enableLayoutStylesheets": true,
"featuredImage": "<string>",
"featuredImageAltText": "<string>",
"folderId": "<string>",
"footerHtml": "<string>",
"headHtml": "<string>",
"htmlTitle": "<string>",
"id": "<string>",
"includeDefaultCustomCss": true,
"layoutSections": {},
"linkRelCanonicalUrl": "<string>",
"mabExperimentId": "<string>",
"metaDescription": "<string>",
"name": "<string>",
"pageExpiryDate": 123,
"pageExpiryEnabled": true,
"pageExpiryRedirectId": 123,
"pageExpiryRedirectUrl": "<string>",
"pageRedirected": true,
"password": "<string>",
"publicAccessRules": [
{}
],
"publicAccessRulesEnabled": true,
"publishDate": "2023-11-07T05:31:56Z",
"publishImmediately": true,
"slug": "<string>",
"state": "<string>",
"subcategory": "<string>",
"templatePath": "<string>",
"themeSettingsValues": {},
"translatedFromId": "<string>",
"translations": {},
"updated": "2023-11-07T05:31:56Z",
"updatedById": "<string>",
"url": "<string>",
"useFeaturedImage": true,
"widgetContainers": {},
"widgets": {}
}
],
"startedAt": "2023-11-07T05:31:56Z",
"errors": [
{
"category": "<string>",
"context": {},
"errors": [
{
"message": "<string>",
"code": "<string>",
"context": "{missingScopes=[scope1, scope2]}",
"in": "<string>",
"subCategory": "<string>"
}
],
"links": {},
"message": "<string>",
"status": "<string>",
"id": "<string>",
"subCategory": {}
}
],
"links": {},
"numErrors": 123,
"requestedAt": "2023-11-07T05:31:56Z"
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
Wrapper for providing an array of pages as inputs.
Pages to input.
Show child attributes
Show child attributes
Response
successful operation
Response object for successful batch operations on pages.
Time of batch operation completion.
Results of batch operation.
Show child attributes
Show child attributes
Time of batch operation start.
Status of batch operation.
Available options:
CANCELED, COMPLETE, PENDING, PROCESSING Links associated with batch operation.
Show child attributes
Show child attributes
Time of batch operation request.
Last modified on March 30, 2026
Was this page helpful?
⌘I