Hubspotcmsconnector v1 | OneTeg Documentation

Version 1

Connector Overview: This page documents all 168 actions for the Hubspotcmsconnector v1.

Blog Posts API (24)

POST Attach a Blog Post to a multi-language group

/blogs/posts/multi-language/attach-to-lang-group

Attach a Blog Post to a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Id`	N/A
`Language`	N/A
`Primaryid`	N/A
`Primarylanguage`	N/A

POST Clone a Blog Post

/blogs/posts/clone

Clone a Blog Post.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	N/A
`Clonename`	N/A

POST Create a batch of Blog Posts

/blogs/posts/batch/create

Create the Blog Post objects detailed in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Create a new Blog Post

/blogs/posts

Create a new Blog Post.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (55)

Option Name	Description
`Abstatus`	N/A
`Abtestid`	N/A
`Archivedat`	N/A
`Archivedindashboard`	N/A
`Authorname`	N/A
`Blogauthorid`	N/A
`Campaign`	N/A
`Categoryid`	N/A
`Contentgroupid`	N/A
`Contenttypecategory`	N/A
`Created`	N/A
`Createdbyid`	N/A
`Currentstate`	N/A
`Currentlypublished`	N/A
`Domain`	N/A
`Dynamicpagedatasourceid`	N/A
`Dynamicpagedatasourcetype`	N/A
`Dynamicpagehubdbtableid`	N/A
`Enabledomainstylesheets`	N/A
`Enablegoogleampoutputoverride`	N/A
`Enablelayoutstylesheets`	N/A
`Featuredimage`	N/A
`Featuredimagealttext`	N/A
`Folderid`	N/A
`Footerhtml`	N/A
`Headhtml`	N/A
`Htmltitle`	N/A
`Id`	N/A
`Includedefaultcustomcss`	N/A
`Language`	N/A
`Linkrelcanonicalurl`	N/A
`Mabexperimentid`	N/A
`Metadescription`	N/A
`Name`	N/A
`Pageexpirydate`	N/A
`Pageexpiryenabled`	N/A
`Pageexpiryredirectid`	N/A
`Pageexpiryredirecturl`	N/A
`Password`	N/A
`Postbody`	N/A
`Postsummary`	N/A
`Publicaccessrules`	N/A
`Publicaccessrulesenabled`	N/A
`Publishdate`	N/A
`Publishimmediately`	N/A
`Rssbody`	N/A
`Rsssummary`	N/A
`Slug`	N/A
`State`	N/A
`Tagids`	N/A
`Translatedfromid`	N/A
`Updated`	N/A
`Updatedbyid`	N/A
`Url`	N/A
`Usefeaturedimage`	N/A

POST Create a new language variation

/blogs/posts/multi-language/create-language-variation

Create a new language variation from an existing Blog Post

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	N/A
`Language`	N/A

DELETE Delete a Blog Post

/blogs/posts/{objectId}

Delete the Blog Post object identified by the id in the path.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Whether to return only results that have been archived.
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Delete a batch of Blog Posts

/blogs/posts/batch/archive

Delete the Blog Post objects identified in the request body.
Note: This is not the same as the in-app archive function. To perform a dashboard archive send an normal update with the archivedInDashboard field set to true.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Detach a Blog Post from a multi-language group

/blogs/posts/multi-language/detach-from-lang-group

Detach a Blog Post from a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	N/A

GET Get all Blog Posts

/blogs/posts

Get the list of blog posts. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Createdat`	Only return Blog Posts created at exactly the specified time.
`Createdafter`	Only return Blog Posts created after the specified time.
`Createdbefore`	Only return Blog Posts created before the specified time.
`Updatedat`	Only return Blog Posts last updated at exactly the specified time.
`Updatedafter`	Only return Blog Posts last updated after the specified time.
`Updatedbefore`	Only return Blog Posts last updated before the specified time.
`Sort`	Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default.
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Limit`	The maximum number of results to return. Default is 20.
`Archived`	Specifies whether to return deleted Blog Posts. Defaults to false.
`Property`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Push Blog Post draft edits live

/blogs/posts/{objectId}/draft/push-live

Take any changes from the draft version of the Blog Post and apply them to the live version.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Reset the Blog Post draft to the live version

/blogs/posts/{objectId}/draft/reset

Discards any edits and resets the draft to the live version.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Restore a previous version of a blog post

/blogs/posts/{objectId}/revisions/{revisionId}/restore

Takes a specified version of a blog post and restores it.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Revisionid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Restore a previous version of a blog post, to the draft version of the blog post

/blogs/posts/{objectId}/revisions/{revisionId}/restore-to-draft

Takes a specified version of a blog post, sets it as the new draft version of the blog post.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Revisionid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieve a Blog Post

/blogs/posts/{objectId}

Retrieve the Blog Post object identified by the id in the path.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to return deleted Blog Posts. Defaults to false.
`Property`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Retrieve a batch of Blog Posts

/blogs/posts/batch/read

Retrieve the Blog Post objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to return deleted Blog Posts. Defaults to false.
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

GET Retrieve the full draft version of the Blog Post

/blogs/posts/{objectId}/draft

Retrieve the full draft version of the Blog Post.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieves a previous version of a blog post

/blogs/posts/{objectId}/revisions/{revisionId}

Retrieves a previous version of a blog post.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Revisionid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieves all the previous versions of a blog post

/blogs/posts/{objectId}/revisions

Retrieves all the previous versions of a blog post.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Before`	N/A
`Limit`	The maximum number of results to return. Default is 100.
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Schedule a Blog Post to be Published

/blogs/posts/schedule

Schedule a Blog Post to be Published.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	N/A
`Publishdate`	N/A

PUT Set a new primary language

/blogs/posts/multi-language/set-new-lang-primary

Set a Blog Post as the primary language of a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	N/A

PATCH Update a Blog Post

/blogs/posts/{objectId}

Sparse updates a single Blog Post object identified by the id in the path.
All the column values need not be specified. Only the that need to be modified can be specified.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to update deleted Blog Posts. Defaults to false.
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (55)

Option Name	Description
`Abstatus`	N/A
`Abtestid`	N/A
`Archivedat`	N/A
`Archivedindashboard`	N/A
`Authorname`	N/A
`Blogauthorid`	N/A
`Campaign`	N/A
`Categoryid`	N/A
`Contentgroupid`	N/A
`Contenttypecategory`	N/A
`Created`	N/A
`Createdbyid`	N/A
`Currentstate`	N/A
`Currentlypublished`	N/A
`Domain`	N/A
`Dynamicpagedatasourceid`	N/A
`Dynamicpagedatasourcetype`	N/A
`Dynamicpagehubdbtableid`	N/A
`Enabledomainstylesheets`	N/A
`Enablegoogleampoutputoverride`	N/A
`Enablelayoutstylesheets`	N/A
`Featuredimage`	N/A
`Featuredimagealttext`	N/A
`Folderid`	N/A
`Footerhtml`	N/A
`Headhtml`	N/A
`Htmltitle`	N/A
`Id`	N/A
`Includedefaultcustomcss`	N/A
`Language`	N/A
`Linkrelcanonicalurl`	N/A
`Mabexperimentid`	N/A
`Metadescription`	N/A
`Name`	N/A
`Pageexpirydate`	N/A
`Pageexpiryenabled`	N/A
`Pageexpiryredirectid`	N/A
`Pageexpiryredirecturl`	N/A
`Password`	N/A
`Postbody`	N/A
`Postsummary`	N/A
`Publicaccessrules`	N/A
`Publicaccessrulesenabled`	N/A
`Publishdate`	N/A
`Publishimmediately`	N/A
`Rssbody`	N/A
`Rsssummary`	N/A
`Slug`	N/A
`State`	N/A
`Tagids`	N/A
`Translatedfromid`	N/A
`Updated`	N/A
`Updatedbyid`	N/A
`Url`	N/A
`Usefeaturedimage`	N/A

PATCH Update a Blog Post draft

/blogs/posts/{objectId}/draft

Sparse updates the draft version of a single Blog Post object identified by the id in the path.
All the column values need not be specified. Only the that need to be modified can be specified.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (55)

Option Name	Description
`Abstatus`	N/A
`Abtestid`	N/A
`Archivedat`	N/A
`Archivedindashboard`	N/A
`Authorname`	N/A
`Blogauthorid`	N/A
`Campaign`	N/A
`Categoryid`	N/A
`Contentgroupid`	N/A
`Contenttypecategory`	N/A
`Created`	N/A
`Createdbyid`	N/A
`Currentstate`	N/A
`Currentlypublished`	N/A
`Domain`	N/A
`Dynamicpagedatasourceid`	N/A
`Dynamicpagedatasourcetype`	N/A
`Dynamicpagehubdbtableid`	N/A
`Enabledomainstylesheets`	N/A
`Enablegoogleampoutputoverride`	N/A
`Enablelayoutstylesheets`	N/A
`Featuredimage`	N/A
`Featuredimagealttext`	N/A
`Folderid`	N/A
`Footerhtml`	N/A
`Headhtml`	N/A
`Htmltitle`	N/A
`Id`	N/A
`Includedefaultcustomcss`	N/A
`Language`	N/A
`Linkrelcanonicalurl`	N/A
`Mabexperimentid`	N/A
`Metadescription`	N/A
`Name`	N/A
`Pageexpirydate`	N/A
`Pageexpiryenabled`	N/A
`Pageexpiryredirectid`	N/A
`Pageexpiryredirecturl`	N/A
`Password`	N/A
`Postbody`	N/A
`Postsummary`	N/A
`Publicaccessrules`	N/A
`Publicaccessrulesenabled`	N/A
`Publishdate`	N/A
`Publishimmediately`	N/A
`Rssbody`	N/A
`Rsssummary`	N/A
`Slug`	N/A
`State`	N/A
`Tagids`	N/A
`Translatedfromid`	N/A
`Updated`	N/A
`Updatedbyid`	N/A
`Url`	N/A
`Usefeaturedimage`	N/A

POST Update a batch of Blog Posts

/blogs/posts/batch/update

Update the Blog Post objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to update deleted Blog Posts. Defaults to false.
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Update languages of multi-language group

/blogs/posts/multi-language/update-languages

Explicitly set new languages for each Blog Post in a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Primaryid`	N/A

Blog Settings API (9)

POST Attach a blog to a multi-language group

/blog-settings/settings/multi-language/attach-to-lang-group

Attach a blog to a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Id`	N/A
`Language`	N/A
`Primaryid`	N/A
`Primarylanguage`	N/A

POST Create a new language variation

/blog-settings/settings/multi-language/create-language-variation

Create a new language variation from an existing blog

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Id`	N/A
`Language`	N/A
`Primarylanguage`	N/A
`Slug`	N/A

POST Detach a blog from a multi-language group

/blog-settings/settings/multi-language/detach-from-lang-group

Detach a blog from a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	N/A

GET Get all Blogs

/blog-settings/settings

Get the list of Blogs. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Createdat`	Only return Blogs created at exactly the specified time.
`Createdafter`	Only return Blogs created after the specified time.
`Createdbefore`	Only return Blogs created before the specified time.
`Updatedat`	Only return Blogs last updated at exactly the specified time.
`Updatedafter`	Only return Blogs last updated after the specified time.
`Updatedbefore`	Only return Blogs last updated before the specified time.
`Sort`	Specifies which fields to use for sorting results. Valid fields are name and id
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Limit`	The maximum number of results to return. Default is 100.
`Archived`	Specifies whether to return archived Blogs. Defaults to false.
`Accept`	N/A
`Response Type`	N/A

GET Retrieve a Blog

/blog-settings/settings/{blogId}

Retrieve the Blog object identified by the id in the path.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Blogid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieves a previous version of a Blog

/blog-settings/settings/{blogId}/revisions/{revisionId}

Retrieves a previous version of a Blog

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Blogid`	N/A
`Revisionid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieves all the previous versions of a Blog

/blog-settings/settings/{blogId}/revisions

Retrieves all the previous versions of a Blog

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Before`	N/A
`Limit`	The maximum number of results to return. Default is 100.
`Blogid`	N/A
`Accept`	N/A
`Response Type`	N/A

PUT Set a new primary language

/blog-settings/settings/multi-language/set-new-lang-primary

Set a blog as the primary language of a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	N/A

POST Update languages of multi-language group

/blog-settings/settings/multi-language/update-languages

Explicitly set new languages for each blog in a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Primaryid`	N/A

Blog Tags API (14)

POST Attach a Blog Author to a multi-language group

/blogs/authors/multi-language/attach-to-lang-group

Attach a Blog Author to a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Id`	N/A
`Language`	N/A
`Primaryid`	N/A
`Primarylanguage`	N/A

POST Create a batch of Blog Authors

/blogs/authors/batch/create

Create the Blog Author objects detailed in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Create a new Blog Author

/blogs/authors

Create a new Blog Author.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (17)

Option Name	Description
`Avatar`	N/A
`Bio`	N/A
`Created`	N/A
`Deletedat`	N/A
`Displayname`	N/A
`Email`	N/A
`Facebook`	N/A
`Fullname`	N/A
`Id`	N/A
`Language`	N/A
`Linkedin`	N/A
`Name`	N/A
`Slug`	N/A
`Translatedfromid`	N/A
`Twitter`	N/A
`Updated`	N/A
`Website`	N/A

POST Create a new language variation1

/blogs/authors/multi-language/create-language-variation

Create a new language variation from an existing Blog Author.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	N/A
`Language`	N/A
`Primarylanguage`	N/A

DELETE Delete a Blog Author

/blogs/authors/{objectId}

Delete the Blog Author object identified by the id in the path.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Whether to return only results that have been archived.
`Objectid`	(Required) The Blog Author id.
`Accept`	N/A
`Response Type`	N/A

POST Delete a batch of Blog Authors

/blogs/authors/batch/archive

Delete the Blog Author objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Detach a Blog Author from a multi-language group

/blogs/authors/multi-language/detach-from-lang-group

Detach a Blog Author from a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	N/A

GET Get all Blog Authors

/blogs/authors

Get the list of blog authors. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Createdat`	Only return Blog Authors created at exactly the specified time.
`Createdafter`	Only return Blog Authors created after the specified time.
`Createdbefore`	Only return Blog Authors created before the specified time.
`Updatedat`	Only return Blog Authors last updated at exactly the specified time.
`Updatedafter`	Only return Blog Authors last updated after the specified time.
`Updatedbefore`	Only return Blog Authors last updated before the specified time.
`Sort`	Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default.
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Limit`	The maximum number of results to return. Default is 100.
`Archived`	Specifies whether to return deleted Blog Authors. Defaults to false.
`Property`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieve a Blog Author

/blogs/authors/{objectId}

Retrieve the Blog Author object identified by the id in the path.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to return deleted Blog Authors. Defaults to false.
`Property`	N/A
`Objectid`	(Required) The Blog Author id.
`Accept`	N/A
`Response Type`	N/A

POST Retrieve a batch of Blog Authors

/blogs/authors/batch/read

Retrieve the Blog Author objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to return deleted Blog Authors. Defaults to false.
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

PUT Set a new primary language

/blogs/authors/multi-language/set-new-lang-primary

Set a Blog Author as the primary language of a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	N/A

PATCH Update a Blog Author

/blogs/authors/{objectId}

Sparse updates a single Blog Author object identified by the id in the path.
All the column values need not be specified. Only the that need to be modified can be specified.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to update deleted Blog Authors. Defaults to false.
`Objectid`	(Required) The Blog Author id.
`Accept`	N/A
`Response Type`	N/A

Options (17)

Option Name	Description
`Avatar`	N/A
`Bio`	N/A
`Created`	N/A
`Deletedat`	N/A
`Displayname`	N/A
`Email`	N/A
`Facebook`	N/A
`Fullname`	N/A
`Id`	N/A
`Language`	N/A
`Linkedin`	N/A
`Name`	N/A
`Slug`	N/A
`Translatedfromid`	N/A
`Twitter`	N/A
`Updated`	N/A
`Website`	N/A

POST Update a batch of Blog Authors

/blogs/authors/batch/update

Update the Blog Author objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to update deleted Blog Authors. Defaults to false.
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Update languages of multi-language group1

/blogs/authors/multi-language/update-languages

Explicitly set new languages for each Blog Author in a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Primaryid`	N/A

Blog Tags (14)

POST Attach a Blog Tag to a multi-language group

/blogs/tags/multi-language/attach-to-lang-group

Attach a Blog Tag to a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Id`	N/A
`Language`	N/A
`Primaryid`	N/A
`Primarylanguage`	N/A

POST Create a batch of Blog Tags

/blogs/tags/batch/create

Create the Blog Tag objects detailed in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Create a new Blog Tag

/blogs/tags

Create a new Blog Tag.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (7)

Option Name	Description
`Created`	N/A
`Deletedat`	N/A
`Id`	N/A
`Language`	N/A
`Name`	N/A
`Translatedfromid`	N/A
`Updated`	N/A

POST Create a new language variation

/blogs/tags/multi-language/create-language-variation

Create a new language variation from an existing Blog Tag

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Id`	N/A
`Name`	N/A
`Language`	N/A
`Primarylanguage`	N/A

DELETE Delete a Blog Tag

/blogs/tags/{objectId}

Delete the Blog Tag object identified by the id in the path.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Whether to return only results that have been archived.
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Delete a batch of Blog Tags

/blogs/tags/batch/archive

Delete the Blog Tag objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Detach a Blog Tag from a multi-language group

/blogs/tags/multi-language/detach-from-lang-group

Detach a Blog Tag from a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	N/A

GET Get all Blog Tags

/blogs/tags

Get the list of blog tags. Supports paging and filtering. This method would be useful for an integration that examined these models and used an external service to suggest edits.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Createdat`	Only return Blog Tags created at exactly the specified time.
`Createdafter`	Only return Blog Tags created after the specified time.
`Createdbefore`	Only return Blog Tags created before the specified time.
`Updatedat`	Only return Blog Tags last updated at exactly the specified time.
`Updatedafter`	Only return Blog Tags last updated after the specified time.
`Updatedbefore`	Only return Blog Tags last updated before the specified time.
`Sort`	Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default.
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Limit`	The maximum number of results to return. Default is 100.
`Archived`	Specifies whether to return deleted Blog Tags. Defaults to false.
`Property`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieve a Blog Tag

/blogs/tags/{objectId}

Retrieve the Blog Tag object identified by the id in the path.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to return deleted Blog Tags. Defaults to false.
`Property`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Retrieve a batch of Blog Tags

/blogs/tags/batch/read

Retrieve the Blog Tag objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to return deleted Blog Tags. Defaults to false.
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

PUT Set a new primary language

/blogs/tags/multi-language/set-new-lang-primary

Set a Blog Tag as the primary language of a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	N/A

PATCH Update a Blog Tag

/blogs/tags/{objectId}

Sparse updates a single Blog Tag object identified by the id in the path.
All the column values need not be specified. Only the that need to be modified can be specified.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to update deleted Blog Tags. Defaults to false.
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (7)

Option Name	Description
`Created`	N/A
`Deletedat`	N/A
`Id`	N/A
`Language`	N/A
`Name`	N/A
`Translatedfromid`	N/A
`Updated`	N/A

POST Update a batch of Blog Tags

/blogs/tags/batch/update

Update the Blog Tag objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to update deleted Blog Tags. Defaults to false.
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Update languages of multi-language group

/blogs/tags/multi-language/update-languages

Explicitly set new languages for each Blog Tag in a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Primaryid`	N/A

Content (4)

POST Create a file

/source-code/{environment}/content/{path}

Creates a file at the specified path in the specified environment. Accepts multipart/form-data content type. Throws an error if a file already exists at the specified path.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Environment`	(Required) The environment of the file ("draft" or "published").
`Path`	(Required) The file system location of the file.
`Content-type`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	The file to upload.

PUT Create or update a file

/source-code/{environment}/content/{path}

Upserts a file at the specified path in the specified environment. Accepts multipart/form-data content type.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Environment`	(Required) The environment of the file ("draft" or "published").
`Path`	(Required) The file system location of the file.
`Content-type`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	The file to upload.

DELETE Delete a file

/source-code/{environment}/content/{path}

Deletes the file at the specified path in the specified environment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Environment`	(Required) The environment of the file ("draft" or "published").
`Path`	(Required) The file system location of the file.
`Accept`	N/A
`Response Type`	N/A

GET Download a file

/source-code/{environment}/content/{path}

Downloads the byte contents of the file at the specified path in the specified environment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Environment`	(Required) The environment of the file ("draft" or "published").
`Path`	(Required) The file system location of the file.
`Accept`	N/A
`Response Type`	N/A

Domains (2)

GET List all domains

/domains

Retrieves a list of all domains managed in HubSpot CMS.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Retrieve a specific domain by its ID

/domains/{domainId}

Returns detailed information about a specific domain managed in HubSpot CMS.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Domainid`	The ID of the domain to retrieve
`Response Type`	N/A

Extract

POST Extracts a zip file

/source-code/extract/{path}

Extracts a zip file in the file system. The zip file will be extracted in-place and not be deleted automatically.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Path`	(Required) The file system location of the zip file.
`Accept`	N/A
`Response Type`	N/A

Landing Pages (39)

POST Attach a landing page to a multi-language group

/pages/landing-pages/multi-language/attach-to-lang-group

Attach a landing page to a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Id`	N/A
`Language`	N/A
`Primaryid`	N/A
`Primarylanguage`	N/A

POST Clone a Landing Page

/pages/landing-pages/clone

Clone a Landing Page

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	N/A
`Clonename`	N/A

POST Create a batch of Folders

/pages/landing-pages/folders/batch/create

Create the Folder objects detailed in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Create a batch of Landing Pages

/pages/landing-pages/batch/create

Create the Landing Page objects detailed in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Create a new A/B test variation

/pages/landing-pages/ab-test/create-variation

Create a new A/B test variation based on the information provided in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Contentid`	N/A
`Variationname`	N/A

POST Create a new Folder

/pages/landing-pages/folders

Create a new Folder

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (7)

Option Name	Description
`Category`	N/A
`Created`	N/A
`Deletedat`	N/A
`Id`	N/A
`Name`	N/A
`Parentfolderid`	N/A
`Updated`	N/A

POST Create a new Landing Page

/pages/landing-pages

Create a new Landing Page

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (51)

Option Name	Description
`Abstatus`	N/A
`Abtestid`	N/A
`Archivedat`	N/A
`Archivedindashboard`	N/A
`Authorname`	N/A
`Campaign`	N/A
`Categoryid`	N/A
`Contentgroupid`	N/A
`Contenttypecategory`	N/A
`Created`	N/A
`Createdbyid`	N/A
`Currentstate`	N/A
`Currentlypublished`	N/A
`Domain`	N/A
`Dynamicpagedatasourceid`	N/A
`Dynamicpagedatasourcetype`	N/A
`Dynamicpagehubdbtableid`	N/A
`Enabledomainstylesheets`	N/A
`Enablelayoutstylesheets`	N/A
`Featuredimage`	N/A
`Featuredimagealttext`	N/A
`Folderid`	N/A
`Footerhtml`	N/A
`Headhtml`	N/A
`Htmltitle`	N/A
`Id`	N/A
`Includedefaultcustomcss`	N/A
`Language`	N/A
`Linkrelcanonicalurl`	N/A
`Mabexperimentid`	N/A
`Metadescription`	N/A
`Name`	N/A
`Pageexpirydate`	N/A
`Pageexpiryenabled`	N/A
`Pageexpiryredirectid`	N/A
`Pageexpiryredirecturl`	N/A
`Pageredirected`	N/A
`Password`	N/A
`Publicaccessrules`	N/A
`Publicaccessrulesenabled`	N/A
`Publishdate`	N/A
`Publishimmediately`	N/A
`Slug`	N/A
`State`	N/A
`Subcategory`	N/A
`Templatepath`	N/A
`Translatedfromid`	N/A
`Updated`	N/A
`Updatedbyid`	N/A
`Url`	N/A
`Usefeaturedimage`	N/A

POST Create a new language variation

/pages/landing-pages/multi-language/create-language-variation

Create a new language variation from an existing landing page

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	N/A
`Language`	N/A
`Primarylanguage`	N/A

DELETE Delete a Folder

/pages/landing-pages/folders/{objectId}

Delete the Folder object identified by the id in the path.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Whether to return only results that have been archived.
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

DELETE Delete a Landing Page

/pages/landing-pages/{objectId}

Delete the Landing Page object identified by the id in the path.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Whether to return only results that have been archived.
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Delete a batch of Folders

/pages/landing-pages/folders/batch/archive

Delete the Folder objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Delete a batch of Landing Pages

/pages/landing-pages/batch/archive

Delete the Landing Page objects identified 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.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Detach a landing page from a multi-language group

/pages/landing-pages/multi-language/detach-from-lang-group

Detach a landing page from a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	N/A

POST End an active A/B test

/pages/landing-pages/ab-test/end

End an active A/B test and designate a winner.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Abtestid`	N/A
`Winnerid`	N/A

GET Get all Landing Page Folders

/pages/landing-pages/folders

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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Createdat`	Only return Folders created at exactly the specified time.
`Createdafter`	Only return Folders created after the specified time.
`Createdbefore`	Only return Folders created before the specified time.
`Updatedat`	Only return Folders last updated at exactly the specified time.
`Updatedafter`	Only return Folders last updated after the specified time.
`Updatedbefore`	Only return Folders last updated before the specified time.
`Sort`	Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default.
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Limit`	The maximum number of results to return. Default is 100.
`Archived`	Specifies whether to return deleted Folders. Defaults to false.
`Property`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get all Landing Pages

/pages/landing-pages

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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Createdat`	Only return Landing Pages created at exactly the specified time.
`Createdafter`	Only return Landing Pages created after the specified time.
`Createdbefore`	Only return Landing Pages created before the specified time.
`Updatedat`	Only return Landing Pages last updated at exactly the specified time.
`Updatedafter`	Only return Landing Pages last updated after the specified time.
`Updatedbefore`	Only return Landing Pages last updated before the specified time.
`Sort`	Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default.
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Limit`	The maximum number of results to return. Default is 100.
`Archived`	Specifies whether to return deleted Landing Pages. Defaults to false.
`Property`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Push Landing Page draft edits live

/pages/landing-pages/{objectId}/draft/push-live

Take any changes from the draft version of the Landing Page and apply them to the live version.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Rerun a previous A/B test

/pages/landing-pages/ab-test/rerun

Rerun a previous A/B test.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Abtestid`	N/A
`Variationid`	N/A

POST Reset the Landing Page draft to the live version

/pages/landing-pages/{objectId}/draft/reset

Discards any edits and resets the draft to the live version.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Restore a previous version of a Folder

/pages/landing-pages/folders/{objectId}/revisions/{revisionId}/restore

Takes a specified version of a Folder and restores it.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Revisionid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Restore a previous version of a Landing Page

/pages/landing-pages/{objectId}/revisions/{revisionId}/restore

Takes a specified version of a Landing Page and restores it.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Revisionid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Restore a previous version of a Landing Page, to the draft version of the Landing Page

/pages/landing-pages/{objectId}/revisions/{revisionId}/restore-to-draft

Takes a specified version of a Landing Page, sets it as the new draft version of the Landing Page.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Revisionid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieve a Folder

/pages/landing-pages/folders/{objectId}

Retrieve the Folder object identified by the id in the path.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to return deleted Folders. Defaults to false.
`Property`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieve a Landing Page

/pages/landing-pages/{objectId}

Retrieve the Landing Page object identified by the id in the path.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to return deleted Landing Pages. Defaults to false.
`Property`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Retrieve a batch of Folders

/pages/landing-pages/folders/batch/read

Update the Folder objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to return deleted Folders. Defaults to false.
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Retrieve a batch of Landing Pages

/pages/landing-pages/batch/read

Retrieve the Landing Page objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to return deleted Landing Pages. Defaults to false.
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

GET Retrieve the full draft version of the Landing Page

/pages/landing-pages/{objectId}/draft

Retrieve the full draft version of the Landing Page.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieves a previous version of a Folder

/pages/landing-pages/folders/{objectId}/revisions/{revisionId}

Retrieves a previous version of a Folder

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Revisionid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieves a previous version of a Landing Page

/pages/landing-pages/{objectId}/revisions/{revisionId}

Retrieves a previous version of a Landing Page

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Revisionid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieves all the previous versions of a Folder

/pages/landing-pages/folders/{objectId}/revisions

Retrieves all the previous versions of a Folder.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Before`	N/A
`Limit`	The maximum number of results to return. Default is 100.
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieves all the previous versions of a Landing Page

/pages/landing-pages/{objectId}/revisions

Retrieves all the previous versions of a Landing Page.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Before`	N/A
`Limit`	The maximum number of results to return. Default is 100.
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Schedule a Landing Page to be Published

/pages/landing-pages/schedule

Schedule a Landing Page to be Published

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	N/A
`Publishdate`	N/A

PUT Set a new primary language

/pages/landing-pages/multi-language/set-new-lang-primary

Set a landing page as the primary language of a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	N/A

PATCH Update a Folder

/pages/landing-pages/folders/{objectId}

Sparse updates a single Folder object identified by the id in the path.
You only need to specify the column values that you are modifying.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to update deleted Folders. Defaults to false.
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (7)

Option Name	Description
`Category`	N/A
`Created`	N/A
`Deletedat`	N/A
`Id`	N/A
`Name`	N/A
`Parentfolderid`	N/A
`Updated`	N/A

PATCH Update a Landing Page

/pages/landing-pages/{objectId}

Sparse updates a single Landing Page object identified by the id in the path.
You only need to specify the column values that you are modifying.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to update deleted Landing Pages. Defaults to false.
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (51)

Option Name	Description
`Abstatus`	N/A
`Abtestid`	N/A
`Archivedat`	N/A
`Archivedindashboard`	N/A
`Authorname`	N/A
`Campaign`	N/A
`Categoryid`	N/A
`Contentgroupid`	N/A
`Contenttypecategory`	N/A
`Created`	N/A
`Createdbyid`	N/A
`Currentstate`	N/A
`Currentlypublished`	N/A
`Domain`	N/A
`Dynamicpagedatasourceid`	N/A
`Dynamicpagedatasourcetype`	N/A
`Dynamicpagehubdbtableid`	N/A
`Enabledomainstylesheets`	N/A
`Enablelayoutstylesheets`	N/A
`Featuredimage`	N/A
`Featuredimagealttext`	N/A
`Folderid`	N/A
`Footerhtml`	N/A
`Headhtml`	N/A
`Htmltitle`	N/A
`Id`	N/A
`Includedefaultcustomcss`	N/A
`Language`	N/A
`Linkrelcanonicalurl`	N/A
`Mabexperimentid`	N/A
`Metadescription`	N/A
`Name`	N/A
`Pageexpirydate`	N/A
`Pageexpiryenabled`	N/A
`Pageexpiryredirectid`	N/A
`Pageexpiryredirecturl`	N/A
`Pageredirected`	N/A
`Password`	N/A
`Publicaccessrules`	N/A
`Publicaccessrulesenabled`	N/A
`Publishdate`	N/A
`Publishimmediately`	N/A
`Slug`	N/A
`State`	N/A
`Subcategory`	N/A
`Templatepath`	N/A
`Translatedfromid`	N/A
`Updated`	N/A
`Updatedbyid`	N/A
`Url`	N/A
`Usefeaturedimage`	N/A

PATCH Update a Landing Page draft

/pages/landing-pages/{objectId}/draft

Sparse updates the draft version of a single Landing Page object identified by the id in the path.
You only need to specify the column values that you are modifying.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (51)

Option Name	Description
`Abstatus`	N/A
`Abtestid`	N/A
`Archivedat`	N/A
`Archivedindashboard`	N/A
`Authorname`	N/A
`Campaign`	N/A
`Categoryid`	N/A
`Contentgroupid`	N/A
`Contenttypecategory`	N/A
`Created`	N/A
`Createdbyid`	N/A
`Currentstate`	N/A
`Currentlypublished`	N/A
`Domain`	N/A
`Dynamicpagedatasourceid`	N/A
`Dynamicpagedatasourcetype`	N/A
`Dynamicpagehubdbtableid`	N/A
`Enabledomainstylesheets`	N/A
`Enablelayoutstylesheets`	N/A
`Featuredimage`	N/A
`Featuredimagealttext`	N/A
`Folderid`	N/A
`Footerhtml`	N/A
`Headhtml`	N/A
`Htmltitle`	N/A
`Id`	N/A
`Includedefaultcustomcss`	N/A
`Language`	N/A
`Linkrelcanonicalurl`	N/A
`Mabexperimentid`	N/A
`Metadescription`	N/A
`Name`	N/A
`Pageexpirydate`	N/A
`Pageexpiryenabled`	N/A
`Pageexpiryredirectid`	N/A
`Pageexpiryredirecturl`	N/A
`Pageredirected`	N/A
`Password`	N/A
`Publicaccessrules`	N/A
`Publicaccessrulesenabled`	N/A
`Publishdate`	N/A
`Publishimmediately`	N/A
`Slug`	N/A
`State`	N/A
`Subcategory`	N/A
`Templatepath`	N/A
`Translatedfromid`	N/A
`Updated`	N/A
`Updatedbyid`	N/A
`Url`	N/A
`Usefeaturedimage`	N/A

POST Update a batch of Folders

/pages/landing-pages/folders/batch/update

Update the Folder objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Whether to return only results that have been archived.
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Update a batch of Landing Pages

/pages/landing-pages/batch/update

Update the Landing Page objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to update deleted Landing Pages. Defaults to false.
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Update languages of multi-language group

/pages/landing-pages/multi-language/update-languages

Explicitly set new languages for each landing page in a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Primaryid`	N/A

Metadata

GET Get the metadata for a file

/source-code/{environment}/metadata/{path}

Gets the metadata object for the file at the specified path in the specified environment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Properties`	N/A
`Environment`	(Required) The environment of the file ("draft" or "published").
`Path`	(Required) The file system location of the file.
`Accept`	N/A
`Response Type`	N/A

Rows Batch (7)

POST Clone rows in batch

/hubdb/tables/{tableIdOrName}/rows/draft/batch/clone

Clones rows in the draft version of the specified table, given a set of row ids. Maximum of 100 row ids per call.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Create rows in batch

/hubdb/tables/{tableIdOrName}/rows/draft/batch/create

Creates rows in the draft version of the specified table, given an array of row objects. Maximum of 100 row object per call. See the overview section for more details with an example.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Get a set of rows

/hubdb/tables/{tableIdOrName}/rows/batch/read

Returns rows in the published version of the specified table, given a set of row ids.
Note: This endpoint can be accessed without any authentication if the table is set to be allowed for public access.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Get a set of rows from draft table

/hubdb/tables/{tableIdOrName}/rows/draft/batch/read

Returns rows in the draft version of the specified table, given a set of row ids.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Permanently deletes rows

/hubdb/tables/{tableIdOrName}/rows/draft/batch/purge

Permanently deletes rows from the draft version of the table, given a set of row ids. Maximum of 100 row ids per call.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Replace rows in batch in draft table

/hubdb/tables/{tableIdOrName}/rows/draft/batch/replace

Replaces multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint PUT /tables/{tableIdOrName}/rows/{rowId}/draft for details on updating a single row.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Update rows in batch in draft table

/hubdb/tables/{tableIdOrName}/rows/draft/batch/update

Updates multiple rows as a batch in the draft version of the table, with a maximum of 100 rows per call. See the endpoint PATCH /tables/{tableIdOrName}/rows/{rowId}/draft for details on updating a single row.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

Rows (9)

POST Add a new row to a table

/hubdb/tables/{tableIdOrName}/rows

Add a new row to a HubDB table. New rows will be added to the draft version of the table. Use publish endpoint to push these changes to published version.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Path`	N/A
`Name`	N/A
`Childtableid`	N/A
`Displayindex`	N/A

POST Clone a row

/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft/clone

Clones a single row in the draft version of the table.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Name`	N/A
`Tableidorname`	N/A
`Rowid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get a row from the draft table

/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft

Get a single row by ID from a table's draft version.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	N/A
`Tableidorname`	N/A
`Rowid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get a table row

/hubdb/tables/{tableIdOrName}/rows/{rowId}

Get a single row by ID from a table's published version.
Note: This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	N/A
`Tableidorname`	N/A
`Rowid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get rows for a table

/hubdb/tables/{tableIdOrName}/rows

Returns a set of rows in the published version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters column1__gt=5&sort=-column1, API returns the rows with values for column column1 greater than 5 and in the descending order of column1 values. Refer to the overview section for detailed filtering and sorting options.
Note: This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Sort`	Specifies the column names to sort the results by. See the above description for more details.
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Limit`	The maximum number of results to return. Default is 1000.
`Properties`	Specify the column names to get results containing only the required columns instead of all column details.
`Offset`	N/A
`Archived`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get rows from draft table

/hubdb/tables/{tableIdOrName}/rows/draft

Returns rows in the draft version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters column1__gt=5&sort=-column1, API returns the rows with values for column column1 greater than 5 and in the descending order of column1 values. Refer to the overview section for detailed filtering and sorting options.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Sort`	Specifies the column names to sort the results by.
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Limit`	The maximum number of results to return. Default is 1000.
`Properties`	Specify the column names to get results containing only the required columns instead of all column details. If you want to include multiple columns in the result, use this query param as many times.
`Offset`	N/A
`Archived`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

DELETE Permanently deletes a row

/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft

Permanently deletes a row from a table's draft version.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tableidorname`	N/A
`Rowid`	N/A
`Accept`	N/A
`Response Type`	N/A

PUT Replaces an existing row

/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft

Replace a single row in the table's draft version.
All the column values must be specified. If a column has a value in the target table and this request doesn't define that value, it will be deleted.
See the Create a row endpoint for instructions on how to format the JSON row definitions.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tableidorname`	N/A
`Rowid`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Path`	N/A
`Name`	N/A
`Childtableid`	N/A
`Displayindex`	N/A

PATCH Updates an existing row

/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft

Sparse updates a single row in the table's draft version.
All the column values need not be specified. Only the columns or fields that needs to be modified can be specified.
See the Create a row endpoint for instructions on how to format the JSON row definitions.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tableidorname`	N/A
`Rowid`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Path`	N/A
`Name`	N/A
`Childtableid`	N/A
`Displayindex`	N/A

Site Pages (27)

POST Attach a site page to a multi-language group

/pages/site-pages/multi-language/attach-to-lang-group

Attach a site page to a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Id`	N/A
`Language`	N/A
`Primaryid`	N/A
`Primarylanguage`	N/A

POST Clone a Site Page

/pages/site-pages/clone

Clone a Site Page

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	N/A
`Clonename`	N/A

POST Create a batch of Site Pages

/pages/site-pages/batch/create

Create the Site Page objects detailed in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Create a new A/B test variation

/pages/site-pages/ab-test/create-variation

Create a new A/B test variation based on the information provided in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Contentid`	N/A
`Variationname`	N/A

POST Create a new Site Page

/pages/site-pages

Create a new Site Page

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (51)

Option Name	Description
`Abstatus`	N/A
`Abtestid`	N/A
`Archivedat`	N/A
`Archivedindashboard`	N/A
`Authorname`	N/A
`Campaign`	N/A
`Categoryid`	N/A
`Contentgroupid`	N/A
`Contenttypecategory`	N/A
`Created`	N/A
`Createdbyid`	N/A
`Currentstate`	N/A
`Currentlypublished`	N/A
`Domain`	N/A
`Dynamicpagedatasourceid`	N/A
`Dynamicpagedatasourcetype`	N/A
`Dynamicpagehubdbtableid`	N/A
`Enabledomainstylesheets`	N/A
`Enablelayoutstylesheets`	N/A
`Featuredimage`	N/A
`Featuredimagealttext`	N/A
`Folderid`	N/A
`Footerhtml`	N/A
`Headhtml`	N/A
`Htmltitle`	N/A
`Id`	N/A
`Includedefaultcustomcss`	N/A
`Language`	N/A
`Linkrelcanonicalurl`	N/A
`Mabexperimentid`	N/A
`Metadescription`	N/A
`Name`	N/A
`Pageexpirydate`	N/A
`Pageexpiryenabled`	N/A
`Pageexpiryredirectid`	N/A
`Pageexpiryredirecturl`	N/A
`Pageredirected`	N/A
`Password`	N/A
`Publicaccessrules`	N/A
`Publicaccessrulesenabled`	N/A
`Publishdate`	N/A
`Publishimmediately`	N/A
`Slug`	N/A
`State`	N/A
`Subcategory`	N/A
`Templatepath`	N/A
`Translatedfromid`	N/A
`Updated`	N/A
`Updatedbyid`	N/A
`Url`	N/A
`Usefeaturedimage`	N/A

POST Create a new language variation

/pages/site-pages/multi-language/create-language-variation

Create a new language variation from an existing site page

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	N/A
`Language`	N/A
`Primarylanguage`	N/A

DELETE Delete a Site Page

/pages/site-pages/{objectId}

Delete the Site Page object identified by the id in the path.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Whether to return only results that have been archived.
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Delete a batch of Site Pages

/pages/site-pages/batch/archive

Delete the Site Page objects identified 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.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Detach a site page from a multi-language group

/pages/site-pages/multi-language/detach-from-lang-group

Detach a site page from a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	N/A

POST End an active A/B test

/pages/site-pages/ab-test/end

End an active A/B test and designate a winner.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Abtestid`	N/A
`Winnerid`	N/A

GET Get all Site Pages

/pages/site-pages

Get the list of site 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.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Createdat`	Only return Site Pages created at exactly the specified time.
`Createdafter`	Only return Site Pages created after the specified time.
`Createdbefore`	Only return Site Pages created before the specified time.
`Updatedat`	Only return Site Pages last updated at exactly the specified time.
`Updatedafter`	Only return Site Pages last updated after the specified time.
`Updatedbefore`	Only return Site Pages last updated before the specified time.
`Sort`	Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default.
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Limit`	The maximum number of results to return. Default is 100.
`Archived`	Specifies whether to return deleted Site Pages. Defaults to false.
`Property`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Push Site Page draft edits live

/pages/site-pages/{objectId}/draft/push-live

Take any changes from the draft version of the Site Page and apply them to the live version.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Rerun a previous A/B test

/pages/site-pages/ab-test/rerun

Rerun a previous A/B test.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Abtestid`	N/A
`Variationid`	N/A

POST Reset the Site Page draft to the live version

/pages/site-pages/{objectId}/draft/reset

Discards any edits and resets the draft to the live version.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Restore a previous version of a Site Page

/pages/site-pages/{objectId}/revisions/{revisionId}/restore

Takes a specified version of a Site Page and restores it.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Revisionid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Restore a previous version of a Site Page, to the draft version of the Site Page

/pages/site-pages/{objectId}/revisions/{revisionId}/restore-to-draft

Takes a specified version of a Site Page, sets it as the new draft version of the Site Page.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Revisionid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieve a Site Page

/pages/site-pages/{objectId}

Retrieve the Site Page object identified by the id in the path.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to return deleted Site Pages. Defaults to false.
`Property`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Retrieve a batch of Site Pages

/pages/site-pages/batch/read

Retrieve the Site Page objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to return deleted Site Pages. Defaults to false.
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

GET Retrieve the full draft version of the Site Page

/pages/site-pages/{objectId}/draft

Retrieve the full draft version of the Site Page.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieves a previous version of a Site Page

/pages/site-pages/{objectId}/revisions/{revisionId}

Retrieves a previous version of a Site Page

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Revisionid`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Retrieves all the previous versions of a Site Page

/pages/site-pages/{objectId}/revisions

Retrieves all the previous versions of a Site Page.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Before`	N/A
`Limit`	The maximum number of results to return. Default is 100.
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Schedule a Site Page to be Published

/pages/site-pages/schedule

Schedule a Site Page to be Published

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	N/A
`Publishdate`	N/A

PUT Set a new primary language

/pages/site-pages/multi-language/set-new-lang-primary

Set a site page as the primary language of a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Id`	N/A

PATCH Update a Site Page

/pages/site-pages/{objectId}

Sparse updates a single Site Page object identified by the id in the path.
You only need to specify the column values that you are modifying.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to update deleted Site Pages. Defaults to false.
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (51)

Option Name	Description
`Abstatus`	N/A
`Abtestid`	N/A
`Archivedat`	N/A
`Archivedindashboard`	N/A
`Authorname`	N/A
`Campaign`	N/A
`Categoryid`	N/A
`Contentgroupid`	N/A
`Contenttypecategory`	N/A
`Created`	N/A
`Createdbyid`	N/A
`Currentstate`	N/A
`Currentlypublished`	N/A
`Domain`	N/A
`Dynamicpagedatasourceid`	N/A
`Dynamicpagedatasourcetype`	N/A
`Dynamicpagehubdbtableid`	N/A
`Enabledomainstylesheets`	N/A
`Enablelayoutstylesheets`	N/A
`Featuredimage`	N/A
`Featuredimagealttext`	N/A
`Folderid`	N/A
`Footerhtml`	N/A
`Headhtml`	N/A
`Htmltitle`	N/A
`Id`	N/A
`Includedefaultcustomcss`	N/A
`Language`	N/A
`Linkrelcanonicalurl`	N/A
`Mabexperimentid`	N/A
`Metadescription`	N/A
`Name`	N/A
`Pageexpirydate`	N/A
`Pageexpiryenabled`	N/A
`Pageexpiryredirectid`	N/A
`Pageexpiryredirecturl`	N/A
`Pageredirected`	N/A
`Password`	N/A
`Publicaccessrules`	N/A
`Publicaccessrulesenabled`	N/A
`Publishdate`	N/A
`Publishimmediately`	N/A
`Slug`	N/A
`State`	N/A
`Subcategory`	N/A
`Templatepath`	N/A
`Translatedfromid`	N/A
`Updated`	N/A
`Updatedbyid`	N/A
`Url`	N/A
`Usefeaturedimage`	N/A

PATCH Update a Site Page draft

/pages/site-pages/{objectId}/draft

Sparse updates the draft version of a single Site Page object identified by the id in the path.
You only need to specify the column values that you are modifying.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objectid`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (51)

Option Name	Description
`Abstatus`	N/A
`Abtestid`	N/A
`Archivedat`	N/A
`Archivedindashboard`	N/A
`Authorname`	N/A
`Campaign`	N/A
`Categoryid`	N/A
`Contentgroupid`	N/A
`Contenttypecategory`	N/A
`Created`	N/A
`Createdbyid`	N/A
`Currentstate`	N/A
`Currentlypublished`	N/A
`Domain`	N/A
`Dynamicpagedatasourceid`	N/A
`Dynamicpagedatasourcetype`	N/A
`Dynamicpagehubdbtableid`	N/A
`Enabledomainstylesheets`	N/A
`Enablelayoutstylesheets`	N/A
`Featuredimage`	N/A
`Featuredimagealttext`	N/A
`Folderid`	N/A
`Footerhtml`	N/A
`Headhtml`	N/A
`Htmltitle`	N/A
`Id`	N/A
`Includedefaultcustomcss`	N/A
`Language`	N/A
`Linkrelcanonicalurl`	N/A
`Mabexperimentid`	N/A
`Metadescription`	N/A
`Name`	N/A
`Pageexpirydate`	N/A
`Pageexpiryenabled`	N/A
`Pageexpiryredirectid`	N/A
`Pageexpiryredirecturl`	N/A
`Pageredirected`	N/A
`Password`	N/A
`Publicaccessrules`	N/A
`Publicaccessrulesenabled`	N/A
`Publishdate`	N/A
`Publishimmediately`	N/A
`Slug`	N/A
`State`	N/A
`Subcategory`	N/A
`Templatepath`	N/A
`Translatedfromid`	N/A
`Updated`	N/A
`Updatedbyid`	N/A
`Url`	N/A
`Usefeaturedimage`	N/A

POST Update a batch of Site Pages

/pages/site-pages/batch/update

Update the Site Page objects identified in the request body.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Archived`	Specifies whether to update deleted Site Pages. Defaults to false.
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inputs`	N/A

POST Update languages of multi-language group

/pages/site-pages/multi-language/update-languages

Explicitly set new languages for each site page in a multi-language group.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Primaryid`	N/A

Source_Code_Extract (2)

GET get-/cms/v3/source-code/extract/async/tasks/{task Id}/status get Async Status

/source-code/extract/async/tasks/{taskId}/status

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Taskid`	(Required)
`Accept`	N/A
`Response Type`	N/A

POST post-/cms/v3/source-code/extract/async do Async

/source-code/extract/async

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Path`	N/A

Tables (14)

DELETE Archive a table

/hubdb/tables/{tableIdOrName}

Archive (soft delete) an existing HubDB table. This archives both the published and draft versions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Clone a table

/hubdb/tables/{tableIdOrName}/draft/clone

Clone an existing HubDB table. The newName and newLabel of the new table can be sent as JSON in the body parameter. This will create the cloned table as a draft.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Copyrows`	N/A
`Newname`	N/A
`Newlabel`	N/A
`Ishubspotdefined`	N/A

POST Create a new table

/hubdb/tables

Creates a new draft HubDB table given a JSON schema. The table name and label should be unique for each account.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Label`	N/A
`Name`	N/A
`Useforpages`	N/A
`Allowpublicapiaccess`	N/A
`Allowchildtables`	N/A
`Enablechildtablepages`	N/A

GET Export a draft table

/hubdb/tables/{tableIdOrName}/draft/export

Exports the draft version of a table to CSV / EXCEL format.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Format`	The file format to export. Possible values include CSV, XLSX, and XLS.
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Export a published version of a table

/hubdb/tables/{tableIdOrName}/export

Exports the published version of a table to CSV / EXCEL format.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Format`	The file format to export. Possible values include CSV, XLSX, and XLS.
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get all published tables

/hubdb/tables

Returns the details for the published version of each table defined in an account, including column definitions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Sort`	Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default.
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Limit`	The maximum number of results to return. Default is 1000.
`Createdat`	Only return tables created at exactly the specified time.
`Createdafter`	Only return tables created after the specified time.
`Createdbefore`	Only return tables created before the specified time.
`Updatedat`	Only return tables last updated at exactly the specified time.
`Updatedafter`	Only return tables last updated after the specified time.
`Updatedbefore`	Only return tables last updated before the specified time.
`Archived`	Specifies whether to return archived tables. Defaults to false.
`Contenttype`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get details for a draft table

/hubdb/tables/{tableIdOrName}/draft

Get the details for the draft version of a specific HubDB table. This will include the definitions for the columns in the table and the number of rows in the table.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Includeforeignids`	Set this to true to populate foreign ID values in the result.
`Archived`	Set this to true to return an archived table. Defaults to false.
`Isgetlocalizedschema`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Get details of a published table

/hubdb/tables/{tableIdOrName}

Returns the details for the published version of the specified table. This will include the definitions for the columns in the table and the number of rows in the table.

Note: This endpoint can be accessed without any authentication if the table is set to be allowed for public access.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Includeforeignids`	Set this to true to populate foreign ID values in the result.
`Archived`	Set this to true to return details for an archived table. Defaults to false.
`Isgetlocalizedschema`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Import data into draft table

/hubdb/tables/{tableIdOrName}/draft/import

Import the contents of a CSV file into an existing HubDB table. The data will always be imported into the draft version of the table. Use /publish endpoint to push these changes to published version.
This endpoint takes a multi-part POST request. The first part will be a set of JSON-formatted options for the import and you can specify this with the name as config. The second part will be the CSV file you want to import and you can specify this with the name as file. Refer the overview section to check the details and format of the JSON-formatted options for the import.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tableidorname`	N/A
`Content-type`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Config`	Configuration for the import in JSON format as described above.
`File`	The source CSV file to be imported.

POST Publish a table from draft

/hubdb/tables/{tableIdOrName}/draft/publish

Publishes the table by copying the data and table schema changes from draft version to the published version, meaning any website pages using data from the table will be updated.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Includeforeignids`	Set this to true to populate foreign ID values in the response.
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Reset a draft table

/hubdb/tables/{tableIdOrName}/draft/reset

Replaces the data in the draft version of the table with values from the published version. Any unpublished changes in the draft will be lost after this call is made.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Includeforeignids`	Set this to true to populate foreign ID values in the response.
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

GET Return all draft tables

/hubdb/tables/draft

Returns the details for each draft table defined in the specified account, including column definitions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Sort`	Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default.
`After`	The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.
`Limit`	The maximum number of results to return. Default is 1000.
`Createdat`	Only return tables created at exactly the specified time.
`Createdafter`	Only return tables created after the specified time.
`Createdbefore`	Only return tables created before the specified time.
`Updatedat`	Only return tables last updated at exactly the specified time.
`Updatedafter`	Only return tables last updated after the specified time.
`Updatedbefore`	Only return tables last updated before the specified time.
`Archived`	Specifies whether to return archived tables. Defaults to false.
`Contenttype`	N/A
`Accept`	N/A
`Response Type`	N/A

POST Unpublish a table

/hubdb/tables/{tableIdOrName}/unpublish

Unpublishes the table, meaning any website pages using data from the table will not render any data.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Includeforeignids`	Set this to true to populate foreign ID values in the response.
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

PATCH Update an existing table

/hubdb/tables/{tableIdOrName}/draft

Update an existing HubDB table. You can use this endpoint to add or remove columns to the table as well as restore an archived table. Tables updated using the endpoint will only modify the draft verion of the table. Use publish endpoint to push all the changes to the published version. To restore a table, include the query parameter archived=true and "archived": false in the json body.
Note: You need to include all the columns in the input when you are adding/removing/updating a column. If you do not include an already existing column in the request, it will be deleted.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Includeforeignids`	Set this to true to populate foreign ID values in the result.
`Archived`	Specifies whether to return archived tables. Defaults to false.
`Isgetlocalizedschema`	N/A
`Tableidorname`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Label`	N/A
`Name`	N/A
`Useforpages`	N/A
`Allowpublicapiaccess`	N/A
`Allowchildtables`	N/A
`Enablechildtablepages`	N/A

Validation

POST Validate the contents of a file

/source-code/{environment}/validate/{path}

Validates the file contents passed to the endpoint given a specified path and environment. Accepts multipart/form-data content type.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Environment`	(Required)
`Path`	(Required) The file system location of the file.
`Content-type`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	The file to validate.