{
"openapi" : "3.0.1",
"info" : {
"title" : "Pages",
"description" : "Use these endpoints for interacting with Landing Pages and Site Pages",
"version" : "v3",
"x-hubspot-product-tier-requirements" : {
"marketing" : "FREE",
"sales" : "FREE",
"service" : "FREE",
"cms" : "FREE",
"commerce" : "FREE",
"crmHub" : "FREE",
"dataHub" : "FREE"
},
"x-hubspot-api-use-case" : "After noticing that a website page was updated incorrectly, use the API to view revisions of that page, then restore the page to a previous version.",
"x-hubspot-related-documentation" : [ {
"name" : "Pages Guide",
"url" : "https://developers.hubspot.com/docs/guides/api/cms/pages"
} ],
"x-hubspot-introduction" : "Use the pages API to create and manage website pages."
},
"servers" : [ {
"url" : "https://api.hubapi.com"
} ],
"tags" : [ {
"name" : "A/B tests"
}, {
"name" : "Advanced"
}, {
"name" : "Basic"
}, {
"name" : "Batch"
}, {
"name" : "Folders"
}, {
"name" : "Landing pages"
}, {
"name" : "Multi-language"
}, {
"name" : "Website pages"
} ],
"paths" : {
"/cms/pages/v3/landing-pages/cursor" : {
"get" : {
"tags" : [ "Basic" ],
"operationId" : "get-/cms/pages/v3/landing-pages/cursor_/cms/pages/v3/landing-pages/cursor",
"parameters" : [ {
"name" : "after",
"in" : "query",
"description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Whether to return only results that have been archived.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
}, {
"name" : "createdAfter",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdAt",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdBefore",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of results to display per page.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
}, {
"name" : "property",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "sort",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
}
}, {
"name" : "updatedAfter",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedAt",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedBefore",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CursorPagedResultPageLong"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
}
},
"/cms/pages/v3/landing-pages/cursor/query" : {
"get" : {
"tags" : [ "Basic" ],
"operationId" : "get-/cms/pages/v3/landing-pages/cursor/query_/cms/pages/v3/landing-pages/cursor/query",
"parameters" : [ {
"name" : "after",
"in" : "query",
"description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Whether to return only results that have been archived.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
}, {
"name" : "createdAfter",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdAt",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdBefore",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of results to display per page.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
}, {
"name" : "property",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "sort",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
}
}, {
"name" : "updatedAfter",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedAt",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedBefore",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CursorPagedResultPageLong"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
}
},
"/cms/pages/v3/landing-pages/folders/cursor" : {
"get" : {
"tags" : [ "Basic" ],
"operationId" : "get-/cms/pages/v3/landing-pages/folders/cursor_/cms/pages/v3/landing-pages/folders/cursor",
"parameters" : [ {
"name" : "after",
"in" : "query",
"description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Whether to return only results that have been archived.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
}, {
"name" : "createdAfter",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdAt",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdBefore",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of results to display per page.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
}, {
"name" : "property",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "sort",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
}
}, {
"name" : "updatedAfter",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedAt",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedBefore",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CursorPagedResultContentFolderLong"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
}
},
"/cms/pages/v3/landing-pages/folders/cursor/query" : {
"get" : {
"tags" : [ "Basic" ],
"operationId" : "get-/cms/pages/v3/landing-pages/folders/cursor/query_/cms/pages/v3/landing-pages/folders/cursor/query",
"parameters" : [ {
"name" : "after",
"in" : "query",
"description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Whether to return only results that have been archived.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
}, {
"name" : "createdAfter",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdAt",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdBefore",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of results to display per page.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
}, {
"name" : "property",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "sort",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
}
}, {
"name" : "updatedAfter",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedAt",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedBefore",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CursorPagedResultContentFolderLong"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
}
},
"/cms/pages/v3/site-pages/cursor" : {
"get" : {
"tags" : [ "Basic" ],
"operationId" : "get-/cms/pages/v3/site-pages/cursor_/cms/pages/v3/site-pages/cursor",
"parameters" : [ {
"name" : "after",
"in" : "query",
"description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Whether to return only results that have been archived.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
}, {
"name" : "createdAfter",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdAt",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdBefore",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of results to display per page.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
}, {
"name" : "property",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "sort",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
}
}, {
"name" : "updatedAfter",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedAt",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedBefore",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CursorPagedResultPageLong"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.site_pages.read" ]
} ]
}
},
"/cms/pages/v3/site-pages/cursor/query" : {
"get" : {
"tags" : [ "Basic" ],
"operationId" : "get-/cms/pages/v3/site-pages/cursor/query_/cms/pages/v3/site-pages/cursor/query",
"parameters" : [ {
"name" : "after",
"in" : "query",
"description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Whether to return only results that have been archived.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
}, {
"name" : "createdAfter",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdAt",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdBefore",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of results to display per page.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
}, {
"name" : "property",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "sort",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
}
}, {
"name" : "updatedAfter",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedAt",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedBefore",
"in" : "query",
"description" : "",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CursorPagedResultPageLong"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.site_pages.read" ]
} ]
}
},
"/cms/v3/pages/landing-pages" : {
"get" : {
"tags" : [ "Landing pages" ],
"summary" : "Get all landing pages",
"description" : "Get the list of landing pages. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n",
"operationId" : "get-/cms/v3/pages/landing-pages_getPage",
"parameters" : [ {
"name" : "after",
"in" : "query",
"description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Specifies whether to return deleted Landing Pages. Defaults to `false`.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
}, {
"name" : "createdAfter",
"in" : "query",
"description" : "Only return Landing Pages created after the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdAt",
"in" : "query",
"description" : "Only return Landing Pages created at exactly the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdBefore",
"in" : "query",
"description" : "Only return Landing Pages created before the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of results to return. Default is 100.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
}, {
"name" : "property",
"in" : "query",
"description" : "Specifies which properties of the landing pages to include in the response.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "sort",
"in" : "query",
"description" : "Specifies which fields to use for sorting results. Valid fields are `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. `createdAt` will be used by default.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
}
}, {
"name" : "updatedAfter",
"in" : "query",
"description" : "Only return Landing Pages last updated after the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedAt",
"in" : "query",
"description" : "Only return Landing Pages last updated at exactly the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedBefore",
"in" : "query",
"description" : "Only return Landing Pages last updated before the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CollectionResponseWithTotalPageForwardPaging"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
},
"post" : {
"tags" : [ "Landing pages" ],
"summary" : "Create a landing page",
"description" : "Create a new landing page.",
"operationId" : "post-/cms/v3/pages/landing-pages_create",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "successful operation",
"headers" : {
"Location" : {
"description" : "URL of the newly created resource",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}
},
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/ab-test/create-variation" : {
"post" : {
"tags" : [ "A/B tests" ],
"summary" : "Create a new A/B test variation",
"description" : "Create a new A/B test variation based on the information provided in the request body.\n",
"operationId" : "post-/cms/v3/pages/landing-pages/ab-test/create-variation_createABTestVariation",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AbTestCreateRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "successful operation",
"headers" : {
"Location" : {
"description" : "URL of the newly created resource",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}
},
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/ab-test/end" : {
"post" : {
"tags" : [ "A/B tests" ],
"summary" : "End an active A/B test",
"description" : "End an active A/B test and designate a winner.",
"operationId" : "post-/cms/v3/pages/landing-pages/ab-test/end_endActiveABTest",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AbTestEndRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/ab-test/rerun" : {
"post" : {
"tags" : [ "A/B tests" ],
"summary" : "Rerun a previous A/B test",
"description" : "Rerun a previous A/B test.",
"operationId" : "post-/cms/v3/pages/landing-pages/ab-test/rerun_rerunPreviousABTest",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AbTestRerunRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/batch/archive" : {
"post" : {
"tags" : [ "Batch" ],
"summary" : "Delete landing pages",
"description" : "Delete landing pages specified by ID in the request body. Note: this is not the same as the dashboard `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.",
"operationId" : "post-/cms/v3/pages/landing-pages/batch/archive_archiveBatch",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchInputString"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/batch/create" : {
"post" : {
"tags" : [ "Batch" ],
"summary" : "Create landing pages",
"description" : "Create a batch of landing pages as detailed in the request body.",
"operationId" : "post-/cms/v3/pages/landing-pages/batch/create_createBatch",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchInputPage"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponsePage"
},
"example" : null
}
}
},
"207" : {
"description" : "multiple statuses",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponsePageWithErrors"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/batch/read" : {
"post" : {
"tags" : [ "Batch" ],
"summary" : "Retrieve landing pages",
"description" : "Retrieve a batch of landing pages as specified in the request body.",
"operationId" : "post-/cms/v3/pages/landing-pages/batch/read_readBatch",
"parameters" : [ {
"name" : "archived",
"in" : "query",
"description" : "Specifies whether to return deleted Landing Pages. Defaults to `false`.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchInputString"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponsePage"
},
"example" : null
}
}
},
"207" : {
"description" : "multiple statuses",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponsePageWithErrors"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
}
},
"/cms/v3/pages/landing-pages/batch/update" : {
"post" : {
"tags" : [ "Batch" ],
"summary" : "Update landing pages",
"description" : "Update a batch of landing pages as specified in the request body.",
"operationId" : "post-/cms/v3/pages/landing-pages/batch/update_updateBatch",
"parameters" : [ {
"name" : "archived",
"in" : "query",
"description" : "Specifies whether to update deleted Landing Pages. Defaults to `false`.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchInputJsonNode"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponsePage"
},
"example" : null
}
}
},
"207" : {
"description" : "multiple statuses",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponsePageWithErrors"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/clone" : {
"post" : {
"tags" : [ "Landing pages" ],
"summary" : "Clone a landing page",
"description" : "Create a copy of an existing landing page.",
"operationId" : "post-/cms/v3/pages/landing-pages/clone_clone",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContentCloneRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/folders" : {
"get" : {
"tags" : [ "Folders" ],
"summary" : "Get all landing page folders",
"description" : "Get the list of Landing Page Folders. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.\n",
"operationId" : "get-/cms/v3/pages/landing-pages/folders_getFoldersPage",
"parameters" : [ {
"name" : "after",
"in" : "query",
"description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Specifies whether to return deleted Folders. Defaults to `false`.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
}, {
"name" : "createdAfter",
"in" : "query",
"description" : "Only return Folders created after the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdAt",
"in" : "query",
"description" : "Only return Folders created at exactly the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdBefore",
"in" : "query",
"description" : "Only return Folders created before the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of results to return. Default is 100.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
}, {
"name" : "property",
"in" : "query",
"description" : "Specifies which properties of the landing page folders to include in the response.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "sort",
"in" : "query",
"description" : "Specifies which fields to use for sorting results. Valid fields are `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. `createdAt` will be used by default.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
}
}, {
"name" : "updatedAfter",
"in" : "query",
"description" : "Only return Folders last updated after the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedAt",
"in" : "query",
"description" : "Only return Folders last updated at exactly the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedBefore",
"in" : "query",
"description" : "Only return Folders last updated before the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CollectionResponseWithTotalContentFolderForwardPaging"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
},
"post" : {
"tags" : [ "Folders" ],
"summary" : "Create a landing page folder",
"description" : "Create a new folder for landing pages.",
"operationId" : "post-/cms/v3/pages/landing-pages/folders_createFolder",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContentFolder"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "successful operation",
"headers" : {
"Location" : {
"description" : "URL of the newly created resource",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}
},
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContentFolder"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/folders/batch/archive" : {
"post" : {
"tags" : [ "Batch" ],
"summary" : "Delete folders",
"description" : "Delete a batch of folders as specified in the request body.",
"operationId" : "post-/cms/v3/pages/landing-pages/folders/batch/archive_archiveFolders",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchInputString"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/folders/batch/create" : {
"post" : {
"tags" : [ "Batch" ],
"summary" : "Create folders",
"description" : "Create a batch of folders as detailed in the request body.",
"operationId" : "post-/cms/v3/pages/landing-pages/folders/batch/create_createFolders",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchInputContentFolder"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponseContentFolder"
},
"example" : null
}
}
},
"207" : {
"description" : "multiple statuses",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponseContentFolderWithErrors"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/folders/batch/read" : {
"post" : {
"tags" : [ "Folders" ],
"summary" : "Retrieve folders",
"description" : "Retrieve a batch of landing page folders as identified in the request body.",
"operationId" : "post-/cms/v3/pages/landing-pages/folders/batch/read_readFolders",
"parameters" : [ {
"name" : "archived",
"in" : "query",
"description" : "Specifies whether to return deleted Folders. Defaults to `false`.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchInputString"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponseContentFolder"
},
"example" : null
}
}
},
"207" : {
"description" : "multiple statuses",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponseContentFolderWithErrors"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
}
},
"/cms/v3/pages/landing-pages/folders/batch/update" : {
"post" : {
"tags" : [ "Batch" ],
"summary" : "Update folders",
"description" : "Update a batch of landing page folders as specified in the request body.",
"operationId" : "post-/cms/v3/pages/landing-pages/folders/batch/update_updateFolders",
"parameters" : [ {
"name" : "archived",
"in" : "query",
"description" : "Whether to return only results that have been archived.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchInputJsonNode"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponseContentFolder"
},
"example" : null
}
}
},
"207" : {
"description" : "multiple statuses",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponseContentFolderWithErrors"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/folders/{objectId}" : {
"get" : {
"tags" : [ "Folders" ],
"summary" : "Retrieve a landing page folder",
"description" : "Retrieve a landing page folder, specified by its ID.",
"operationId" : "get-/cms/v3/pages/landing-pages/folders/{objectId}_getFolderById",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the landing page folder.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Specifies whether to return deleted Folders. Defaults to `false`.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
}, {
"name" : "property",
"in" : "query",
"description" : "Specifies which properties of the folder to include in the response.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContentFolder"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
},
"delete" : {
"tags" : [ "Folders" ],
"summary" : "Delete a landing page folder",
"description" : "Delete a landing page folder, specified by its ID.",
"operationId" : "delete-/cms/v3/pages/landing-pages/folders/{objectId}_archiveFolder",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the landing page folder.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Whether to return only results that have been archived.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
} ],
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
},
"patch" : {
"tags" : [ "Folders" ],
"summary" : "Update a landing page folder",
"description" : "Partially update a landing page folder, specified by the folder ID. You only need to specify the details values that you are modifying.\n",
"operationId" : "patch-/cms/v3/pages/landing-pages/folders/{objectId}_updateFolder",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the landing page folder.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Specifies whether to update deleted Folders. Defaults to `false`.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContentFolder"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContentFolder"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/folders/{objectId}/revisions" : {
"get" : {
"tags" : [ "Folders" ],
"summary" : "Retrieves previous versions of a folder",
"description" : "Retrieves all the previous versions of a landing page folder.",
"operationId" : "get-/cms/v3/pages/landing-pages/folders/{objectId}/revisions_getFolderPreviousVersions",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the folder.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "after",
"in" : "query",
"description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "before",
"in" : "query",
"description" : "The cursor token value to retrieve the set of results before the specified cursor.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of results to return. Default is 100.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CollectionResponseWithTotalContentFolderVersion"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
}
},
"/cms/v3/pages/landing-pages/folders/{objectId}/revisions/{revisionId}" : {
"get" : {
"tags" : [ "Folders" ],
"summary" : "Retrieve a previous version of a folder",
"description" : "Retrieve a previous version of a folder, specified by the folder ID and revision ID.",
"operationId" : "get-/cms/v3/pages/landing-pages/folders/{objectId}/revisions/{revisionId}_getFolderPreviousVersion",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The Folder id.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "revisionId",
"in" : "path",
"description" : "The Folder version id.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContentFolderVersion"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
}
},
"/cms/v3/pages/landing-pages/folders/{objectId}/revisions/{revisionId}/restore" : {
"post" : {
"tags" : [ "Folders" ],
"summary" : "Restore a previous version of a folder",
"description" : "Takes a specified version of a landing page folder and restores it.",
"operationId" : "post-/cms/v3/pages/landing-pages/folders/{objectId}/revisions/{revisionId}/restore_restoreFolderPreviousVersion",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The Folder id.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "revisionId",
"in" : "path",
"description" : "The Folder version id to restore.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContentFolder"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/multi-language/attach-to-lang-group" : {
"post" : {
"tags" : [ "Multi-language" ],
"summary" : "Add a landing page to a multi-language group",
"description" : "Attach a landing page to a multi-language group.",
"operationId" : "post-/cms/v3/pages/landing-pages/multi-language/attach-to-lang-group_attachToLangGroup",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AttachToLangPrimaryRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/multi-language/create-language-variation" : {
"post" : {
"tags" : [ "Multi-language" ],
"summary" : "Create a new language variation",
"description" : "Create a new language variation from an existing landing page",
"operationId" : "post-/cms/v3/pages/landing-pages/multi-language/create-language-variation_createLangVariation",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContentLanguageCloneRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/multi-language/detach-from-lang-group" : {
"post" : {
"tags" : [ "Multi-language" ],
"summary" : "Remove a landing page from a multi-language group",
"description" : "Detach a landing page from a multi-language group.",
"operationId" : "post-/cms/v3/pages/landing-pages/multi-language/detach-from-lang-group_detachFromLangGroup",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DetachFromLangGroupRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/multi-language/set-new-lang-primary" : {
"put" : {
"tags" : [ "Website pages" ],
"summary" : "Set a new primary language",
"description" : "Set a landing page as the primary language of a multi-language group.",
"operationId" : "put-/cms/v3/pages/landing-pages/multi-language/set-new-lang-primary_setLangPrimary",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SetNewLanguagePrimaryRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/multi-language/update-languages" : {
"post" : {
"tags" : [ "Multi-language" ],
"summary" : "Update languages of multi-language group",
"description" : "Explicitly set new languages for each landing page in a multi-language group.",
"operationId" : "post-/cms/v3/pages/landing-pages/multi-language/update-languages_updateLangs",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateLanguagesRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/schedule" : {
"post" : {
"tags" : [ "Landing pages" ],
"summary" : "Schedule landing page publishing",
"description" : "Schedule a landing page to be published.",
"operationId" : "post-/cms/v3/pages/landing-pages/schedule_schedule",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContentScheduleRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/{objectId}" : {
"get" : {
"tags" : [ "Landing pages" ],
"summary" : "Retrieve a landing page",
"description" : "Retrieve a landing page, specified by its ID.",
"operationId" : "get-/cms/v3/pages/landing-pages/{objectId}_getById",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the landing page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Specifies whether to return deleted Landing Pages. Defaults to `false`.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
}, {
"name" : "property",
"in" : "query",
"description" : "Specifies which properties of the landing page to include in the response.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
},
"delete" : {
"tags" : [ "Landing pages" ],
"summary" : "Delete a landing page",
"description" : "Delete a landing page, specified by its ID.",
"operationId" : "delete-/cms/v3/pages/landing-pages/{objectId}_archive",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the landing page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Whether to return only results that have been archived.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
} ],
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
},
"patch" : {
"tags" : [ "Landing pages" ],
"summary" : "Update a landing page",
"description" : "Sparse updates a single Landing Page object identified by the id in the path.\nYou only need to specify the column values that you are modifying.",
"operationId" : "patch-/cms/v3/pages/landing-pages/{objectId}_update",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the landing page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Specifies whether to update deleted Landing Pages. Defaults to `false`.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/{objectId}/draft" : {
"get" : {
"tags" : [ "Landing pages" ],
"summary" : "Retrieve a landing page draft",
"description" : "Retrieve the full draft version of a landing page, specified by page ID.",
"operationId" : "get-/cms/v3/pages/landing-pages/{objectId}/draft_getDraftById",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the landing page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
},
"patch" : {
"tags" : [ "Landing pages" ],
"summary" : "Update the draft of a landing page",
"description" : "Partially updates the draft version of a single landing page, specified by its ID. You only need to specify the column values that you are modifying.\n",
"operationId" : "patch-/cms/v3/pages/landing-pages/{objectId}/draft_updateDraft",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the landing page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/{objectId}/draft/push-live" : {
"post" : {
"tags" : [ "Landing pages" ],
"summary" : "Push Landing Page draft edits live",
"description" : "Take any changes from the draft version of the Landing Page and apply them to the live version.",
"operationId" : "post-/cms/v3/pages/landing-pages/{objectId}/draft/push-live_pushLive",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The id of the Landing Page for which it's draft will be pushed live.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/{objectId}/draft/reset" : {
"post" : {
"tags" : [ "Landing pages" ],
"summary" : "Reset a landing page draft",
"description" : "Discards any edits and resets the draft to match the live version.",
"operationId" : "post-/cms/v3/pages/landing-pages/{objectId}/draft/reset_resetDraft",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the landing page to reset.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/{objectId}/revisions" : {
"get" : {
"tags" : [ "Advanced" ],
"summary" : "Retrieve all previous versions of a landing page",
"description" : "Retrieve all the previous versions of a landing page, specified by page ID.",
"operationId" : "get-/cms/v3/pages/landing-pages/{objectId}/revisions_getPreviousVersions",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The landing page ID.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "after",
"in" : "query",
"description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "before",
"in" : "query",
"description" : "The cursor token value to retrieve the set of results before the current page.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of results to return. Default is 100.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CollectionResponseWithTotalPageVersion"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
}
},
"/cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}" : {
"get" : {
"tags" : [ "Advanced" ],
"summary" : "Retrieve a previous version of a landing page",
"description" : "Retrieve a previous version of a landing page, specified by page ID and revision ID.",
"operationId" : "get-/cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}_getPreviousVersion",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the landing page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "revisionId",
"in" : "path",
"description" : "The ID of the specific version to retrieve.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PageVersion"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.landing_pages.read" ]
} ]
}
},
"/cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}/restore" : {
"post" : {
"tags" : [ "Advanced" ],
"summary" : "Restore a previous version of a landing page",
"description" : "Restores a previous version of a landing page, specified by page ID and revision ID.",
"operationId" : "post-/cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}/restore_restorePreviousVersion",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the landing page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "revisionId",
"in" : "path",
"description" : "The ID of the specified version to restore.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}/restore-to-draft" : {
"post" : {
"tags" : [ "Advanced" ],
"summary" : "Restore a previous version of a landing page",
"description" : "Specify a previous version of a landing page to set as the page draft.",
"operationId" : "post-/cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}/restore-to-draft_restorePreviousVersionToDraft",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the landing page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "revisionId",
"in" : "path",
"description" : "The ID of the specific version to set as the draft.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.landing_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages" : {
"get" : {
"tags" : [ "Website pages" ],
"summary" : "Retrieve all website pages",
"description" : "Retrieve all website pages. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.",
"operationId" : "get-/cms/v3/pages/site-pages_getPage",
"parameters" : [ {
"name" : "after",
"in" : "query",
"description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Specifies whether to return deleted Site Pages. Defaults to `false`.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
}, {
"name" : "createdAfter",
"in" : "query",
"description" : "Only return Site Pages created after the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdAt",
"in" : "query",
"description" : "Only return Site Pages created at exactly the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "createdBefore",
"in" : "query",
"description" : "Only return Site Pages created before the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of results to return. Default is 100.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
}, {
"name" : "property",
"in" : "query",
"description" : "Specifies which properties of the site pages to include in the response.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "sort",
"in" : "query",
"description" : "Specifies which fields to use for sorting results. Valid fields are `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. `createdAt` will be used by default.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
}
}, {
"name" : "updatedAfter",
"in" : "query",
"description" : "Only return Site Pages last updated after the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedAt",
"in" : "query",
"description" : "Only return Site Pages last updated at exactly the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
}, {
"name" : "updatedBefore",
"in" : "query",
"description" : "Only return Site Pages last updated before the specified time.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"format" : "date-time",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CollectionResponseWithTotalPageForwardPaging"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.site_pages.read" ]
} ]
},
"post" : {
"tags" : [ "Website pages" ],
"summary" : "Create a website page",
"description" : "Create a new website page.",
"operationId" : "post-/cms/v3/pages/site-pages_create",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "successful operation",
"headers" : {
"Location" : {
"description" : "URL of the newly created resource",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}
},
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/ab-test/create-variation" : {
"post" : {
"tags" : [ "A/B tests" ],
"summary" : "Create a new A/B test variation",
"description" : "Create a new A/B test variation based on the information provided in the request body.\n",
"operationId" : "post-/cms/v3/pages/site-pages/ab-test/create-variation_createABTestVariation",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AbTestCreateRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "successful operation",
"headers" : {
"Location" : {
"description" : "URL of the newly created resource",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}
},
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/ab-test/end" : {
"post" : {
"tags" : [ "A/B tests" ],
"summary" : "End an active A/B test",
"description" : "End an active A/B test and designate a winner.",
"operationId" : "post-/cms/v3/pages/site-pages/ab-test/end_endActiveABTest",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AbTestEndRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/ab-test/rerun" : {
"post" : {
"tags" : [ "A/B tests" ],
"summary" : "Rerun a previous A/B test",
"description" : "Rerun a previous A/B test.",
"operationId" : "post-/cms/v3/pages/site-pages/ab-test/rerun_rerunPreviousABTest",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AbTestRerunRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/batch/archive" : {
"post" : {
"tags" : [ "Batch" ],
"summary" : "Delete website pages",
"description" : "Delete a batch of website pages as specified in the request body. Note: this is not the same as the dashboard `archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.",
"operationId" : "post-/cms/v3/pages/site-pages/batch/archive_archiveBatch",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchInputString"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/batch/create" : {
"post" : {
"tags" : [ "Batch" ],
"summary" : "Create website pages",
"description" : "Create a batch of website pages as specified in the request body.",
"operationId" : "post-/cms/v3/pages/site-pages/batch/create_createBatch",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchInputPage"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"201" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponsePage"
},
"example" : null
}
}
},
"207" : {
"description" : "multiple statuses",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponsePageWithErrors"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/batch/read" : {
"post" : {
"tags" : [ "Batch" ],
"summary" : "Retrieve website pages",
"description" : "Retrieve a batch of website pages as specified in the request body.",
"operationId" : "post-/cms/v3/pages/site-pages/batch/read_readBatch",
"parameters" : [ {
"name" : "archived",
"in" : "query",
"description" : "Specifies whether to return deleted Site Pages. Defaults to `false`.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchInputString"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponsePage"
},
"example" : null
}
}
},
"207" : {
"description" : "multiple statuses",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponsePageWithErrors"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.site_pages.read" ]
} ]
}
},
"/cms/v3/pages/site-pages/batch/update" : {
"post" : {
"tags" : [ "Batch" ],
"summary" : "Update website pages",
"description" : "Update a batch of website pages as specified in the request body.",
"operationId" : "post-/cms/v3/pages/site-pages/batch/update_updateBatch",
"parameters" : [ {
"name" : "archived",
"in" : "query",
"description" : "Specifies whether to update deleted Site Pages. Defaults to `false`.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchInputJsonNode"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponsePage"
},
"example" : null
}
}
},
"207" : {
"description" : "multiple statuses",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchResponsePageWithErrors"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/clone" : {
"post" : {
"tags" : [ "Website pages" ],
"summary" : "Clone a website page",
"description" : "Create a copy of an existing website page.",
"operationId" : "post-/cms/v3/pages/site-pages/clone_clone",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContentCloneRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/multi-language/attach-to-lang-group" : {
"post" : {
"tags" : [ "Multi-language" ],
"summary" : "Add a website page to a multi-language group",
"description" : "Attach a site page to a multi-language group.",
"operationId" : "post-/cms/v3/pages/site-pages/multi-language/attach-to-lang-group_attachToLangGroup",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AttachToLangPrimaryRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.site_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/multi-language/create-language-variation" : {
"post" : {
"tags" : [ "Multi-language" ],
"summary" : "Create a new language variation",
"description" : "Create a new language variation from an existing site page",
"operationId" : "post-/cms/v3/pages/site-pages/multi-language/create-language-variation_createLangVariation",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContentLanguageCloneRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.site_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/multi-language/detach-from-lang-group" : {
"post" : {
"tags" : [ "Multi-language" ],
"summary" : "Remove a website page from a multi-language group",
"description" : "Detach a website page from a multi-language group.",
"operationId" : "post-/cms/v3/pages/site-pages/multi-language/detach-from-lang-group_detachFromLangGroup",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DetachFromLangGroupRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.site_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/multi-language/set-new-lang-primary" : {
"put" : {
"tags" : [ "Multi-language" ],
"summary" : "Set a new primary language",
"description" : "Set a site page as the primary language of a multi-language group.",
"operationId" : "put-/cms/v3/pages/site-pages/multi-language/set-new-lang-primary_setLangPrimary",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SetNewLanguagePrimaryRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.site_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/multi-language/update-languages" : {
"post" : {
"tags" : [ "Multi-language" ],
"summary" : "Update languages of multi-language group",
"description" : "Explicitly set new languages for each site page in a multi-language group.",
"operationId" : "post-/cms/v3/pages/site-pages/multi-language/update-languages_updateLangs",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateLanguagesRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content.site_pages.write" ]
}, {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/schedule" : {
"post" : {
"tags" : [ "Website pages" ],
"summary" : "Schedule a website page to be published",
"description" : "Schedule a website page to published at a future time.",
"operationId" : "post-/cms/v3/pages/site-pages/schedule_schedule",
"parameters" : [ ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ContentScheduleRequestVNext"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/{objectId}" : {
"get" : {
"tags" : [ "Website pages" ],
"summary" : "Retrieve a website page",
"description" : "Retrieve a website page by its ID.",
"operationId" : "get-/cms/v3/pages/site-pages/{objectId}_getById",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The Site Page id.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Specifies whether to return deleted Site Pages. Defaults to `false`.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
}, {
"name" : "property",
"in" : "query",
"description" : "Specifies which properties of the site page to include in the response.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.site_pages.read" ]
} ]
},
"delete" : {
"tags" : [ "Website pages" ],
"summary" : "Delete a website page",
"description" : "Delete a website page, specified by its ID.",
"operationId" : "delete-/cms/v3/pages/site-pages/{objectId}_archive",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the website page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Whether to return only results that have been archived.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
} ],
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
},
"patch" : {
"tags" : [ "Website pages" ],
"summary" : "Update a website page",
"description" : "Partially updates a single website page, specified by its ID. You only need to specify the column values that you are modifying.\n",
"operationId" : "patch-/cms/v3/pages/site-pages/{objectId}_update",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the website page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "archived",
"in" : "query",
"description" : "Specifies whether to update deleted Site Pages. Defaults to `false`.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "boolean",
"example" : null
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/{objectId}/draft" : {
"get" : {
"tags" : [ "Website pages" ],
"summary" : "Retrieve a website page draft",
"description" : "Retrieve the full draft version of a website page, specified by its ID.",
"operationId" : "get-/cms/v3/pages/site-pages/{objectId}/draft_getDraftById",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the website page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.site_pages.read" ]
} ]
},
"patch" : {
"tags" : [ "Website pages" ],
"summary" : "Update a website page draft",
"description" : "Partially update the draft version of a website page, specified by page ID. You only need to specify the values for the details that you're modifying.",
"operationId" : "patch-/cms/v3/pages/site-pages/{objectId}/draft_updateDraft",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the website page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
},
"required" : true
},
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/{objectId}/draft/push-live" : {
"post" : {
"tags" : [ "Website pages" ],
"summary" : "Publish website page draft",
"description" : "Take any changes from the draft version of the website page and apply them to the live version.",
"operationId" : "post-/cms/v3/pages/site-pages/{objectId}/draft/push-live_pushLive",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the website page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/{objectId}/draft/reset" : {
"post" : {
"tags" : [ "Basic" ],
"summary" : "Reset the draft of a website page",
"description" : "Discards any edits and resets the draft to match the live version.",
"operationId" : "post-/cms/v3/pages/site-pages/{objectId}/draft/reset_resetDraft",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the website page to restore.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"204" : {
"description" : "No content",
"content" : { }
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/{objectId}/revisions" : {
"get" : {
"tags" : [ "Basic" ],
"summary" : "Retrieve all previous versions of a website page",
"description" : "Retrieves all the previous versions of a website page, specified by page ID.",
"operationId" : "get-/cms/v3/pages/site-pages/{objectId}/revisions_getPreviousVersions",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the website page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "after",
"in" : "query",
"description" : "The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "before",
"in" : "query",
"description" : "The cursor token value to retrieve the set of results before the current page.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "limit",
"in" : "query",
"description" : "The maximum number of results to return. Default is 100.",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CollectionResponseWithTotalPageVersion"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.site_pages.read" ]
} ]
}
},
"/cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}" : {
"get" : {
"tags" : [ "Basic" ],
"summary" : "Retrieve a previous version of a website page",
"description" : "Retrieve a previous version of a website page by the revision ID.",
"operationId" : "get-/cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}_getPreviousVersion",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the website page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "revisionId",
"in" : "path",
"description" : "The ID of the specific version to retrieve.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PageVersion"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
}, {
"oauth2" : [ "content.site_pages.read" ]
} ]
}
},
"/cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}/restore" : {
"post" : {
"tags" : [ "Advanced" ],
"summary" : "Restore a previous version of a website page",
"description" : "Restores a website page to a previous version, specified by page ID and version ID.",
"operationId" : "post-/cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}/restore_restorePreviousVersion",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the website page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "revisionId",
"in" : "path",
"description" : "The ID of the specified version to restore.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
},
"/cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}/restore-to-draft" : {
"post" : {
"tags" : [ "Basic" ],
"summary" : "Restore a previous draft of a website page",
"description" : "Takes a specified version of a website page and sets it as the new draft version of the page.",
"operationId" : "post-/cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}/restore-to-draft_restorePreviousVersionToDraft",
"parameters" : [ {
"name" : "objectId",
"in" : "path",
"description" : "The ID of the website page.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : null
}
}, {
"name" : "revisionId",
"in" : "path",
"description" : "The ID of the revision to restore.",
"required" : true,
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
} ],
"responses" : {
"200" : {
"description" : "successful operation",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Page"
},
"example" : null
}
}
},
"default" : {
"description" : "",
"$ref" : "#/components/responses/Error"
}
},
"security" : [ {
"oauth2" : [ "content" ]
} ]
}
}
},
"components" : {
"schemas" : {
"AbTestCreateRequestVNext" : {
"required" : [ "contentId", "variationName" ],
"type" : "object",
"properties" : {
"contentId" : {
"type" : "string",
"description" : "ID of the object to test.",
"example" : null
},
"variationName" : {
"type" : "string",
"description" : "Name of A/B test variation.",
"example" : null
}
},
"description" : "Request body object for creating A/B tests.",
"example" : null
},
"AbTestEndRequestVNext" : {
"required" : [ "abTestId", "winnerId" ],
"type" : "object",
"properties" : {
"abTestId" : {
"type" : "string",
"description" : "ID of the test to end.",
"example" : null
},
"winnerId" : {
"type" : "string",
"description" : "ID of the object to designate as the test winner.",
"example" : null
}
},
"description" : "Request body object for ending A/B tests.",
"example" : null
},
"AbTestRerunRequestVNext" : {
"required" : [ "abTestId", "variationId" ],
"type" : "object",
"properties" : {
"abTestId" : {
"type" : "string",
"description" : "ID of the test to rerun.",
"example" : null
},
"variationId" : {
"type" : "string",
"description" : "ID of the object to reactivate as a test variation.",
"example" : null
}
},
"description" : "Request body object for rerunning A/B tests.",
"example" : null
},
"Angle" : {
"required" : [ "units", "value" ],
"type" : "object",
"properties" : {
"units" : {
"type" : "string",
"description" : "The unit of measurement for the angle.",
"example" : null,
"enum" : [ "DEGREES", "GRADIANS", "RADIANS", "TURNS" ]
},
"value" : {
"type" : "number",
"description" : "The numerical representation of the angle.",
"example" : null
}
},
"example" : null
},
"AttachToLangPrimaryRequestVNext" : {
"required" : [ "id", "language", "primaryId" ],
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the object to add to a multi-language group.",
"example" : null
},
"language" : {
"type" : "string",
"description" : "Designated language of the object to add to a multi-language group.",
"example" : null,
"enum" : [ "aa", "ab", "ae", "af", "af-na", "af-za", "agq", "agq-cm", "ak", "ak-gh", "am", "am-et", "an", "ann", "ann-ng", "ar", "ar-001", "ar-ae", "ar-bh", "ar-dj", "ar-dz", "ar-eg", "ar-eh", "ar-er", "ar-il", "ar-iq", "ar-jo", "ar-km", "ar-kw", "ar-lb", "ar-ly", "ar-ma", "ar-mr", "ar-om", "ar-ps", "ar-qa", "ar-sa", "ar-sd", "ar-so", "ar-ss", "ar-sy", "ar-td", "ar-tn", "ar-ye", "as", "as-in", "asa", "asa-tz", "ast", "ast-es", "av", "ay", "az", "az-az", "ba", "bal", "bal-pk", "bas", "bas-cm", "be", "be-by", "bem", "bem-zm", "bez", "bez-tz", "bg", "bg-bg", "bgc", "bgc-in", "bho", "bho-in", "bi", "blo", "blo-bj", "bm", "bm-ml", "bn", "bn-bd", "bn-in", "bo", "bo-cn", "bo-in", "br", "br-fr", "brx", "brx-in", "bs", "bs-ba", "ca", "ca-ad", "ca-es", "ca-fr", "ca-it", "ccp", "ccp-bd", "ccp-in", "ce", "ce-ru", "ceb", "ceb-ph", "cgg", "cgg-ug", "ch", "chr", "chr-us", "ckb", "ckb-iq", "ckb-ir", "co", "cr", "cs", "cs-cz", "csw", "csw-ca", "cu", "cu-ru", "cv", "cv-ru", "cy", "cy-gb", "da", "da-dk", "da-gl", "dav", "dav-ke", "de", "de-at", "de-be", "de-ch", "de-de", "de-gr", "de-it", "de-li", "de-lu", "dje", "dje-ne", "doi", "doi-in", "dsb", "dsb-de", "dua", "dua-cm", "dv", "dyo", "dyo-sn", "dz", "dz-bt", "ebu", "ebu-ke", "ee", "ee-gh", "ee-tg", "el", "el-cy", "el-gr", "en", "en-001", "en-150", "en-ae", "en-ag", "en-ai", "en-as", "en-at", "en-au", "en-bb", "en-be", "en-bi", "en-bm", "en-bs", "en-bw", "en-bz", "en-ca", "en-cc", "en-ch", "en-ck", "en-cm", "en-cn", "en-cx", "en-cy", "en-cz", "en-de", "en-dg", "en-dk", "en-dm", "en-ee", "en-eg", "en-er", "en-es", "en-fi", "en-fj", "en-fk", "en-fm", "en-fr", "en-gb", "en-gd", "en-gg", "en-gh", "en-gi", "en-gm", "en-gs", "en-gu", "en-gy", "en-hk", "en-hu", "en-id", "en-ie", "en-il", "en-im", "en-in", "en-io", "en-it", "en-je", "en-jm", "en-ke", "en-ki", "en-kn", "en-ky", "en-lc", "en-lr", "en-ls", "en-lu", "en-mg", "en-mh", "en-mo", "en-mp", "en-ms", "en-mt", "en-mu", "en-mv", "en-mw", "en-mx", "en-my", "en-na", "en-nf", "en-ng", "en-nl", "en-no", "en-nr", "en-nu", "en-nz", "en-pg", "en-ph", "en-pk", "en-pl", "en-pn", "en-pr", "en-pt", "en-pw", "en-ro", "en-rw", "en-sb", "en-sc", "en-sd", "en-se", "en-sg", "en-sh", "en-si", "en-sk", "en-sl", "en-ss", "en-sx", "en-sz", "en-tc", "en-th", "en-tk", "en-tn", "en-to", "en-tt", "en-tv", "en-tz", "en-ug", "en-um", "en-us", "en-vc", "en-vg", "en-vi", "en-vn", "en-vu", "en-ws", "en-za", "en-zm", "en-zw", "eo", "eo-001", "es", "es-419", "es-ar", "es-bo", "es-br", "es-bz", "es-cl", "es-co", "es-cr", "es-cu", "es-do", "es-ea", "es-ec", "es-es", "es-gq", "es-gt", "es-hn", "es-ic", "es-mx", "es-ni", "es-pa", "es-pe", "es-ph", "es-pr", "es-py", "es-sv", "es-us", "es-uy", "es-ve", "et", "et-ee", "eu", "eu-es", "ewo", "ewo-cm", "fa", "fa-af", "fa-ir", "ff", "ff-bf", "ff-cm", "ff-gh", "ff-gm", "ff-gn", "ff-gw", "ff-lr", "ff-mr", "ff-ne", "ff-ng", "ff-sl", "ff-sn", "fi", "fi-fi", "fil", "fil-ph", "fj", "fo", "fo-dk", "fo-fo", "fr", "fr-be", "fr-bf", "fr-bi", "fr-bj", "fr-bl", "fr-ca", "fr-cd", "fr-cf", "fr-cg", "fr-ch", "fr-ci", "fr-cm", "fr-dj", "fr-dz", "fr-fr", "fr-ga", "fr-gf", "fr-gn", "fr-gp", "fr-gq", "fr-ht", "fr-km", "fr-lu", "fr-ma", "fr-mc", "fr-mf", "fr-mg", "fr-ml", "fr-mq", "fr-mr", "fr-mu", "fr-nc", "fr-ne", "fr-pf", "fr-pm", "fr-re", "fr-rw", "fr-sc", "fr-sn", "fr-sy", "fr-td", "fr-tg", "fr-tn", "fr-vu", "fr-wf", "fr-yt", "frr", "frr-de", "fur", "fur-it", "fy", "fy-nl", "ga", "ga-gb", "ga-ie", "gaa", "gaa-gh", "gd", "gd-gb", "gl", "gl-es", "gn", "gsw", "gsw-ch", "gsw-fr", "gsw-li", "gu", "gu-in", "guz", "guz-ke", "gv", "gv-im", "ha", "ha-gh", "ha-ne", "ha-ng", "haw", "haw-us", "he", "he-il", "he-il", "hi", "hi-in", "hmn", "ho", "hr", "hr-ba", "hr-hr", "hsb", "hsb-de", "ht", "ht-ht", "hu", "hu-hu", "hy", "hy-am", "hz", "ia", "ia-001", "id", "id-id", "ie", "ie-ee", "ig", "ig-ng", "ii", "ii-cn", "ik", "io", "is", "is-is", "it", "it-ch", "it-it", "it-sm", "it-va", "iu", "ja", "ja-jp", "jgo", "jgo-cm", "jmc", "jmc-tz", "jv", "jv-id", "ka", "ka-ge", "kab", "kab-dz", "kam", "kam-ke", "kar", "kde", "kde-tz", "kea", "kea-cv", "kg", "kgp", "kgp-br", "kh", "khq", "khq-ml", "ki", "ki-ke", "kj", "kk", "kk-kz", "kkj", "kkj-cm", "kl", "kl-gl", "kln", "kln-ke", "km", "km-kh", "kn", "kn-in", "ko", "ko-cn", "ko-kp", "ko-kr", "kok", "kok-in", "kr", "ks", "ks-in", "ksb", "ksb-tz", "ksf", "ksf-cm", "ksh", "ksh-de", "ku", "ku-tr", "kv", "kw", "kw-gb", "kxv", "kxv-in", "ky", "ky-kg", "la", "lag", "lag-tz", "lb", "lb-lu", "lg", "lg-ug", "li", "lij", "lij-it", "lkt", "lkt-us", "lmo", "lmo-it", "ln", "ln-ao", "ln-cd", "ln-cf", "ln-cg", "lo", "lo-la", "lrc", "lrc-iq", "lrc-ir", "lt", "lt-lt", "lu", "lu-cd", "luo", "luo-ke", "luy", "luy-ke", "lv", "lv-lv", "mai", "mai-in", "mas", "mas-ke", "mas-tz", "mdf", "mdf-ru", "mer", "mer-ke", "mfe", "mfe-mu", "mg", "mg-mg", "mgh", "mgh-mz", "mgo", "mgo-cm", "mh", "mi", "mi-nz", "mk", "mk-mk", "ml", "ml-in", "mn", "mn-mn", "mni", "mni-in", "mr", "mr-in", "ms", "ms-bn", "ms-id", "ms-my", "ms-sg", "mt", "mt-mt", "mua", "mua-cm", "my", "my-mm", "mzn", "mzn-ir", "na", "naq", "naq-na", "nb", "nb-no", "nb-sj", "nd", "nd-zw", "nds", "nds-de", "nds-nl", "ne", "ne-in", "ne-np", "ng", "nl", "nl-aw", "nl-be", "nl-bq", "nl-ch", "nl-cw", "nl-lu", "nl-nl", "nl-sr", "nl-sx", "nmg", "nmg-cm", "nn", "nn-no", "nnh", "nnh-cm", "no", "no-no", "nqo", "nqo-gn", "nr", "nso", "nso-za", "nus", "nus-ss", "nv", "ny", "nyn", "nyn-ug", "oc", "oc-es", "oc-fr", "oj", "om", "om-et", "om-ke", "or", "or-in", "os", "os-ge", "os-ru", "pa", "pa-in", "pa-pk", "pcm", "pcm-ng", "pi", "pis", "pis-sb", "pl", "pl-pl", "prg", "prg-001", "ps", "ps-af", "ps-pk", "pt", "pt-ao", "pt-br", "pt-ch", "pt-cv", "pt-gq", "pt-gw", "pt-lu", "pt-mo", "pt-mz", "pt-pt", "pt-st", "pt-tl", "qu", "qu-bo", "qu-ec", "qu-pe", "raj", "raj-in", "rm", "rm-ch", "rn", "rn-bi", "ro", "ro-md", "ro-ro", "rof", "rof-tz", "ru", "ru-by", "ru-kg", "ru-kz", "ru-md", "ru-ru", "ru-ua", "rw", "rw-rw", "rwk", "rwk-tz", "sa", "sa-in", "sah", "sah-ru", "saq", "saq-ke", "sat", "sat-in", "sbp", "sbp-tz", "sc", "sc-it", "sd", "sd-in", "sd-pk", "se", "se-fi", "se-no", "se-se", "seh", "seh-mz", "ses", "ses-ml", "sg", "sg-cf", "shi", "shi-ma", "si", "si-lk", "sk", "sk-sk", "sl", "sl-si", "sm", "smn", "smn-fi", "sms", "sms-fi", "sn", "sn-zw", "so", "so-dj", "so-et", "so-ke", "so-so", "sq", "sq-al", "sq-mk", "sq-xk", "sr", "sr-ba", "sr-cs", "sr-me", "sr-rs", "sr-xk", "ss", "st", "st-ls", "st-za", "su", "su-id", "sv", "sv-ax", "sv-fi", "sv-se", "sw", "sw-cd", "sw-ke", "sw-tz", "sw-ug", "sy", "syr", "syr-iq", "syr-sy", "szl", "szl-pl", "ta", "ta-in", "ta-lk", "ta-my", "ta-sg", "te", "te-in", "teo", "teo-ke", "teo-ug", "tg", "tg-tj", "th", "th-th", "ti", "ti-er", "ti-et", "tk", "tk-tm", "tl", "tn", "tn-bw", "tn-za", "to", "to-to", "tok", "tok-001", "tr", "tr-cy", "tr-tr", "ts", "tt", "tt-ru", "tw", "twq", "twq-ne", "ty", "tzm", "tzm-ma", "ug", "ug-cn", "uk", "uk-ua", "ur", "ur-in", "ur-pk", "uz", "uz-af", "uz-uz", "vai", "vai-lr", "ve", "vec", "vec-it", "vi", "vi-vn", "vmw", "vmw-mz", "vo", "vo-001", "vun", "vun-tz", "wa", "wae", "wae-ch", "wo", "wo-sn", "xh", "xh-za", "xnr", "xnr-in", "xog", "xog-ug", "yav", "yav-cm", "yi", "yi", "yi-001", "yi-ua", "yo", "yo-bj", "yo-ng", "yrl", "yrl-br", "yrl-co", "yrl-ve", "yue", "yue-cn", "yue-hk", "yue-mo", "za", "za-cn", "zgh", "zgh-ma", "zh", "zh-cn", "zh-hans", "zh-hant", "zh-hk", "zh-mo", "zh-my", "zh-sg", "zh-tw", "zu", "zu-za" ]
},
"primaryId" : {
"type" : "string",
"description" : "ID of primary language object in multi-language group.",
"example" : null
},
"primaryLanguage" : {
"type" : "string",
"description" : "Primary language of the multi-language group.",
"example" : null,
"enum" : [ "aa", "ab", "ae", "af", "af-na", "af-za", "agq", "agq-cm", "ak", "ak-gh", "am", "am-et", "an", "ann", "ann-ng", "ar", "ar-001", "ar-ae", "ar-bh", "ar-dj", "ar-dz", "ar-eg", "ar-eh", "ar-er", "ar-il", "ar-iq", "ar-jo", "ar-km", "ar-kw", "ar-lb", "ar-ly", "ar-ma", "ar-mr", "ar-om", "ar-ps", "ar-qa", "ar-sa", "ar-sd", "ar-so", "ar-ss", "ar-sy", "ar-td", "ar-tn", "ar-ye", "as", "as-in", "asa", "asa-tz", "ast", "ast-es", "av", "ay", "az", "az-az", "ba", "bal", "bal-pk", "bas", "bas-cm", "be", "be-by", "bem", "bem-zm", "bez", "bez-tz", "bg", "bg-bg", "bgc", "bgc-in", "bho", "bho-in", "bi", "blo", "blo-bj", "bm", "bm-ml", "bn", "bn-bd", "bn-in", "bo", "bo-cn", "bo-in", "br", "br-fr", "brx", "brx-in", "bs", "bs-ba", "ca", "ca-ad", "ca-es", "ca-fr", "ca-it", "ccp", "ccp-bd", "ccp-in", "ce", "ce-ru", "ceb", "ceb-ph", "cgg", "cgg-ug", "ch", "chr", "chr-us", "ckb", "ckb-iq", "ckb-ir", "co", "cr", "cs", "cs-cz", "csw", "csw-ca", "cu", "cu-ru", "cv", "cv-ru", "cy", "cy-gb", "da", "da-dk", "da-gl", "dav", "dav-ke", "de", "de-at", "de-be", "de-ch", "de-de", "de-gr", "de-it", "de-li", "de-lu", "dje", "dje-ne", "doi", "doi-in", "dsb", "dsb-de", "dua", "dua-cm", "dv", "dyo", "dyo-sn", "dz", "dz-bt", "ebu", "ebu-ke", "ee", "ee-gh", "ee-tg", "el", "el-cy", "el-gr", "en", "en-001", "en-150", "en-ae", "en-ag", "en-ai", "en-as", "en-at", "en-au", "en-bb", "en-be", "en-bi", "en-bm", "en-bs", "en-bw", "en-bz", "en-ca", "en-cc", "en-ch", "en-ck", "en-cm", "en-cn", "en-cx", "en-cy", "en-cz", "en-de", "en-dg", "en-dk", "en-dm", "en-ee", "en-eg", "en-er", "en-es", "en-fi", "en-fj", "en-fk", "en-fm", "en-fr", "en-gb", "en-gd", "en-gg", "en-gh", "en-gi", "en-gm", "en-gs", "en-gu", "en-gy", "en-hk", "en-hu", "en-id", "en-ie", "en-il", "en-im", "en-in", "en-io", "en-it", "en-je", "en-jm", "en-ke", "en-ki", "en-kn", "en-ky", "en-lc", "en-lr", "en-ls", "en-lu", "en-mg", "en-mh", "en-mo", "en-mp", "en-ms", "en-mt", "en-mu", "en-mv", "en-mw", "en-mx", "en-my", "en-na", "en-nf", "en-ng", "en-nl", "en-no", "en-nr", "en-nu", "en-nz", "en-pg", "en-ph", "en-pk", "en-pl", "en-pn", "en-pr", "en-pt", "en-pw", "en-ro", "en-rw", "en-sb", "en-sc", "en-sd", "en-se", "en-sg", "en-sh", "en-si", "en-sk", "en-sl", "en-ss", "en-sx", "en-sz", "en-tc", "en-th", "en-tk", "en-tn", "en-to", "en-tt", "en-tv", "en-tz", "en-ug", "en-um", "en-us", "en-vc", "en-vg", "en-vi", "en-vn", "en-vu", "en-ws", "en-za", "en-zm", "en-zw", "eo", "eo-001", "es", "es-419", "es-ar", "es-bo", "es-br", "es-bz", "es-cl", "es-co", "es-cr", "es-cu", "es-do", "es-ea", "es-ec", "es-es", "es-gq", "es-gt", "es-hn", "es-ic", "es-mx", "es-ni", "es-pa", "es-pe", "es-ph", "es-pr", "es-py", "es-sv", "es-us", "es-uy", "es-ve", "et", "et-ee", "eu", "eu-es", "ewo", "ewo-cm", "fa", "fa-af", "fa-ir", "ff", "ff-bf", "ff-cm", "ff-gh", "ff-gm", "ff-gn", "ff-gw", "ff-lr", "ff-mr", "ff-ne", "ff-ng", "ff-sl", "ff-sn", "fi", "fi-fi", "fil", "fil-ph", "fj", "fo", "fo-dk", "fo-fo", "fr", "fr-be", "fr-bf", "fr-bi", "fr-bj", "fr-bl", "fr-ca", "fr-cd", "fr-cf", "fr-cg", "fr-ch", "fr-ci", "fr-cm", "fr-dj", "fr-dz", "fr-fr", "fr-ga", "fr-gf", "fr-gn", "fr-gp", "fr-gq", "fr-ht", "fr-km", "fr-lu", "fr-ma", "fr-mc", "fr-mf", "fr-mg", "fr-ml", "fr-mq", "fr-mr", "fr-mu", "fr-nc", "fr-ne", "fr-pf", "fr-pm", "fr-re", "fr-rw", "fr-sc", "fr-sn", "fr-sy", "fr-td", "fr-tg", "fr-tn", "fr-vu", "fr-wf", "fr-yt", "frr", "frr-de", "fur", "fur-it", "fy", "fy-nl", "ga", "ga-gb", "ga-ie", "gaa", "gaa-gh", "gd", "gd-gb", "gl", "gl-es", "gn", "gsw", "gsw-ch", "gsw-fr", "gsw-li", "gu", "gu-in", "guz", "guz-ke", "gv", "gv-im", "ha", "ha-gh", "ha-ne", "ha-ng", "haw", "haw-us", "he", "he-il", "hi", "hi-in", "hmn", "ho", "hr", "hr-ba", "hr-hr", "hsb", "hsb-de", "ht", "ht-ht", "hu", "hu-hu", "hy", "hy-am", "hz", "ia", "ia-001", "id", "id-id", "ie", "ie-ee", "ig", "ig-ng", "ii", "ii-cn", "ik", "io", "is", "is-is", "it", "it-ch", "it-it", "it-sm", "it-va", "iu", "ja", "ja-jp", "jgo", "jgo-cm", "jmc", "jmc-tz", "jv", "jv-id", "ka", "ka-ge", "kab", "kab-dz", "kam", "kam-ke", "kar", "kde", "kde-tz", "kea", "kea-cv", "kg", "kgp", "kgp-br", "kh", "khq", "khq-ml", "ki", "ki-ke", "kj", "kk", "kk-kz", "kkj", "kkj-cm", "kl", "kl-gl", "kln", "kln-ke", "km", "km-kh", "kn", "kn-in", "ko", "ko-cn", "ko-kp", "ko-kr", "kok", "kok-in", "kr", "ks", "ks-in", "ksb", "ksb-tz", "ksf", "ksf-cm", "ksh", "ksh-de", "ku", "ku-tr", "kv", "kw", "kw-gb", "kxv", "kxv-in", "ky", "ky-kg", "la", "lag", "lag-tz", "lb", "lb-lu", "lg", "lg-ug", "li", "lij", "lij-it", "lkt", "lkt-us", "lmo", "lmo-it", "ln", "ln-ao", "ln-cd", "ln-cf", "ln-cg", "lo", "lo-la", "lrc", "lrc-iq", "lrc-ir", "lt", "lt-lt", "lu", "lu-cd", "luo", "luo-ke", "luy", "luy-ke", "lv", "lv-lv", "mai", "mai-in", "mas", "mas-ke", "mas-tz", "mdf", "mdf-ru", "mer", "mer-ke", "mfe", "mfe-mu", "mg", "mg-mg", "mgh", "mgh-mz", "mgo", "mgo-cm", "mh", "mi", "mi-nz", "mk", "mk-mk", "ml", "ml-in", "mn", "mn-mn", "mni", "mni-in", "mr", "mr-in", "ms", "ms-bn", "ms-id", "ms-my", "ms-sg", "mt", "mt-mt", "mua", "mua-cm", "my", "my-mm", "mzn", "mzn-ir", "na", "naq", "naq-na", "nb", "nb-no", "nb-sj", "nd", "nd-zw", "nds", "nds-de", "nds-nl", "ne", "ne-in", "ne-np", "ng", "nl", "nl-aw", "nl-be", "nl-bq", "nl-ch", "nl-cw", "nl-lu", "nl-nl", "nl-sr", "nl-sx", "nmg", "nmg-cm", "nn", "nn-no", "nnh", "nnh-cm", "no", "no-no", "nqo", "nqo-gn", "nr", "nso", "nso-za", "nus", "nus-ss", "nv", "ny", "nyn", "nyn-ug", "oc", "oc-es", "oc-fr", "oj", "om", "om-et", "om-ke", "or", "or-in", "os", "os-ge", "os-ru", "pa", "pa-in", "pa-pk", "pcm", "pcm-ng", "pi", "pis", "pis-sb", "pl", "pl-pl", "prg", "prg-001", "ps", "ps-af", "ps-pk", "pt", "pt-ao", "pt-br", "pt-ch", "pt-cv", "pt-gq", "pt-gw", "pt-lu", "pt-mo", "pt-mz", "pt-pt", "pt-st", "pt-tl", "qu", "qu-bo", "qu-ec", "qu-pe", "raj", "raj-in", "rm", "rm-ch", "rn", "rn-bi", "ro", "ro-md", "ro-ro", "rof", "rof-tz", "ru", "ru-by", "ru-kg", "ru-kz", "ru-md", "ru-ru", "ru-ua", "rw", "rw-rw", "rwk", "rwk-tz", "sa", "sa-in", "sah", "sah-ru", "saq", "saq-ke", "sat", "sat-in", "sbp", "sbp-tz", "sc", "sc-it", "sd", "sd-in", "sd-pk", "se", "se-fi", "se-no", "se-se", "seh", "seh-mz", "ses", "ses-ml", "sg", "sg-cf", "shi", "shi-ma", "si", "si-lk", "sk", "sk-sk", "sl", "sl-si", "sm", "smn", "smn-fi", "sms", "sms-fi", "sn", "sn-zw", "so", "so-dj", "so-et", "so-ke", "so-so", "sq", "sq-al", "sq-mk", "sq-xk", "sr", "sr-ba", "sr-cs", "sr-me", "sr-rs", "sr-xk", "ss", "st", "st-ls", "st-za", "su", "su-id", "sv", "sv-ax", "sv-fi", "sv-se", "sw", "sw-cd", "sw-ke", "sw-tz", "sw-ug", "sy", "syr", "syr-iq", "syr-sy", "szl", "szl-pl", "ta", "ta-in", "ta-lk", "ta-my", "ta-sg", "te", "te-in", "teo", "teo-ke", "teo-ug", "tg", "tg-tj", "th", "th-th", "ti", "ti-er", "ti-et", "tk", "tk-tm", "tl", "tn", "tn-bw", "tn-za", "to", "to-to", "tok", "tok-001", "tr", "tr-cy", "tr-tr", "ts", "tt", "tt-ru", "tw", "twq", "twq-ne", "ty", "tzm", "tzm-ma", "ug", "ug-cn", "uk", "uk-ua", "ur", "ur-in", "ur-pk", "uz", "uz-af", "uz-uz", "vai", "vai-lr", "ve", "vec", "vec-it", "vi", "vi-vn", "vmw", "vmw-mz", "vo", "vo-001", "vun", "vun-tz", "wa", "wae", "wae-ch", "wo", "wo-sn", "xh", "xh-za", "xnr", "xnr-in", "xog", "xog-ug", "yav", "yav-cm", "yi", "yi-001", "yi-ua", "yo", "yo-bj", "yo-ng", "yrl", "yrl-br", "yrl-co", "yrl-ve", "yue", "yue-cn", "yue-hk", "yue-mo", "za", "za-cn", "zgh", "zgh-ma", "zh", "zh-cn", "zh-hans", "zh-hant", "zh-hk", "zh-mo", "zh-my", "zh-sg", "zh-tw", "zu", "zu-za" ]
}
},
"description" : "Request body object fro attaching objects to multi-language groups.",
"example" : null
},
"BackgroundImage" : {
"required" : [ "backgroundPosition", "backgroundSize", "imageUrl" ],
"type" : "object",
"properties" : {
"backgroundPosition" : {
"type" : "string",
"description" : "Defines the position of the background image.",
"example" : null
},
"backgroundSize" : {
"type" : "string",
"description" : "Specifies the size of the background image.",
"example" : null
},
"imageUrl" : {
"type" : "string",
"description" : "The URL of the background image.",
"example" : null
}
},
"example" : null
},
"BatchInputContentFolder" : {
"required" : [ "inputs" ],
"type" : "object",
"properties" : {
"inputs" : {
"type" : "array",
"description" : "Content folders to input.",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ContentFolder"
}
}
},
"description" : "Wrapper for providing an array of content folders as inputs.",
"example" : null
},
"BatchInputJsonNode" : {
"required" : [ "inputs" ],
"type" : "object",
"properties" : {
"inputs" : {
"type" : "array",
"description" : "JSON nodes to input.",
"example" : null,
"items" : {
"type" : "object",
"properties" : { },
"example" : null
}
}
},
"description" : "Wrapper for providing an array of JSON nodes as inputs.",
"example" : null
},
"BatchInputPage" : {
"required" : [ "inputs" ],
"type" : "object",
"properties" : {
"inputs" : {
"type" : "array",
"description" : "Pages to input.",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/Page"
}
}
},
"description" : "Wrapper for providing an array of pages as inputs.",
"example" : null
},
"BatchInputString" : {
"required" : [ "inputs" ],
"type" : "object",
"properties" : {
"inputs" : {
"type" : "array",
"description" : "Strings to input.",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
}
},
"description" : "Wrapper for providing an array of strings as inputs.",
"example" : null
},
"BatchResponseContentFolder" : {
"required" : [ "completedAt", "results", "startedAt", "status" ],
"type" : "object",
"properties" : {
"completedAt" : {
"type" : "string",
"description" : "Time of batch operation completion.",
"format" : "date-time",
"example" : null
},
"links" : {
"type" : "object",
"additionalProperties" : {
"type" : "string",
"example" : null
},
"description" : "Links associated with batch operation.",
"example" : null
},
"requestedAt" : {
"type" : "string",
"description" : "Time of batch operation request.",
"format" : "date-time",
"example" : null
},
"results" : {
"type" : "array",
"description" : "Results of batch operation.",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ContentFolder"
}
},
"startedAt" : {
"type" : "string",
"description" : "Time of batch operation start.",
"format" : "date-time",
"example" : null
},
"status" : {
"type" : "string",
"description" : "Status of batch operation.",
"example" : null,
"enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ]
}
},
"description" : "Response object for successful batch operations on content folders.",
"example" : null
},
"BatchResponseContentFolderWithErrors" : {
"required" : [ "completedAt", "results", "startedAt", "status" ],
"type" : "object",
"properties" : {
"completedAt" : {
"type" : "string",
"description" : "Time of batch operation completion.",
"format" : "date-time",
"example" : null
},
"errors" : {
"type" : "array",
"description" : "Errors in batch operation.",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/StandardError"
}
},
"links" : {
"type" : "object",
"additionalProperties" : {
"type" : "string",
"example" : null
},
"description" : "Links associated with batch operation.",
"example" : null
},
"numErrors" : {
"type" : "integer",
"description" : "Number of errors.",
"format" : "int32",
"example" : null
},
"requestedAt" : {
"type" : "string",
"description" : "Time of batch operation request.",
"format" : "date-time",
"example" : null
},
"results" : {
"type" : "array",
"description" : "Results of batch operation.",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ContentFolder"
}
},
"startedAt" : {
"type" : "string",
"description" : "Time of batch operation start.",
"format" : "date-time",
"example" : null
},
"status" : {
"type" : "string",
"description" : "Status of batch operation.",
"example" : null,
"enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ]
}
},
"description" : "Response object for batch operations on content folders with errors.",
"example" : null
},
"BatchResponsePage" : {
"required" : [ "completedAt", "results", "startedAt", "status" ],
"type" : "object",
"properties" : {
"completedAt" : {
"type" : "string",
"description" : "Time of batch operation completion.",
"format" : "date-time",
"example" : null
},
"links" : {
"type" : "object",
"additionalProperties" : {
"type" : "string",
"example" : null
},
"description" : "Links associated with batch operation.",
"example" : null
},
"requestedAt" : {
"type" : "string",
"description" : "Time of batch operation request.",
"format" : "date-time",
"example" : null
},
"results" : {
"type" : "array",
"description" : "Results of batch operation.",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/Page"
}
},
"startedAt" : {
"type" : "string",
"description" : "Time of batch operation start.",
"format" : "date-time",
"example" : null
},
"status" : {
"type" : "string",
"description" : "Status of batch operation.",
"example" : null,
"enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ]
}
},
"description" : "Response object for successful batch operations on pages.",
"example" : null
},
"BatchResponsePageWithErrors" : {
"required" : [ "completedAt", "results", "startedAt", "status" ],
"type" : "object",
"properties" : {
"completedAt" : {
"type" : "string",
"description" : "Time of batch operation completion.",
"format" : "date-time",
"example" : null
},
"errors" : {
"type" : "array",
"description" : "Errors in batch operation.",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/StandardError"
}
},
"links" : {
"type" : "object",
"additionalProperties" : {
"type" : "string",
"example" : null
},
"description" : "Links associated with batch operation.",
"example" : null
},
"numErrors" : {
"type" : "integer",
"description" : "Number of errors.",
"format" : "int32",
"example" : null
},
"requestedAt" : {
"type" : "string",
"description" : "Time of batch operation request.",
"format" : "date-time",
"example" : null
},
"results" : {
"type" : "array",
"description" : "Results of batch operation.",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/Page"
}
},
"startedAt" : {
"type" : "string",
"description" : "Time of batch operation start.",
"format" : "date-time",
"example" : null
},
"status" : {
"type" : "string",
"description" : "Status of batch operation.",
"example" : null,
"enum" : [ "CANCELED", "COMPLETE", "PENDING", "PROCESSING" ]
}
},
"description" : "Response object for batch operations on pages with errors.",
"example" : null
},
"BreakpointStyles" : {
"required" : [ "hidden", "margin", "padding" ],
"type" : "object",
"properties" : {
"hidden" : {
"type" : "boolean",
"example" : null
},
"margin" : {
"$ref" : "#/components/schemas/Margin"
},
"padding" : {
"$ref" : "#/components/schemas/Padding"
}
},
"example" : null
},
"CollectionResponseWithTotalContentFolderForwardPaging" : {
"required" : [ "results", "total" ],
"type" : "object",
"properties" : {
"paging" : {
"$ref" : "#/components/schemas/ForwardPaging"
},
"results" : {
"type" : "array",
"description" : "Collection of content folders.",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ContentFolder"
}
},
"total" : {
"type" : "integer",
"description" : "Total number of content folders.",
"format" : "int32",
"example" : null
}
},
"description" : "Response object for collections of content folders with pagination information.",
"example" : null
},
"CollectionResponseWithTotalContentFolderVersion" : {
"required" : [ "results", "total" ],
"type" : "object",
"properties" : {
"paging" : {
"$ref" : "#/components/schemas/Paging"
},
"results" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ContentFolderVersion"
}
},
"total" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
},
"example" : null
},
"CollectionResponseWithTotalPageForwardPaging" : {
"required" : [ "results", "total" ],
"type" : "object",
"properties" : {
"paging" : {
"$ref" : "#/components/schemas/ForwardPaging"
},
"results" : {
"type" : "array",
"description" : "Collection of pages.",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/Page"
}
},
"total" : {
"type" : "integer",
"description" : "Total number of pages.",
"format" : "int32",
"example" : null
}
},
"description" : "Response object for collections of pages with pagination information.",
"example" : null
},
"CollectionResponseWithTotalPageVersion" : {
"required" : [ "results", "total" ],
"type" : "object",
"properties" : {
"paging" : {
"$ref" : "#/components/schemas/Paging"
},
"results" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/PageVersion"
}
},
"total" : {
"type" : "integer",
"format" : "int32",
"example" : null
}
},
"example" : null
},
"ColorStop" : {
"required" : [ "color" ],
"type" : "object",
"properties" : {
"color" : {
"$ref" : "#/components/schemas/RGBAColor"
}
},
"example" : null
},
"ContentCloneRequestVNext" : {
"required" : [ "id" ],
"type" : "object",
"properties" : {
"cloneName" : {
"type" : "string",
"description" : "Name of the cloned object.",
"example" : null
},
"id" : {
"type" : "string",
"description" : "ID of the object to be cloned.",
"example" : null
}
},
"description" : "Request body object for cloning content.",
"example" : null
},
"ContentFolder" : {
"required" : [ "category", "created", "deletedAt", "id", "name", "parentFolderId", "updated" ],
"type" : "object",
"properties" : {
"category" : {
"type" : "integer",
"description" : "The type of object this folder applies to. Should always be LANDING_PAGE.",
"format" : "int32",
"example" : null
},
"created" : {
"type" : "string",
"description" : "The timestamp indicating when the content folder was created.",
"format" : "date-time",
"example" : null
},
"deletedAt" : {
"type" : "string",
"description" : "The timestamp (ISO8601 format) when this content folder was deleted.",
"format" : "date-time",
"example" : null
},
"id" : {
"type" : "string",
"description" : "The unique ID of the content folder.",
"example" : null
},
"name" : {
"type" : "string",
"description" : "The name of the folder which will show up in the app dashboard",
"example" : null
},
"parentFolderId" : {
"type" : "integer",
"description" : "The ID of the content folder this folder is nested under",
"format" : "int64",
"example" : null
},
"updated" : {
"type" : "string",
"description" : "The timestamp indicating when the content folder was last updated.",
"format" : "date-time",
"example" : null
}
},
"description" : "Model definition for a content folder.",
"example" : null
},
"ContentFolderVersion" : {
"required" : [ "id", "object", "updatedAt", "user" ],
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"example" : null
},
"object" : {
"$ref" : "#/components/schemas/ContentFolder"
},
"updatedAt" : {
"type" : "string",
"format" : "date-time",
"example" : null
},
"user" : {
"$ref" : "#/components/schemas/VersionUser"
}
},
"example" : null
},
"ContentLanguageCloneRequestVNext" : {
"required" : [ "id" ],
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of content to clone.",
"example" : null
},
"language" : {
"type" : "string",
"description" : "Target language of new variant.",
"example" : null
},
"primaryLanguage" : {
"type" : "string",
"description" : "Language of primary content to clone.",
"example" : null
},
"usePublished" : {
"type" : "boolean",
"description" : "If true, clone from the published version of the content. Defaults to false (clones from the current draft).",
"example" : null
}
},
"description" : "Request body object for creating new language variant content.",
"example" : null
},
"ContentLanguageVariation" : {
"required" : [ "archivedInDashboard", "authorName", "campaign", "campaignName", "created", "id", "name", "password", "publicAccessRules", "publicAccessRulesEnabled", "publishDate", "slug", "state", "updated" ],
"type" : "object",
"properties" : {
"archivedInDashboard" : {
"type" : "boolean",
"description" : "Indicates if the page is hidden from the dashboard, though it may still be live.",
"example" : null
},
"authorName" : {
"type" : "string",
"description" : "The name of the user that updated this page.",
"example" : null
},
"campaign" : {
"type" : "string",
"description" : "The GUID of the marketing campaign this page is a part of.",
"example" : null
},
"campaignName" : {
"type" : "string",
"example" : null
},
"created" : {
"type" : "string",
"description" : "The date and time when the content language variation was created.",
"format" : "date-time",
"example" : null
},
"id" : {
"type" : "integer",
"description" : "ID of object to set as primary in multi-language group.",
"format" : "int64",
"example" : null
},
"name" : {
"type" : "string",
"description" : "The internal name of the page.",
"example" : null
},
"password" : {
"type" : "string",
"description" : "A password required to view the page, if set.",
"example" : null
},
"publicAccessRules" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/PublicAccessRule"
}
},
"publicAccessRulesEnabled" : {
"type" : "boolean",
"description" : "Determines if public access rules should be respected.",
"example" : null
},
"publishDate" : {
"type" : "string",
"description" : "The date and time when the page is scheduled to be published.",
"format" : "date-time",
"example" : null
},
"slug" : {
"type" : "string",
"description" : "The path of this page, appended to the domain to construct the URL.",
"example" : null
},
"state" : {
"type" : "string",
"description" : "An ENUM descibing the current state of this page.",
"example" : null
},
"tagIds" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "integer",
"format" : "int64",
"example" : null
}
},
"updated" : {
"type" : "string",
"description" : "The date and time when the content language variation was last updated.",
"format" : "date-time",
"example" : null
}
},
"example" : null
},
"ContentScheduleRequestVNext" : {
"required" : [ "id", "publishDate" ],
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "The ID of the object to be scheduled.",
"example" : null
},
"publishDate" : {
"type" : "string",
"description" : "The date the object should transition from scheduled to published.",
"format" : "date-time",
"example" : null
}
},
"description" : "Request body object for scheduling the publish of content",
"example" : null
},
"CursorPagedResultContentFolderLong" : {
"type" : "object",
"properties" : { },
"example" : null
},
"CursorPagedResultPageLong" : {
"type" : "object",
"properties" : { },
"example" : null
},
"DetachFromLangGroupRequestVNext" : {
"required" : [ "id" ],
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the object to remove from a multi-language group.",
"example" : null
}
},
"description" : "Request body object for detaching objects from multi-language groups.",
"example" : null
},
"Error" : {
"required" : [ "category", "correlationId", "message" ],
"type" : "object",
"properties" : {
"category" : {
"type" : "string",
"description" : "The error category",
"example" : null
},
"context" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
},
"description" : "Context about the error condition",
"example" : "{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}"
},
"correlationId" : {
"type" : "string",
"description" : "A unique identifier for the request. Include this value with any error reports or support tickets",
"format" : "uuid",
"example" : "aeb5f871-7f07-4993-9211-075dc63e7cbf"
},
"errors" : {
"type" : "array",
"description" : "further information about the error",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ErrorDetail"
}
},
"links" : {
"type" : "object",
"additionalProperties" : {
"type" : "string",
"example" : null
},
"description" : "A map of link names to associated URIs containing documentation about the error or recommended remediation steps",
"example" : null
},
"message" : {
"type" : "string",
"description" : "A human readable message describing the error along with remediation steps where appropriate",
"example" : "An error occurred"
},
"subCategory" : {
"type" : "string",
"description" : "A specific category that contains more specific detail about the error",
"example" : null
}
},
"example" : {
"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"
}
}
},
"ErrorDetail" : {
"required" : [ "message" ],
"type" : "object",
"properties" : {
"code" : {
"type" : "string",
"description" : "The status code associated with the error detail",
"example" : null
},
"context" : {
"type" : "object",
"additionalProperties" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "string",
"example" : null
}
},
"description" : "Context about the error condition",
"example" : "{missingScopes=[scope1, scope2]}"
},
"in" : {
"type" : "string",
"description" : "The name of the field or parameter in which the error was found.",
"example" : null
},
"message" : {
"type" : "string",
"description" : "A human readable message describing the error along with remediation steps where appropriate",
"example" : null
},
"subCategory" : {
"type" : "string",
"description" : "A specific category that contains more specific detail about the error",
"example" : null
}
},
"example" : null
},
"ForwardPaging" : {
"type" : "object",
"properties" : {
"next" : {
"$ref" : "#/components/schemas/NextPage"
}
},
"description" : "Model definition for forward paging.",
"example" : null
},
"Gradient" : {
"required" : [ "angle", "colors", "sideOrCorner" ],
"type" : "object",
"properties" : {
"angle" : {
"$ref" : "#/components/schemas/Angle"
},
"colors" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/ColorStop"
}
},
"sideOrCorner" : {
"$ref" : "#/components/schemas/SideOrCorner"
}
},
"example" : null
},
"LayoutSection" : {
"required" : [ "cells", "cssClass", "cssId", "cssStyle", "label", "name", "params", "rowMetaData", "rows", "styles", "type", "w", "x" ],
"type" : "object",
"properties" : {
"cells" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/LayoutSection"
}
},
"cssClass" : {
"type" : "string",
"description" : "The CSS class applied to the layout section.",
"example" : null
},
"cssId" : {
"type" : "string",
"description" : "The CSS ID applied to the layout section.",
"example" : null
},
"cssStyle" : {
"type" : "string",
"description" : "Custom CSS styles applied to the layout section.",
"example" : null
},
"label" : {
"type" : "string",
"description" : "The label for the layout section.",
"example" : null
},
"name" : {
"type" : "string",
"description" : "The internal name of the page.",
"example" : null
},
"params" : {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : { },
"example" : null
},
"description" : "Parameters associated with the layout section.",
"example" : null
},
"rowMetaData" : {
"type" : "array",
"example" : null,
"items" : {
"$ref" : "#/components/schemas/RowMetaData"
}
},
"rows" : {
"type" : "array",
"example" : null,
"items" : {
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/LayoutSection"
},
"example" : null
}
},
"styles" : {
"$ref" : "#/components/schemas/Styles"
},
"type" : {
"type" : "string",
"description" : "The type of the layout section.",
"example" : null
},
"w" : {
"type" : "integer",
"description" : "The width of the layout section.",
"format" : "int32",
"example" : null
},
"x" : {
"type" : "integer",
"description" : "The x-coordinate position of the layout section.",
"format" : "int32",
"example" : null
}
},
"example" : null
},
"Margin" : {
"required" : [ "bottom", "top" ],
"type" : "object",
"properties" : {
"bottom" : {
"$ref" : "#/components/schemas/Size"
},
"top" : {
"$ref" : "#/components/schemas/Size"
}
},
"example" : null
},
"NextPage" : {
"required" : [ "after" ],
"type" : "object",
"properties" : {
"after" : {
"type" : "string",
"description" : "A paging cursor token for retrieving subsequent pages.",
"example" : null
},
"link" : {
"type" : "string",
"description" : "A URL that can be used to retrieve the next page results.",
"example" : null
}
},
"description" : "Specifies the paging information needed to retrieve the next set of results in a paginated API response",
"example" : null
},
"Padding" : {
"required" : [ "bottom", "left", "right", "top" ],
"type" : "object",
"properties" : {
"bottom" : {
"$ref" : "#/components/schemas/Size"
},
"left" : {
"$ref" : "#/components/schemas/Size"
},
"right" : {
"$ref" : "#/components/schemas/Size"
},
"top" : {
"$ref" : "#/components/schemas/Size"
}
},
"example" : null
},
"Page" : {
"required" : [ "abStatus", "abTestId", "archivedAt", "archivedInDashboard", "attachedStylesheets", "authorName", "campaign", "categoryId", "contentGroupId", "contentTypeCategory", "created", "createdById", "currentState", "currentlyPublished", "domain", "dynamicPageDataSourceId", "dynamicPageDataSourceType", "dynamicPageHubDbTableId", "enableDomainStylesheets", "enableLayoutStylesheets", "featuredImage", "featuredImageAltText", "folderId", "footerHtml", "headHtml", "htmlTitle", "id", "includeDefaultCustomCss", "language", "layoutSections", "linkRelCanonicalUrl", "mabExperimentId", "metaDescription", "name", "pageExpiryDate", "pageExpiryEnabled", "pageExpiryRedirectId", "pageExpiryRedirectUrl", "pageRedirected", "password", "publicAccessRules", "publicAccessRulesEnabled", "publishDate", "publishImmediately", "slug", "state", "subcategory", "templatePath", "themeSettingsValues", "translatedFromId", "translations", "updated", "updatedById", "url", "useFeaturedImage", "widgetContainers", "widgets" ],
"type" : "object",
"properties" : {
"abStatus" : {
"type" : "string",
"description" : "The status of the AB test associated with this page, if applicable",
"example" : null,
"enum" : [ "automated_loser_variant", "automated_master", "automated_variant", "loser_variant", "mab_master", "mab_variant", "master", "variant" ]
},
"abTestId" : {
"type" : "string",
"description" : "The ID of the AB test associated with this page, if applicable",
"example" : null
},
"archivedAt" : {
"type" : "string",
"description" : "The timestamp (ISO8601 format) when this page was deleted.",
"format" : "date-time",
"example" : null
},
"archivedInDashboard" : {
"type" : "boolean",
"description" : "If True, the page will not show up in your dashboard, although the page could still be live.",
"example" : null
},
"attachedStylesheets" : {
"type" : "array",
"description" : "List of stylesheets to attach to this page. These stylesheets are attached to just this page. Order of precedence is bottom to top, just like in the HTML.",
"example" : null,
"items" : {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"properties" : { },
"example" : null
},
"example" : null
}
},
"authorName" : {
"type" : "string",
"description" : "The name of the user that updated this page.",
"example" : null
},
"campaign" : {
"type" : "string",
"description" : "The GUID of the marketing campaign this page is a part of.",
"example" : null
},
"categoryId" : {
"type" : "integer",
"description" : "ID of the type of object this is. Should always .",
"format" : "int32",
"example" : null
},
"contentGroupId" : {
"type" : "string",
"description" : "The unique identifier for the content group associated with the page.",
"example" : null
},
"contentTypeCategory" : {
"type" : "string",
"description" : "An ENUM descibing the type of this object. Should be either LANDING_PAGE or SITE_PAGE.",
"example" : null,
"enum" : [ "0", "1", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "2", "20", "21", "22", "3", "4", "5", "6", "7", "8", "9" ]
},
"created" : {
"type" : "string",
"description" : "The timestamp indicating when the page was created.",
"format" : "date-time",
"example" : null
},
"createdById" : {
"type" : "string",
"description" : "The ID of the user that created this page.",
"example" : null
},
"currentState" : {
"type" : "string",
"description" : "A generated ENUM descibing the current state of this page.",
"example" : null,
"enum" : [ "AGENT_GENERATED", "AUTOMATED", "AUTOMATED_AB", "AUTOMATED_AB_VARIANT", "AUTOMATED_DRAFT", "AUTOMATED_DRAFT_AB", "AUTOMATED_DRAFT_ABVARIANT", "AUTOMATED_FOR_FORM", "AUTOMATED_FOR_FORM_BUFFER", "AUTOMATED_FOR_FORM_DRAFT", "AUTOMATED_FOR_FORM_LEGACY", "AUTOMATED_LOSER_ABVARIANT", "AUTOMATED_SENDING", "BLOG_EMAIL_DRAFT", "BLOG_EMAIL_PUBLISHED", "DRAFT", "DRAFT_AB", "DRAFT_AB_VARIANT", "ERROR", "LOSER_AB_VARIANT", "PAGE_STUB", "PRE_PROCESSING", "PROCESSING", "PUBLISHED", "PUBLISHED_AB", "PUBLISHED_AB_VARIANT", "PUBLISHED_OR_SCHEDULED", "RSS_TO_EMAIL_DRAFT", "RSS_TO_EMAIL_PUBLISHED", "SCHEDULED", "SCHEDULED_AB", "SCHEDULED_OR_PUBLISHED" ]
},
"currentlyPublished" : {
"type" : "boolean",
"description" : "Indicates whether the page is currently published.",
"example" : null
},
"domain" : {
"type" : "string",
"description" : "The domain this page will resolve to. If null, the page will default to the primary domain for this content type.",
"example" : null
},
"dynamicPageDataSourceId" : {
"type" : "string",
"description" : "The identifier for the data source used by the dynamic page.",
"example" : null
},
"dynamicPageDataSourceType" : {
"type" : "integer",
"description" : "The type of data source used by the dynamic page.",
"format" : "int32",
"example" : null
},
"dynamicPageHubDbTableId" : {
"type" : "string",
"description" : "The ID of the HubDB table this page references, if applicable",
"example" : null
},
"enableDomainStylesheets" : {
"type" : "boolean",
"description" : "Boolean to determine whether or not the styles from the template should be applied.",
"example" : null
},
"enableLayoutStylesheets" : {
"type" : "boolean",
"description" : "Boolean to determine whether or not the styles from the template should be applied.",
"example" : null
},
"featuredImage" : {
"type" : "string",
"description" : "The featuredImage of this page.",
"example" : null
},
"featuredImageAltText" : {
"type" : "string",
"description" : "Alt Text of the featuredImage.",
"example" : null
},
"folderId" : {
"type" : "string",
"description" : "The ID of the associated folder this landing page is organized under in the app dashboard.",
"example" : null
},
"footerHtml" : {
"type" : "string",
"description" : "Custom HTML for embed codes, javascript that should be placed before the tag of the page.",
"example" : null
},
"headHtml" : {
"type" : "string",
"description" : "Custom HTML for embed codes, javascript, etc. that goes in the