Version 1.0
Connector Overview: This page documents all 168 actions for the Hubspotcmsconnector v1.0.
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to attach to the group. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
The unique identifier of the primary blog post in the multi-language group. |
|
|
The language code of the primary blog post in the group. |
POST Clone a Blog Post
/blogs/posts/clone
Clone a Blog Post.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
The name to assign to the cloned blog post. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
POST Create a new Blog Post
/blogs/posts
Create a new Blog Post.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (55)
|
Option Name |
Description |
|---|---|
|
|
Status of an A/B test for this blog post. |
|
|
Identifier of the A/B test this post belongs to. |
|
|
Timestamp when the blog post was archived. |
|
|
Whether the post is archived in the dashboard view. |
|
|
Display name of the post's author. |
|
|
Internal ID of the blog author. |
|
|
Marketing campaign associated with the post. |
|
|
ID of the blog category for the post. |
|
|
ID of the content group this post belongs to. |
|
|
Category of content type for the post. |
|
|
Timestamp when the blog post was created. |
|
|
ID of the user who created the post. |
|
|
Current workflow state of the blog post. |
|
|
Whether the post is currently published. |
|
|
Domain on which the blog post is hosted. |
|
|
ID of the data source for a dynamic page. |
|
|
Type of data source for a dynamic page. |
|
|
HubDB table ID for a dynamic page. |
|
|
Whether to enable domain-level stylesheets. |
|
|
Whether to override Google AMP output. |
|
|
Whether to enable layout-level stylesheets. |
|
|
URL of the featured image for the post. |
|
|
Alt text for the featured image. |
|
|
ID of the folder containing the post. |
|
|
Custom HTML to include in the page footer. |
|
|
Custom HTML to include in the page head. |
|
|
HTML title tag content for the post. |
|
|
The unique identifier of the blog post to clone. |
|
|
Whether to include default custom CSS. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
Canonical URL for the post. |
|
|
Identifier for a multi-armed bandit experiment. |
|
|
Meta description for the post. |
|
|
Name or title of the blog post. |
|
|
Date when the page expires. |
|
|
Whether page expiry is enabled. |
|
|
ID of the redirect page after expiry. |
|
|
URL to redirect to after expiry. |
|
|
Password required to access the post. |
|
|
Main body content of the blog post. |
|
|
Summary or excerpt of the post. |
|
|
Array of public access rules for the post. |
|
|
Whether public access rules are enabled. |
|
|
Date and time when the post is scheduled to be published. |
|
|
Whether to publish the post immediately. |
|
|
RSS feed body content for the post. |
|
|
RSS feed summary for the post. |
|
|
URL slug for the blog post. |
|
|
Workflow state of the post (e.g., DRAFT, PUBLISHED). |
|
|
Array of tag IDs associated with the post. |
|
|
ID of the original post this is a translation of. |
|
|
Timestamp when the post was last updated. |
|
|
ID of the user who last updated the post. |
|
|
Full URL of the blog post. |
|
|
Whether to use the featured image in the post. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
The language code (e.g., "en") for the blog post being attached. |
DELETE Delete a Blog Post
/blogs/posts/{objectId}
Delete the Blog Post object identified by the id in the path.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Whether to return only results that have been archived. |
|
|
The unique identifier of the blog post to delete. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to archive. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Only return Blog Posts created at exactly the specified time. |
|
|
Only return Blog Posts created after the specified time. |
|
|
Only return Blog Posts created before the specified time. |
|
|
Only return Blog Posts last updated at exactly the specified time. |
|
|
Only return Blog Posts last updated after the specified time. |
|
|
Only return Blog Posts last updated before the specified time. |
|
|
Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default. |
|
|
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. |
|
|
The maximum number of results to return. Default is 20. |
|
|
Specifies whether to return deleted Blog Posts. Defaults to false. |
|
|
Specifies which property or properties to include in the response for each blog post. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose draft should be published. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose draft should be reset. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision will be restored. |
|
|
The unique identifier of the previous revision to restore as the live version. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose draft will receive the revision content. |
|
|
The unique identifier of the previous revision to restore into the draft. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Blog Post
/blogs/posts/{objectId}
Retrieve the Blog Post object identified by the id in the path.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to return deleted Blog Posts. Defaults to false. |
|
|
Specifies which property or properties to include in the response for the blog post. |
|
|
The unique identifier of the blog post to retrieve. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to return deleted Blog Posts. Defaults to false. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose draft version to retrieve. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision to retrieve. |
|
|
The unique identifier of the previous revision to fetch. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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. |
|
|
A timestamp string (in ISO 8601 format) used to limit the revisions returned to those created before that date. |
|
|
The maximum number of results to return. Default is 100. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
POST Schedule a Blog Post to be Published
/blogs/posts/schedule
Schedule a Blog Post to be Published.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
Date and time when the post is scheduled to be published. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to update deleted Blog Posts. Defaults to false. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (55)
|
Option Name |
Description |
|---|---|
|
|
Status of an A/B test for this blog post. |
|
|
Identifier of the A/B test this post belongs to. |
|
|
Timestamp when the blog post was archived. |
|
|
Whether the post is archived in the dashboard view. |
|
|
Display name of the post's author. |
|
|
Internal ID of the blog author. |
|
|
Marketing campaign associated with the post. |
|
|
ID of the blog category for the post. |
|
|
ID of the content group this post belongs to. |
|
|
Category of content type for the post. |
|
|
Timestamp when the blog post was created. |
|
|
ID of the user who created the post. |
|
|
Current workflow state of the blog post. |
|
|
Whether the post is currently published. |
|
|
Domain on which the blog post is hosted. |
|
|
ID of the data source for a dynamic page. |
|
|
Type of data source for a dynamic page. |
|
|
HubDB table ID for a dynamic page. |
|
|
Whether to enable domain-level stylesheets. |
|
|
Whether to override Google AMP output. |
|
|
Whether to enable layout-level stylesheets. |
|
|
URL of the featured image for the post. |
|
|
Alt text for the featured image. |
|
|
ID of the folder containing the post. |
|
|
Custom HTML to include in the page footer. |
|
|
Custom HTML to include in the page head. |
|
|
HTML title tag content for the post. |
|
|
The unique identifier of the blog post to clone. |
|
|
Whether to include default custom CSS. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
Canonical URL for the post. |
|
|
Identifier for a multi-armed bandit experiment. |
|
|
Meta description for the post. |
|
|
Name or title of the blog post. |
|
|
Date when the page expires. |
|
|
Whether page expiry is enabled. |
|
|
ID of the redirect page after expiry. |
|
|
URL to redirect to after expiry. |
|
|
Password required to access the post. |
|
|
Main body content of the blog post. |
|
|
Summary or excerpt of the post. |
|
|
Array of public access rules for the post. |
|
|
Whether public access rules are enabled. |
|
|
Date and time when the post is scheduled to be published. |
|
|
Whether to publish the post immediately. |
|
|
RSS feed body content for the post. |
|
|
RSS feed summary for the post. |
|
|
URL slug for the blog post. |
|
|
Workflow state of the post (e.g., DRAFT, PUBLISHED). |
|
|
Array of tag IDs associated with the post. |
|
|
ID of the original post this is a translation of. |
|
|
Timestamp when the post was last updated. |
|
|
ID of the user who last updated the post. |
|
|
Full URL of the blog post. |
|
|
Whether to use the featured image in the post. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (55)
|
Option Name |
Description |
|---|---|
|
|
Status of an A/B test for this blog post. |
|
|
Identifier of the A/B test this post belongs to. |
|
|
Timestamp when the blog post was archived. |
|
|
Whether the post is archived in the dashboard view. |
|
|
Display name of the post's author. |
|
|
Internal ID of the blog author. |
|
|
Marketing campaign associated with the post. |
|
|
ID of the blog category for the post. |
|
|
ID of the content group this post belongs to. |
|
|
Category of content type for the post. |
|
|
Timestamp when the blog post was created. |
|
|
ID of the user who created the post. |
|
|
Current workflow state of the blog post. |
|
|
Whether the post is currently published. |
|
|
Domain on which the blog post is hosted. |
|
|
ID of the data source for a dynamic page. |
|
|
Type of data source for a dynamic page. |
|
|
HubDB table ID for a dynamic page. |
|
|
Whether to enable domain-level stylesheets. |
|
|
Whether to override Google AMP output. |
|
|
Whether to enable layout-level stylesheets. |
|
|
URL of the featured image for the post. |
|
|
Alt text for the featured image. |
|
|
ID of the folder containing the post. |
|
|
Custom HTML to include in the page footer. |
|
|
Custom HTML to include in the page head. |
|
|
HTML title tag content for the post. |
|
|
The unique identifier of the blog post to clone. |
|
|
Whether to include default custom CSS. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
Canonical URL for the post. |
|
|
Identifier for a multi-armed bandit experiment. |
|
|
Meta description for the post. |
|
|
Name or title of the blog post. |
|
|
Date when the page expires. |
|
|
Whether page expiry is enabled. |
|
|
ID of the redirect page after expiry. |
|
|
URL to redirect to after expiry. |
|
|
Password required to access the post. |
|
|
Main body content of the blog post. |
|
|
Summary or excerpt of the post. |
|
|
Array of public access rules for the post. |
|
|
Whether public access rules are enabled. |
|
|
Date and time when the post is scheduled to be published. |
|
|
Whether to publish the post immediately. |
|
|
RSS feed body content for the post. |
|
|
RSS feed summary for the post. |
|
|
URL slug for the blog post. |
|
|
Workflow state of the post (e.g., DRAFT, PUBLISHED). |
|
|
Array of tag IDs associated with the post. |
|
|
ID of the original post this is a translation of. |
|
|
Timestamp when the post was last updated. |
|
|
ID of the user who last updated the post. |
|
|
Full URL of the blog post. |
|
|
Whether to use the featured image in the post. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to update deleted Blog Posts. Defaults to false. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the primary blog post in the multi-language group. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
The unique identifier of the primary blog post in the multi-language group. |
|
|
The language code of the primary blog post in the group. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
The language code of the primary blog post in the group. |
|
|
URL slug for the blog post. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Only return Blogs created at exactly the specified time. |
|
|
Only return Blogs created after the specified time. |
|
|
Only return Blogs created before the specified time. |
|
|
Only return Blogs last updated at exactly the specified time. |
|
|
Only return Blogs last updated after the specified time. |
|
|
Only return Blogs last updated before the specified time. |
|
|
Specifies which fields to use for sorting results. Valid fields are name and id |
|
|
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. |
|
|
The maximum number of results to return. Default is 100. |
|
|
Specifies whether to return archived Blogs. Defaults to false. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Blog
/blog-settings/settings/{blogId}
Retrieve the Blog object identified by the id in the path.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog whose settings should be retrieved. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog whose previous version is being retrieved. |
|
|
The unique identifier of the previous revision to fetch. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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. |
|
|
A timestamp string (in ISO 8601 format) used to limit the revisions returned to those created before that date. |
|
|
The maximum number of results to return. Default is 100. |
|
|
The unique identifier of the blog whose version history should be retrieved. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the primary blog post in the multi-language group. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
The unique identifier of the primary blog post in the multi-language group. |
|
|
The language code of the primary blog post in the group. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
POST Create a new Blog Author
/blogs/authors
Create a new Blog Author.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (17)
|
Option Name |
Description |
|---|---|
|
|
URL for the author's avatar image. |
|
|
Brief biography of the author. |
|
|
Timestamp when the blog post was created. |
|
|
Timestamp indicating when the author was deleted, if applicable. |
|
|
Display name for the author on the blog. |
|
|
Email address of the author. |
|
|
Facebook profile URL of the author. |
|
|
Full name of the author. |
|
|
The unique identifier of the blog post to clone. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
LinkedIn profile URL of the author. |
|
|
Name or title of the blog post. |
|
|
URL slug for the blog post. |
|
|
ID of the original post this is a translation of. |
|
|
Twitter profile URL of the author. |
|
|
Timestamp when the post was last updated. |
|
|
Website URL of the author. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
The language code of the primary blog post in the group. |
DELETE Delete a Blog Author
/blogs/authors/{objectId}
Delete the Blog Author object identified by the id in the path.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Whether to return only results that have been archived. |
|
|
(Required) The Blog Author id. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Only return Blog Authors created at exactly the specified time. |
|
|
Only return Blog Authors created after the specified time. |
|
|
Only return Blog Authors created before the specified time. |
|
|
Only return Blog Authors last updated at exactly the specified time. |
|
|
Only return Blog Authors last updated after the specified time. |
|
|
Only return Blog Authors last updated before the specified time. |
|
|
Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default. |
|
|
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. |
|
|
The maximum number of results to return. Default is 100. |
|
|
Specifies whether to return deleted Blog Authors. Defaults to false. |
|
|
Specifies which property or properties to include in the response for the blog post. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Blog Author
/blogs/authors/{objectId}
Retrieve the Blog Author object identified by the id in the path.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to return deleted Blog Authors. Defaults to false. |
|
|
Specifies which property or properties to include in the response for the blog post. |
|
|
(Required) The Blog Author id. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to return deleted Blog Authors. Defaults to false. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to update deleted Blog Authors. Defaults to false. |
|
|
(Required) The Blog Author id. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (17)
|
Option Name |
Description |
|---|---|
|
|
URL for the author's avatar image. |
|
|
Brief biography of the author. |
|
|
Timestamp when the blog post was created. |
|
|
Timestamp indicating when the author was deleted, if applicable. |
|
|
Display name for the author on the blog. |
|
|
Email address of the author. |
|
|
Facebook profile URL of the author. |
|
|
Full name of the author. |
|
|
The unique identifier of the blog post to clone. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
LinkedIn profile URL of the author. |
|
|
Name or title of the blog post. |
|
|
URL slug for the blog post. |
|
|
ID of the original post this is a translation of. |
|
|
Twitter profile URL of the author. |
|
|
Timestamp when the post was last updated. |
|
|
Website URL of the author. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to update deleted Blog Authors. Defaults to false. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the primary blog post in the multi-language group. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
The unique identifier of the primary blog post in the multi-language group. |
|
|
The language code of the primary blog post in the group. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
POST Create a new Blog Tag
/blogs/tags
Create a new Blog Tag.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Timestamp when the blog post was created. |
|
|
Timestamp indicating when the author was deleted, if applicable. |
|
|
The unique identifier of the blog post to clone. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
Name or title of the blog post. |
|
|
ID of the original post this is a translation of. |
|
|
Timestamp when the post was last updated. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
Name or title of the blog post. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
The language code of the primary blog post in the group. |
DELETE Delete a Blog Tag
/blogs/tags/{objectId}
Delete the Blog Tag object identified by the id in the path.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Whether to return only results that have been archived. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Only return Blog Tags created at exactly the specified time. |
|
|
Only return Blog Tags created after the specified time. |
|
|
Only return Blog Tags created before the specified time. |
|
|
Only return Blog Tags last updated at exactly the specified time. |
|
|
Only return Blog Tags last updated after the specified time. |
|
|
Only return Blog Tags last updated before the specified time. |
|
|
Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default. |
|
|
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. |
|
|
The maximum number of results to return. Default is 100. |
|
|
Specifies whether to return deleted Blog Tags. Defaults to false. |
|
|
Specifies which property or properties to include in the response for the blog post. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Blog Tag
/blogs/tags/{objectId}
Retrieve the Blog Tag object identified by the id in the path.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to return deleted Blog Tags. Defaults to false. |
|
|
Specifies which property or properties to include in the response for the blog post. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to return deleted Blog Tags. Defaults to false. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to update deleted Blog Tags. Defaults to false. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Timestamp when the blog post was created. |
|
|
Timestamp indicating when the author was deleted, if applicable. |
|
|
The unique identifier of the blog post to clone. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
Name or title of the blog post. |
|
|
ID of the original post this is a translation of. |
|
|
Timestamp when the post was last updated. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to update deleted Blog Tags. Defaults to false. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the primary blog post in the multi-language group. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) The environment of the file ("draft" or "published"). |
|
|
(Required) The file system location of the file. |
|
|
Specify the Content-Type header value for the file content. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) The environment of the file ("draft" or "published"). |
|
|
(Required) The file system location of the file. |
|
|
Specify the Content-Type header value for the file content. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) The environment of the file ("draft" or "published"). |
|
|
(Required) The file system location of the file. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) The environment of the file ("draft" or "published"). |
|
|
(Required) The file system location of the file. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Domains (2)
GET List all domains
/domains
Retrieves a list of all domains managed in HubSpot CMS.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID of the domain to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) The file system location of the zip file. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
The unique identifier of the primary blog post in the multi-language group. |
|
|
The language code of the primary blog post in the group. |
POST Clone a Landing Page
/pages/landing-pages/clone
Clone a Landing Page
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
The name to assign to the cloned blog post. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The content ID of the landing page for which the A/B test variation is created. |
|
|
The name to assign to the new A/B test variation. |
POST Create a new Folder
/pages/landing-pages/folders
Create a new Folder
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The category or label to associate with the new folder. |
|
|
Timestamp when the blog post was created. |
|
|
Timestamp indicating when the author was deleted, if applicable. |
|
|
The unique identifier of the blog post to clone. |
|
|
Name or title of the blog post. |
|
|
The ID of the parent folder under which the new folder is created. |
|
|
Timestamp when the post was last updated. |
POST Create a new Landing Page
/pages/landing-pages
Create a new Landing Page
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (51)
|
Option Name |
Description |
|---|---|
|
|
Status of an A/B test for this blog post. |
|
|
Identifier of the A/B test this post belongs to. |
|
|
Timestamp when the blog post was archived. |
|
|
Whether the post is archived in the dashboard view. |
|
|
Display name of the post's author. |
|
|
Marketing campaign associated with the post. |
|
|
ID of the blog category for the post. |
|
|
ID of the content group this post belongs to. |
|
|
Category of content type for the post. |
|
|
Timestamp when the blog post was created. |
|
|
ID of the user who created the post. |
|
|
Current workflow state of the blog post. |
|
|
Whether the post is currently published. |
|
|
Domain on which the blog post is hosted. |
|
|
ID of the data source for a dynamic page. |
|
|
Type of data source for a dynamic page. |
|
|
HubDB table ID for a dynamic page. |
|
|
Whether to enable domain-level stylesheets. |
|
|
Whether to enable layout-level stylesheets. |
|
|
URL of the featured image for the post. |
|
|
Alt text for the featured image. |
|
|
ID of the folder containing the post. |
|
|
Custom HTML to include in the page footer. |
|
|
Custom HTML to include in the page head. |
|
|
HTML title tag content for the post. |
|
|
The unique identifier of the blog post to clone. |
|
|
Whether to include default custom CSS. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
Canonical URL for the post. |
|
|
Identifier for a multi-armed bandit experiment. |
|
|
Meta description for the post. |
|
|
Name or title of the blog post. |
|
|
Date when the page expires. |
|
|
Whether page expiry is enabled. |
|
|
ID of the redirect page after expiry. |
|
|
URL to redirect to after expiry. |
|
|
Specifies a redirect URL for the landing page if a visitor should be redirected elsewhere. |
|
|
Password required to access the post. |
|
|
Array of public access rules for the post. |
|
|
Whether public access rules are enabled. |
|
|
Date and time when the post is scheduled to be published. |
|
|
Whether to publish the post immediately. |
|
|
URL slug for the blog post. |
|
|
Workflow state of the post (e.g., DRAFT, PUBLISHED). |
|
|
Sets the subcategory under which the landing page is organized. |
|
|
Provides the path to the template file used to render the landing page. |
|
|
ID of the original post this is a translation of. |
|
|
Timestamp when the post was last updated. |
|
|
ID of the user who last updated the post. |
|
|
Full URL of the blog post. |
|
|
Whether to use the featured image in the post. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
The language code of the primary blog post in the group. |
DELETE Delete a Folder
/pages/landing-pages/folders/{objectId}
Delete the Folder object identified by the id in the path.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Whether to return only results that have been archived. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Whether to return only results that have been archived. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Identifier of the A/B test this post belongs to. |
|
|
The ID of the variation that won the A/B test and should be applied. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Only return Folders created at exactly the specified time. |
|
|
Only return Folders created after the specified time. |
|
|
Only return Folders created before the specified time. |
|
|
Only return Folders last updated at exactly the specified time. |
|
|
Only return Folders last updated after the specified time. |
|
|
Only return Folders last updated before the specified time. |
|
|
Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default. |
|
|
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. |
|
|
The maximum number of results to return. Default is 100. |
|
|
Specifies whether to return deleted Folders. Defaults to false. |
|
|
Specifies which property or properties to include in the response for the blog post. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Only return Landing Pages created at exactly the specified time. |
|
|
Only return Landing Pages created after the specified time. |
|
|
Only return Landing Pages created before the specified time. |
|
|
Only return Landing Pages last updated at exactly the specified time. |
|
|
Only return Landing Pages last updated after the specified time. |
|
|
Only return Landing Pages last updated before the specified time. |
|
|
Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default. |
|
|
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. |
|
|
The maximum number of results to return. Default is 100. |
|
|
Specifies whether to return deleted Landing Pages. Defaults to false. |
|
|
Specifies which property or properties to include in the response for the blog post. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
POST Rerun a previous A/B test
/pages/landing-pages/ab-test/rerun
Rerun a previous A/B test.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Identifier of the A/B test this post belongs to. |
|
|
The ID of the variation to use when rerunning the A/B test. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
The unique identifier of the previous revision to fetch. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
The unique identifier of the previous revision to fetch. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
The unique identifier of the previous revision to fetch. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve a Folder
/pages/landing-pages/folders/{objectId}
Retrieve the Folder object identified by the id in the path.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to return deleted Folders. Defaults to false. |
|
|
Specifies which property or properties to include in the response for the blog post. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to return deleted Landing Pages. Defaults to false. |
|
|
Specifies which property or properties to include in the response for the blog post. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to return deleted Folders. Defaults to false. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to return deleted Landing Pages. Defaults to false. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
The unique identifier of the previous revision to fetch. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
The unique identifier of the previous revision to fetch. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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. |
|
|
A timestamp string (in ISO 8601 format) used to limit the revisions returned to those created before that date. |
|
|
The maximum number of results to return. Default is 100. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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. |
|
|
A timestamp string (in ISO 8601 format) used to limit the revisions returned to those created before that date. |
|
|
The maximum number of results to return. Default is 100. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
POST Schedule a Landing Page to be Published
/pages/landing-pages/schedule
Schedule a Landing Page to be Published
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
Date and time when the post is scheduled to be published. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to update deleted Folders. Defaults to false. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The category or label to associate with the new folder. |
|
|
Timestamp when the blog post was created. |
|
|
Timestamp indicating when the author was deleted, if applicable. |
|
|
The unique identifier of the blog post to clone. |
|
|
Name or title of the blog post. |
|
|
The ID of the parent folder under which the new folder is created. |
|
|
Timestamp when the post was last updated. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to update deleted Landing Pages. Defaults to false. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (51)
|
Option Name |
Description |
|---|---|
|
|
Status of an A/B test for this blog post. |
|
|
Identifier of the A/B test this post belongs to. |
|
|
Timestamp when the blog post was archived. |
|
|
Whether the post is archived in the dashboard view. |
|
|
Display name of the post's author. |
|
|
Marketing campaign associated with the post. |
|
|
ID of the blog category for the post. |
|
|
ID of the content group this post belongs to. |
|
|
Category of content type for the post. |
|
|
Timestamp when the blog post was created. |
|
|
ID of the user who created the post. |
|
|
Current workflow state of the blog post. |
|
|
Whether the post is currently published. |
|
|
Domain on which the blog post is hosted. |
|
|
ID of the data source for a dynamic page. |
|
|
Type of data source for a dynamic page. |
|
|
HubDB table ID for a dynamic page. |
|
|
Whether to enable domain-level stylesheets. |
|
|
Whether to enable layout-level stylesheets. |
|
|
URL of the featured image for the post. |
|
|
Alt text for the featured image. |
|
|
ID of the folder containing the post. |
|
|
Custom HTML to include in the page footer. |
|
|
Custom HTML to include in the page head. |
|
|
HTML title tag content for the post. |
|
|
The unique identifier of the blog post to clone. |
|
|
Whether to include default custom CSS. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
Canonical URL for the post. |
|
|
Identifier for a multi-armed bandit experiment. |
|
|
Meta description for the post. |
|
|
Name or title of the blog post. |
|
|
Date when the page expires. |
|
|
Whether page expiry is enabled. |
|
|
ID of the redirect page after expiry. |
|
|
URL to redirect to after expiry. |
|
|
Specifies a redirect URL for the landing page if a visitor should be redirected elsewhere. |
|
|
Password required to access the post. |
|
|
Array of public access rules for the post. |
|
|
Whether public access rules are enabled. |
|
|
Date and time when the post is scheduled to be published. |
|
|
Whether to publish the post immediately. |
|
|
URL slug for the blog post. |
|
|
Workflow state of the post (e.g., DRAFT, PUBLISHED). |
|
|
Sets the subcategory under which the landing page is organized. |
|
|
Provides the path to the template file used to render the landing page. |
|
|
ID of the original post this is a translation of. |
|
|
Timestamp when the post was last updated. |
|
|
ID of the user who last updated the post. |
|
|
Full URL of the blog post. |
|
|
Whether to use the featured image in the post. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (51)
|
Option Name |
Description |
|---|---|
|
|
Status of an A/B test for this blog post. |
|
|
Identifier of the A/B test this post belongs to. |
|
|
Timestamp when the blog post was archived. |
|
|
Whether the post is archived in the dashboard view. |
|
|
Display name of the post's author. |
|
|
Marketing campaign associated with the post. |
|
|
ID of the blog category for the post. |
|
|
ID of the content group this post belongs to. |
|
|
Category of content type for the post. |
|
|
Timestamp when the blog post was created. |
|
|
ID of the user who created the post. |
|
|
Current workflow state of the blog post. |
|
|
Whether the post is currently published. |
|
|
Domain on which the blog post is hosted. |
|
|
ID of the data source for a dynamic page. |
|
|
Type of data source for a dynamic page. |
|
|
HubDB table ID for a dynamic page. |
|
|
Whether to enable domain-level stylesheets. |
|
|
Whether to enable layout-level stylesheets. |
|
|
URL of the featured image for the post. |
|
|
Alt text for the featured image. |
|
|
ID of the folder containing the post. |
|
|
Custom HTML to include in the page footer. |
|
|
Custom HTML to include in the page head. |
|
|
HTML title tag content for the post. |
|
|
The unique identifier of the blog post to clone. |
|
|
Whether to include default custom CSS. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
Canonical URL for the post. |
|
|
Identifier for a multi-armed bandit experiment. |
|
|
Meta description for the post. |
|
|
Name or title of the blog post. |
|
|
Date when the page expires. |
|
|
Whether page expiry is enabled. |
|
|
ID of the redirect page after expiry. |
|
|
URL to redirect to after expiry. |
|
|
Specifies a redirect URL for the landing page if a visitor should be redirected elsewhere. |
|
|
Password required to access the post. |
|
|
Array of public access rules for the post. |
|
|
Whether public access rules are enabled. |
|
|
Date and time when the post is scheduled to be published. |
|
|
Whether to publish the post immediately. |
|
|
URL slug for the blog post. |
|
|
Workflow state of the post (e.g., DRAFT, PUBLISHED). |
|
|
Sets the subcategory under which the landing page is organized. |
|
|
Provides the path to the template file used to render the landing page. |
|
|
ID of the original post this is a translation of. |
|
|
Timestamp when the post was last updated. |
|
|
ID of the user who last updated the post. |
|
|
Full URL of the blog post. |
|
|
Whether to use the featured image in the post. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Whether to return only results that have been archived. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to update deleted Landing Pages. Defaults to false. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the primary blog post in the multi-language group. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
A comma-separated list of metadata properties to include in the response. |
|
|
(Required) The environment of the file ("draft" or "published"). |
|
|
(Required) The file system location of the file. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID or name of the HubDB table containing the rows to clone. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID or name of the HubDB table where the rows will be created. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID or name of the HubDB table from which to read rows. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID or name of the HubDB table containing the draft rows to read. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID or name of the HubDB table from which to purge rows. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID or name of the HubDB table whose rows will be replaced. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID or name of the HubDB table whose rows will be updated. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID or name of the HubDB table where the row will be added. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The path for the new row, used to determine the row's URL in dynamic pages. |
|
|
Name or title of the blog post. |
|
|
The ID of a child HubDB table to associate with the new row. |
|
|
The display index value that controls the row's position in the table's default ordering. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The name to assign to the cloned row. |
|
|
The ID or name of the HubDB table containing the row to clone. |
|
|
The numeric ID of the row to clone. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Set to true to include archived rows in the response. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
The numeric ID of the row to retrieve. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Set to true to include archived rows in the response. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
The numeric ID of the row to retrieve. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the column names to sort the results by. See the above description for more details. |
|
|
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. |
|
|
The maximum number of results to return. Default is 1000. |
|
|
Specify the column names to get results containing only the required columns instead of all column details. |
|
|
The zero-based offset from which to start returning rows, used for paginating through large result sets. |
|
|
Set to true to include archived rows in the response. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the column names to sort the results by. |
|
|
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. |
|
|
The maximum number of results to return. Default is 1000. |
|
|
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. |
|
|
The zero-based offset from which to start returning draft rows, used for paginating through large result sets. |
|
|
Set to true to include archived rows in the response. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
The numeric ID of the row to retrieve. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
The numeric ID of the row to retrieve. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The path for the new row, used to determine the row's URL in dynamic pages. |
|
|
Name or title of the blog post. |
|
|
The ID of a child HubDB table to associate with the new row. |
|
|
The display index value that controls the row's position in the table's default ordering. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
The numeric ID of the row to retrieve. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The path for the new row, used to determine the row's URL in dynamic pages. |
|
|
Name or title of the blog post. |
|
|
The ID of a child HubDB table to associate with the new row. |
|
|
The display index value that controls the row's position in the table's default ordering. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
The unique identifier of the primary blog post in the multi-language group. |
|
|
The language code of the primary blog post in the group. |
POST Clone a Site Page
/pages/site-pages/clone
Clone a Site Page
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
The name to assign to the cloned blog post. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The content ID of the landing page for which the A/B test variation is created. |
|
|
The name to assign to the new A/B test variation. |
POST Create a new Site Page
/pages/site-pages
Create a new Site Page
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (51)
|
Option Name |
Description |
|---|---|
|
|
Status of an A/B test for this blog post. |
|
|
Identifier of the A/B test this post belongs to. |
|
|
Timestamp when the blog post was archived. |
|
|
Whether the post is archived in the dashboard view. |
|
|
Display name of the post's author. |
|
|
Marketing campaign associated with the post. |
|
|
ID of the blog category for the post. |
|
|
ID of the content group this post belongs to. |
|
|
Category of content type for the post. |
|
|
Timestamp when the blog post was created. |
|
|
ID of the user who created the post. |
|
|
Current workflow state of the blog post. |
|
|
Whether the post is currently published. |
|
|
Domain on which the blog post is hosted. |
|
|
ID of the data source for a dynamic page. |
|
|
Type of data source for a dynamic page. |
|
|
HubDB table ID for a dynamic page. |
|
|
Whether to enable domain-level stylesheets. |
|
|
Whether to enable layout-level stylesheets. |
|
|
URL of the featured image for the post. |
|
|
Alt text for the featured image. |
|
|
ID of the folder containing the post. |
|
|
Custom HTML to include in the page footer. |
|
|
Custom HTML to include in the page head. |
|
|
HTML title tag content for the post. |
|
|
The unique identifier of the blog post to clone. |
|
|
Whether to include default custom CSS. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
Canonical URL for the post. |
|
|
Identifier for a multi-armed bandit experiment. |
|
|
Meta description for the post. |
|
|
Name or title of the blog post. |
|
|
Date when the page expires. |
|
|
Whether page expiry is enabled. |
|
|
ID of the redirect page after expiry. |
|
|
URL to redirect to after expiry. |
|
|
Specifies a redirect URL for the landing page if a visitor should be redirected elsewhere. |
|
|
Password required to access the post. |
|
|
Array of public access rules for the post. |
|
|
Whether public access rules are enabled. |
|
|
Date and time when the post is scheduled to be published. |
|
|
Whether to publish the post immediately. |
|
|
URL slug for the blog post. |
|
|
Workflow state of the post (e.g., DRAFT, PUBLISHED). |
|
|
Sets the subcategory under which the landing page is organized. |
|
|
Provides the path to the template file used to render the landing page. |
|
|
ID of the original post this is a translation of. |
|
|
Timestamp when the post was last updated. |
|
|
ID of the user who last updated the post. |
|
|
Full URL of the blog post. |
|
|
Whether to use the featured image in the post. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
The language code of the primary blog post in the group. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Whether to return only results that have been archived. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Identifier of the A/B test this post belongs to. |
|
|
The ID of the variation that won the A/B test and should be applied. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Only return Site Pages created at exactly the specified time. |
|
|
Only return Site Pages created after the specified time. |
|
|
Only return Site Pages created before the specified time. |
|
|
Only return Site Pages last updated at exactly the specified time. |
|
|
Only return Site Pages last updated after the specified time. |
|
|
Only return Site Pages last updated before the specified time. |
|
|
Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default. |
|
|
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. |
|
|
The maximum number of results to return. Default is 100. |
|
|
Specifies whether to return deleted Site Pages. Defaults to false. |
|
|
Specifies which property or properties to include in the response for the blog post. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
POST Rerun a previous A/B test
/pages/site-pages/ab-test/rerun
Rerun a previous A/B test.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Identifier of the A/B test this post belongs to. |
|
|
The ID of the variation to use when rerunning the A/B test. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
The unique identifier of the previous revision to fetch. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
The unique identifier of the previous revision to fetch. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to return deleted Site Pages. Defaults to false. |
|
|
Specifies which property or properties to include in the response for the blog post. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to return deleted Site Pages. Defaults to false. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
The unique identifier of the previous revision to fetch. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
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. |
|
|
A timestamp string (in ISO 8601 format) used to limit the revisions returned to those created before that date. |
|
|
The maximum number of results to return. Default is 100. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
POST Schedule a Site Page to be Published
/pages/site-pages/schedule
Schedule a Site Page to be Published
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
|
|
Date and time when the post is scheduled to be published. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the blog post to clone. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to update deleted Site Pages. Defaults to false. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (51)
|
Option Name |
Description |
|---|---|
|
|
Status of an A/B test for this blog post. |
|
|
Identifier of the A/B test this post belongs to. |
|
|
Timestamp when the blog post was archived. |
|
|
Whether the post is archived in the dashboard view. |
|
|
Display name of the post's author. |
|
|
Marketing campaign associated with the post. |
|
|
ID of the blog category for the post. |
|
|
ID of the content group this post belongs to. |
|
|
Category of content type for the post. |
|
|
Timestamp when the blog post was created. |
|
|
ID of the user who created the post. |
|
|
Current workflow state of the blog post. |
|
|
Whether the post is currently published. |
|
|
Domain on which the blog post is hosted. |
|
|
ID of the data source for a dynamic page. |
|
|
Type of data source for a dynamic page. |
|
|
HubDB table ID for a dynamic page. |
|
|
Whether to enable domain-level stylesheets. |
|
|
Whether to enable layout-level stylesheets. |
|
|
URL of the featured image for the post. |
|
|
Alt text for the featured image. |
|
|
ID of the folder containing the post. |
|
|
Custom HTML to include in the page footer. |
|
|
Custom HTML to include in the page head. |
|
|
HTML title tag content for the post. |
|
|
The unique identifier of the blog post to clone. |
|
|
Whether to include default custom CSS. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
Canonical URL for the post. |
|
|
Identifier for a multi-armed bandit experiment. |
|
|
Meta description for the post. |
|
|
Name or title of the blog post. |
|
|
Date when the page expires. |
|
|
Whether page expiry is enabled. |
|
|
ID of the redirect page after expiry. |
|
|
URL to redirect to after expiry. |
|
|
Specifies a redirect URL for the landing page if a visitor should be redirected elsewhere. |
|
|
Password required to access the post. |
|
|
Array of public access rules for the post. |
|
|
Whether public access rules are enabled. |
|
|
Date and time when the post is scheduled to be published. |
|
|
Whether to publish the post immediately. |
|
|
URL slug for the blog post. |
|
|
Workflow state of the post (e.g., DRAFT, PUBLISHED). |
|
|
Sets the subcategory under which the landing page is organized. |
|
|
Provides the path to the template file used to render the landing page. |
|
|
ID of the original post this is a translation of. |
|
|
Timestamp when the post was last updated. |
|
|
ID of the user who last updated the post. |
|
|
Full URL of the blog post. |
|
|
Whether to use the featured image in the post. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the blog post whose revision history to list. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (51)
|
Option Name |
Description |
|---|---|
|
|
Status of an A/B test for this blog post. |
|
|
Identifier of the A/B test this post belongs to. |
|
|
Timestamp when the blog post was archived. |
|
|
Whether the post is archived in the dashboard view. |
|
|
Display name of the post's author. |
|
|
Marketing campaign associated with the post. |
|
|
ID of the blog category for the post. |
|
|
ID of the content group this post belongs to. |
|
|
Category of content type for the post. |
|
|
Timestamp when the blog post was created. |
|
|
ID of the user who created the post. |
|
|
Current workflow state of the blog post. |
|
|
Whether the post is currently published. |
|
|
Domain on which the blog post is hosted. |
|
|
ID of the data source for a dynamic page. |
|
|
Type of data source for a dynamic page. |
|
|
HubDB table ID for a dynamic page. |
|
|
Whether to enable domain-level stylesheets. |
|
|
Whether to enable layout-level stylesheets. |
|
|
URL of the featured image for the post. |
|
|
Alt text for the featured image. |
|
|
ID of the folder containing the post. |
|
|
Custom HTML to include in the page footer. |
|
|
Custom HTML to include in the page head. |
|
|
HTML title tag content for the post. |
|
|
The unique identifier of the blog post to clone. |
|
|
Whether to include default custom CSS. |
|
|
The language code (e.g., "en") for the blog post being attached. |
|
|
Canonical URL for the post. |
|
|
Identifier for a multi-armed bandit experiment. |
|
|
Meta description for the post. |
|
|
Name or title of the blog post. |
|
|
Date when the page expires. |
|
|
Whether page expiry is enabled. |
|
|
ID of the redirect page after expiry. |
|
|
URL to redirect to after expiry. |
|
|
Specifies a redirect URL for the landing page if a visitor should be redirected elsewhere. |
|
|
Password required to access the post. |
|
|
Array of public access rules for the post. |
|
|
Whether public access rules are enabled. |
|
|
Date and time when the post is scheduled to be published. |
|
|
Whether to publish the post immediately. |
|
|
URL slug for the blog post. |
|
|
Workflow state of the post (e.g., DRAFT, PUBLISHED). |
|
|
Sets the subcategory under which the landing page is organized. |
|
|
Provides the path to the template file used to render the landing page. |
|
|
ID of the original post this is a translation of. |
|
|
Timestamp when the post was last updated. |
|
|
ID of the user who last updated the post. |
|
|
Full URL of the blog post. |
|
|
Whether to use the featured image in the post. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies whether to update deleted Site Pages. Defaults to false. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
An array of objects containing the identifiers of the blog posts to retrieve. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the primary blog post in the multi-language group. |
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
Retrieve the status of an asynchronous source code extraction task by its task ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
POST post-/cms/v3/source-code/extract/async do Async
/source-code/extract/async
Initiate an asynchronous extraction of source code from the CMS.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The path for the new row, used to determine the row's URL in dynamic pages. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Whether to copy the rows from the original table into the clone; expects a boolean string. |
|
|
The new internal name for the cloned table; expects a string. |
|
|
The new display label for the cloned table; expects a string. |
|
|
Whether the cloned table is HubSpot-defined; expects a boolean string. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The display label for the new table; expects a string. |
|
|
Name or title of the blog post. |
|
|
Whether the table can be used for dynamic pages; expects a boolean string. |
|
|
Whether the table allows public API access; expects a boolean string. |
|
|
Whether the table allows child tables; expects a boolean string. |
|
|
Whether child tables can have their own pages; expects a boolean string. |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The file format to export. Possible values include CSV, XLSX, and XLS. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The file format to export. Possible values include CSV, XLSX, and XLS. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default. |
|
|
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. |
|
|
The maximum number of results to return. Default is 1000. |
|
|
Only return tables created at exactly the specified time. |
|
|
Only return tables created after the specified time. |
|
|
Only return tables created before the specified time. |
|
|
Only return tables last updated at exactly the specified time. |
|
|
Only return tables last updated after the specified time. |
|
|
Only return tables last updated before the specified time. |
|
|
Specifies whether to return archived tables. Defaults to false. |
|
|
The content type to filter tables by; expects a string. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Set this to true to populate foreign ID values in the result. |
|
|
Set this to true to return an archived table. Defaults to false. |
|
|
Whether to return the localized schema of the table; expects a boolean string. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Set this to true to populate foreign ID values in the result. |
|
|
Set this to true to return details for an archived table. Defaults to false. |
|
|
Whether to return the localized schema of the table; expects a boolean string. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
Specify the Content-Type header value for the file content. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Configuration for the import in JSON format as described above. |
|
|
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Set this to true to populate foreign ID values in the response. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Set this to true to populate foreign ID values in the response. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default. |
|
|
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. |
|
|
The maximum number of results to return. Default is 1000. |
|
|
Only return tables created at exactly the specified time. |
|
|
Only return tables created after the specified time. |
|
|
Only return tables created before the specified time. |
|
|
Only return tables last updated at exactly the specified time. |
|
|
Only return tables last updated after the specified time. |
|
|
Only return tables last updated before the specified time. |
|
|
Specifies whether to return archived tables. Defaults to false. |
|
|
The content type to filter tables by; expects a string. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Set this to true to populate foreign ID values in the response. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Set this to true to populate foreign ID values in the result. |
|
|
Specifies whether to return archived tables. Defaults to false. |
|
|
Whether to return the localized schema of the table; expects a boolean string. |
|
|
The ID or name of the HubDB table containing the row. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The display label for the new table; expects a string. |
|
|
Name or title of the blog post. |
|
|
Whether the table can be used for dynamic pages; expects a boolean string. |
|
|
Whether the table allows public API access; expects a boolean string. |
|
|
Whether the table allows child tables; expects a boolean string. |
|
|
Whether child tables can have their own pages; expects a boolean string. |
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 |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(Required) |
|
|
(Required) The file system location of the file. |
|
|
Specify the Content-Type header value for the file content. |
|
|
Specifies the content type expected in the response, typically "application/json". |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The file to validate. |