HubSpot CMS API

Add a new row to a HubDB draft table. Use this tool to add a new row to the draft version of a HubDB table. To make these changes live, publish the table afterwards. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Archive multiple blog tags in HubSpot CMS. Use this tool to delete multiple blog tag objects in HubSpot CMS by providing their identifiers. Suitable for cleaning up unused or obsolete tags in batches.

Archive a HubDB table in HubSpot CMS. Use this tool to archive (soft delete) an existing HubDB table in HubSpot CMS, affecting both published and draft versions.

Attach a Blog Author to a multi-language group. Use this tool to link a specific blog author with a multi-language group in HubSpot CMS. This action helps manage authors across different language variations of your blog.

Attach a blog post to a multi-language group in HubSpot CMS. Use this tool to attach a specific blog post to a multi-language group in HubSpot CMS, enabling content localization and management.

Attach a blog to a multi-language group in HubSpot CMS. Use this tool to attach a blog to a specified multi-language group within HubSpot CMS. It is helpful when managing blogs in different languages and ensuring they are correctly grouped.

Attach a landing page to a multi-language group. Use this tool to associate a landing page with an existing multi-language group, enabling better management of language variations within HubSpot CMS.

Attach a site page to a multi-language group. Use this tool to attach a specific site page to an existing multi-language group, enabling multi-language support for that page.

Attach a blog tag to a multi-language group. Use this tool to connect a specific blog tag to a designated multi-language group within HubSpot CMS. This is useful for managing tags across different language versions of a blog.

Update multiple draft table rows in HubSpot CMS. This tool updates up to 100 rows in the draft version of a specified HubSpot CMS table. Use it when you need to apply changes to several rows at once in a draft table. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Retrieve the current status of a source-code extraction task. Use this tool to check the status of a specific source-code extraction by providing the `taskId`. It's useful for tracking the progress of an extraction after initiating it with the `extract/async` request.

Creates a copy of an existing blog post. This tool clones an existing blog post, creating a new copy with the same content. It should be used when you want to duplicate a post for editing or reuse.

Clone rows in a draft HubDB table by row IDs. Use this tool to clone specific rows in the draft version of a HubDB table by providing up to 100 row IDs. Useful for duplicating data entries during content management in HubSpot's CMS. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Clone a single row in a HubDB draft table. Use this tool to clone a specific row in the draft version of a HubDB table within HubSpot CMS. This is helpful for duplicating draft content before finalizing changes.

Clone an existing HubDB table as a draft. Use this tool to create a draft clone of an existing HubDB table. The new table's name and label can be specified.

Clone a landing page in HubSpot CMS. This tool duplicates an existing landing page within HubSpot's CMS. It should be used when you need an exact replica of a landing page for further customization or testing.

Clone an existing site page in HubSpot CMS. This tool is used to clone an existing site page within the HubSpot CMS. It is useful when duplicating pages for updates or creating similar content quickly.

Create a new A/B test variation in HubSpot CMS. This tool allows you to create a new A/B test variation for a landing page using HubSpot CMS. It should be called when you need to perform A/B testing by generating different page variations to assess their performance.

Log viewer's attention span details for media events. This tool creates an event recording viewer attention span details for media, which helps in tracking engagement and interaction levels. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create multiple blog posts in a single request. This tool is used to create a batch of blog posts by specifying their content in the request body. It should be called when you need to publish multiple blog posts at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a new Blog Author in HubSpot CMS. Use this tool to create a new blog author within the HubSpot CMS. It should be called when you need to add an author to your blog system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a language variation for a blog author. This tool creates a new language variation from an existing blog author in HubSpot CMS, allowing for multilingual content management. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create multiple blog authors in a single batch request. This tool creates multiple Blog Author objects based on the provided request details. It's useful for adding several blog authors at once to the HubSpot CMS. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a language variation for a blog in HubSpot CMS. This tool allows you to create a new language variation for an existing blog using HubSpot CMS's multi-language settings. Use it when you need to support multiple languages for a blog.

Create a new blog post with specified content. Use this tool to create a new blog post by specifying its content in the request. Ideal for automating blog publishing processes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a new blog tag in HubSpot CMS. This tool creates a new tag for a blog in the HubSpot CMS. It should be called when there's a need to categorize or organize content within the blog by creating new tags.

Create a new language variation from an existing blog tag. Use this tool to create a language variation for an existing blog tag on HubSpot CMS. Call this tool when you need to support multiple languages for blog tags.

Create multiple blog tags in a single request. This tool is used to create multiple blog tag objects as specified in the request body. Call this tool when you need to add several blog tags at once to a HubSpot CMS blog. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create draft rows in a specified HubSpot table. This tool is used to add multiple rows to the draft version of a specified HubSpot CMS table. It allows for up to 100 rows to be created in one call. Useful for updating content drafts before publication. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a new draft HubDB table with a unique name and label. This tool creates a new draft HubDB table using a provided JSON schema. It requires that the table name and label be unique within each account. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a new landing page in HubSpot. Use this tool to create a new landing page on HubSpot. Suitable for automating marketing or content management tasks. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a new folder in HubSpot CMS for landing pages. This tool is used to create a new folder within the landing pages section of HubSpot CMS. Call this tool when you need to organize landing pages into a new folder structure.

Create multiple landing page folders in HubSpot CMS. Use this tool to create multiple folder objects for landing pages in HubSpot CMS as specified in the request details. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create multiple landing pages in HubSpot CMS. Use this tool to create a batch of new landing pages in HubSpot CMS by providing the necessary details in the request body. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a new language variation for a site page. Use this tool to create a new language variation from an existing site page in HubSpot CMS. It helps in managing multilingual content efficiently by generating a language-specific page version.

Log an event when media playback starts. Call this tool when you need to create an event for when a user begins playing a piece of media. It helps track media interactions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create a new language variation for a landing page. This tool creates a new language variation from an existing landing page in HubSpot CMS. Use it to generate multilingual versions of your landing pages.

Create a new site page in HubSpot CMS. This tool is used to create a new site page in HubSpot CMS. It should be called when a user wants to add a new page to their website using the HubSpot platform. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Create multiple site page objects in batch. Use this tool to create multiple site page objects at once based on the details provided in the request body. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Creates and configures a new URL redirect in HubSpot CMS. Use this tool to create and set up a new URL redirect within the HubSpot CMS. Ideal for managing website redirects effectively.

Delete a specific blog author by ID. Use this tool to delete a blog author from the HubSpot CMS by providing their ID. It should be called when you need to remove an author from the system.

Delete specified blog authors in HubSpot CMS. Use this tool to delete the Blog Author objects identified in the request body from HubSpot CMS.

Delete a blog post by its unique ID. Use this tool to delete a blog post using its ID. Note that this action permanently removes the post, unlike the in-app archive function. For dashboard archiving, use an update with `archivedInDashboard` set to `true`.

Delete a specified Blog Tag in HubSpot CMS. Use this tool to delete a specific Blog Tag in the HubSpot CMS by providing the object's ID. This is useful for managing and organizing blog content within the CMS.

Delete specified Site Page objects in the CMS. This tool deletes the Site Page objects specified in the request body on the HubSpot CMS. It is used when you need to remove multiple site pages at once. This operation is different from archiving in the dashboard.

Permanently delete a row from a HubDB draft table. Use this tool to permanently delete a specified row from the draft version of a HubDB table in HubSpot CMS. Call this tool when you need to remove a row that is no longer needed in the draft.

Deletes a file in a specified CMS environment. Use this tool to delete a file located at a specific path within a designated CMS environment. It's useful for managing and organizing source code by removing unnecessary or outdated files.

Delete a specified landing page by its ID. Use this tool to delete a landing page in HubSpot CMS by providing the landing page's ID.

Deletes a CMS landing page folder by ID. Use this tool to delete a specific CMS landing page folder by providing its object ID. The tool sends a DELETE request to remove the folder.

Delete specified landing page folders in HubSpot CMS. Use this tool to delete landing page folders in the HubSpot CMS as specified in the request. It should be called when you need to remove these folders from the CMS.

Deletes specified HubSpot landing pages permanently. Use this tool to permanently delete landing page objects in HubSpot CMS. It's different from archiving pages via the dashboard. Ensure you provide the specific page identifiers in the request body.

Delete a specified site page in HubSpot CMS. Use this tool to delete a specific site page in HubSpot CMS by providing the page's object ID. This should be called when a page needs to be archived or removed permanently.

Delete a specific version of a HubDB table. This tool deletes a specified version of a table in HubSpot CMS HubDB. It should be called when you need to remove an obsolete or incorrect version of a table. Make sure to specify the correct table and version identifiers.

Deletes an existing URL redirect in HubSpot CMS. Utilize this tool to delete a specific URL redirect within the HubSpot CMS system. This should be called when you need to remove a redirect mapping from the system.

Detach a Blog Author from a multi-language group. Use this tool to remove a blog author from an existing multi-language group in HubSpot CMS. Call this when authors need to be unlinked from specific language variations.

Detach a blog from its multi-language group. Use this tool to separate a blog from its associated multi-language group settings in HubSpot CMS.

Detach a blog post from a multi-language group. Use this tool to detach a specific blog post from its associated multi-language group in HubSpot CMS. Useful when you need to separately manage or remove language-specific versions of a post.

Detach a Blog Tag from a multi-language group. Use this tool to remove a blog tag from its association with a multi-language group in HubSpot CMS. This can be useful when restructuring tags or changing their multi-language settings.

Detach a landing page from a multi-language group. Call this tool to detach a specific landing page from its multi-language group in HubSpot CMS. Useful for managing language-specific versions of pages individually.

Detach a site page from a multi-language group. Use this tool to detach a site page from its current multi-language group when language-specific customization is needed.

Download file content from HubSpot CMS by path and environment. Use this tool to download the byte contents of a file stored in HubSpot CMS. Specify the environment and path to retrieve the desired file content.

End an active A/B test and designate a winner. Use this tool to end an ongoing A/B test for landing pages and select the winning variant. Ideal for finalizing tests and applying successful strategies.

End an active A/B test and designate a winner. Use this tool to conclude an ongoing A/B test and specify the winning variant on the HubSpot CMS.

Export HubDB draft table to CSV or Excel format. Use this tool to export the draft version of a HubDB table in HubSpot CMS to a CSV or Excel file. Call this tool when you need to download table data for review or offline use.

Exports a HubDB table in the desired format. Use this tool to export the published version of a HubDB table by specifying the table ID or name. It allows exporting in various formats.

Initiate asynchronous extraction of a zip file on HubSpot CMS. This tool initiates the extraction of a zip file in the developer file system asynchronously. This is useful for handling large files or files that need processing without blocking operations. Use this tool when you need to start a zip file extraction and check its status later through the appropriate status endpoint.

Fetch rows from a HubDB table using filters and sorting. Use this tool to fetch rows from a specific HubDB table. You can apply filters and sorting by using query parameters, allowing retrieval of customized data sets. No authentication is needed if the table allows public access.

Retrieve all URL redirects with optional filters. Use this tool to access a list of all existing URL redirects in the HubSpot CMS. You can apply filters based on creation or updated date to narrow down the results.

Retrieve details of all draft HubDB tables. Returns information on all draft tables in a specified HubSpot account, including column definitions.

Retrieve details of all published HubDB tables. This tool returns the details and column definitions for all published HubDB tables in a HubSpot account. It is useful when you need an overview of the schema and data of all tables within your CMS environment.

Retrieve blog author details using an object ID. This tool fetches details of a blog author from HubSpot CMS using the specified object ID. It should be called when specific information about a blog author is needed.

Retrieve the list of blog authors. Use this tool to get a list of blog authors for integration, with support for paging and filtering. Useful for examining authors to suggest edits via external services.

Retrieve the full draft version of a blog post. Use this tool to get the draft version of a specific blog post by providing the post's object ID.

Retrieve the revision history of blog settings. This tool retrieves the historical revisions for the settings of a specified blog, providing insights into past configurations.

Fetch blog settings using a blog ID. This tool retrieves the settings for a blog identified by the provided blog ID from the HubSpot CMS. It should be called when specific details or configurations of a blog are needed.

Retrieve a list of blog tags with paging and filtering options. This tool fetches the list of blog tags, supporting paging and filtering. It is useful for integrations that need to access blog tags for analysis or editing suggestions.

Retrieve domain details by ID from HubSpot CMS. This tool retrieves detailed information about a specific domain using the provided domain ID from the HubSpot CMS.

Retrieve rows from a draft HubDB table with optional filtering. This tool fetches rows from the draft version of a specified HubDB table. It allows for filtering and sorting rows based on query parameters, helping to access only relevant data.

Retrieve details of a draft HubDB table by ID or name. Use this tool to get information about the draft version of a specific HubDB table, including column definitions and row count.

Retrieve a single draft row by ID from a HubDB table. This tool fetches a specific row's draft version from a HubDB table using the row ID. It should be called when a user needs to access draft data for a specific table row by ID or name.

Retrieve all existing domains in the CMS. Fetches a list of all domains that have been created in the CMS, with optional filters by creation or update date.

Retrieve metadata for a file in a specified environment. Use this tool to obtain the metadata object for a file located at a specified path within a designated environment in the HubSpot CMS.

Fetch draft rows from a specified HubDB table. Use this tool to retrieve rows from the draft version of a specified HubDB table using a set of row IDs.

Get details of a HubDB table, including columns and row count. Use this tool to obtain comprehensive details about a specific HubDB table. It returns column definitions and the number of rows for the published version of the table. Accessible without authentication if the table is publicly available; requires HubSpot account ID in `portalId` query parameter.

Retrieve details of a specific landing page by ID. Use this tool to fetch the details of a landing page from HubSpot CMS by providing the landing page's unique ID.

Retrieve the full draft version of a landing page. Use this tool to get the complete draft version of a landing page by providing its object ID. Ideal for viewing or editing drafts before publishing.

Retrieve details of a landing page folder by its ID. Use this tool to get information about a specific landing page folder in HubSpot CMS by providing its unique ID.

Retrieve the list of landing page folders from HubSpot CMS. This tool fetches the list of landing page folders in HubSpot CMS, supporting paging and filtering. Useful for integrations needing to analyze these models or suggest edits via external services.

Retrieve previous versions of a Landing Page for review. Use this tool to obtain all previous versions of a specified Landing Page, allowing you to track changes or restore versions if needed.

Retrieve a list of HubSpot CMS landing pages. This tool retrieves a list of landing pages from HubSpot CMS, supporting paging and filtering. Ideal for integrations that analyze page models and suggest edits.

Retrieve all previous versions of a blog post in HubSpot. Call this tool to access historical versions of a specific blog post using its 'objectId' in HubSpot CMS.

Retrieve previous versions of a CMS folder. This tool retrieves all previous versions of a specified folder from the CMS. It should be called when there's a need to access or analyze the revision history of a folder.

Retrieve previous versions of a site page. Use this tool to access all previous versions of a specific site page in HubSpot's CMS. It's helpful for tracking changes or restoring an older version.

Retrieve the full draft version of the Site Page. Use this tool to get the complete draft version of a specific site page by providing the page's object ID. It should be called when you need to access or review the draft content of a site page in HubSpot CMS.

Retrieve a list of site pages with filtering options. Use this tool to get a list of site pages, supporting both paging and filtering. Ideal for integrations that need to examine pages or use external services to suggest edits.

Get a single row from a HubSpot CMS table by ID. Use this tool to retrieve a specific row from the published version of a HubSpot CMS table by providing the table ID or name and the row ID. This can be done without authentication if the table allows public access.

Retrieve details of a URL redirect by ID. Use this tool to obtain the details of a specific URL redirect by providing its ID. Ideal for managing URL redirects within HubSpot CMS.

Create a new A/B test variation in HubSpot CMS. This tool creates a new A/B test variation for a site page in HubSpot CMS using the provided details.

Create a new language variation from an existing blog post. Use this tool to generate a new language version of an existing blog post on HubSpot CMS. It's useful for expanding the reach of content to different language audiences.