HubspotCmsApi

The HubspotCmsApi MCP Server offers a comprehensive suite of tools for managing content within the HubSpot CMS. Users can efficiently perform actions such as:

• Create, update, and delete blog posts, landing pages, and site pages.
• Manage blog authors and tags, including creating language variations.
• Handle multi-language support for content and manage URL redirects.
• Retrieve detailed information about various content types, including revision histories and settings.

This server streamlines content management processes, making it easier to maintain and optimize your HubSpot CMS environment.

Available Tools

HubspotCmsApi.GetBlogAuthorById

Retrieve blog author details using an object ID.

Parameters

• blog_author_id (string, required) The unique identifier for the blog author to retrieve their details.
• include_deleted_blog_authors (boolean, optional) Set to true to include deleted blog authors in the results. Defaults to false.
• specific_author_property (string, optional) Specify a property to retrieve specific details about the blog author, such as a specific attribute or field.

HubspotCmsApi.DeleteBlogAuthor

Delete a specific blog author by ID.

Parameters

• blog_author_id (string, required) The unique identifier of the Blog Author to be deleted.
• return_archived_only (boolean, optional) Set to true to return only archived blog authors. Use for fetching deleted or inactive authors.

HubspotCmsApi.UpdateBlogAuthor

Update specific details of a blog author.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• blog_author_id (string, optional) The unique ID of the blog author to be updated. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• update_deleted_blog_authors (boolean, optional) Set to true to update deleted Blog Authors. Defaults to false. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.DetachBlogAuthorFromLangGroup

Detach a Blog Author from a multi-language group.

Parameters

• author_id_to_detach (string, required) ID of the blog author to remove from a multi-language group in HubSpot CMS.

HubspotCmsApi.UpdateBlogAuthorsBatch

Update multiple blog author objects at once.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• update_deleted_blog_authors (boolean, optional) Set to true to update deleted Blog Authors. Defaults to false. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.SetPrimaryLanguageBlogAuthor

Set a blog author as the primary language in a multilingual group.

Parameters

• primary_language_author_id (string, required) The ID of the blog author to be set as the primary in a multi-language group.

HubspotCmsApi.DeleteBlogAuthors

Delete specified blog authors in HubSpot CMS.

Parameters

• blog_author_ids (array[string], required) List of blog author IDs to delete from HubSpot CMS.

HubspotCmsApi.CreateBlogAuthorsBatch

Create multiple blog authors in a single batch request.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.RetrieveBlogAuthors

Retrieve specified Blog Author objects from the CMS.

Parameters

• author_identifiers (array[string], required) An array of strings representing the identifiers for the blog authors to retrieve.
• include_deleted_authors (boolean, optional) Specifies whether to include deleted Blog Authors in the results. Set to true to include them.

HubspotCmsApi.GetBlogAuthors

Retrieve the list of blog authors.

Parameters

• created_after (string, optional) Return only blog authors created after this specified timestamp.
• created_at_exact_time (string, optional) Return blog authors created at exactly the specified time. Use ISO 8601 format for timestamps.
• filter_by_creation_before_date (string, optional) Return Blog Authors created before the specified date and time in ISO 8601 format.
• filter_by_last_updated_before (string, optional) Only return blog authors last updated before the specified timestamp. Format: YYYY-MM-DDTHH:MM:SSZ.
• filter_by_updated_after (string, optional) Return Blog Authors updated after a specific time. Use an ISO 8601 datetime string, e.g., ‘2023-01-01T00:00:00Z’.
• include_archived_authors (boolean, optional) Specify true to include archived (deleted) blog authors in the results. Defaults to false.
• included_properties (string, optional) Comma-separated list of specific properties to include in the response for each author. If empty, all properties will be fetched by default.
• pagination_cursor_token (string, optional) The cursor token from paging.next.after to fetch the next set of results.
• result_limit (integer, optional) Maximum number of blog authors to return. Default is 100.
• sort_fields (array[string], optional) Fields for sorting results. Choose from: name, createdAt, updatedAt, createdBy, updatedBy. Default is createdAt.
• updated_at_timestamp (string, optional) Return blog authors last updated at the specified exact time (ISO 8601 format).

HubspotCmsApi.CreateBlogAuthor

Create a new Blog Author in HubSpot CMS.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.AttachAuthorToMultilangGroup

Attach a Blog Author to a multi-language group.

Parameters

• author_object_id (string, required) ID of the blog author to add to a multi-language group in HubSpot CMS.
• designated_language (string, required) The language code of the blog author to be added to a multi-language group, e.g., ‘en’ for English.
• primary_language_object_id (string, required) ID of the primary language object in the multi-language group.
• primary_language (string, optional) Specify the primary language of the multi-language group to which the author will be attached.

HubspotCmsApi.CreateBlogAuthorLanguageVariation

Create a language variation for a blog author.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.UpdateBlogAuthorLanguages

Set new languages for each blog author in a group.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.GetBlogRevisionHistory

Retrieve the revision history of blog settings.

Parameters

• blog_id (string, required) The unique identifier for the blog whose settings history is being retrieved. This is required for querying specific blog settings.
• retrieve_revisions_before_timestamp (string, optional) Retrieve revisions before this timestamp in milliseconds since Unix Epoch.
• revision_limit (integer, optional) The maximum number of blog setting revisions to retrieve. Provide an integer value to restrict the number of results.
• start_date_for_revisions (string, optional) Specify a date to filter revisions that occurred after this date. Format: YYYY-MM-DD.

HubspotCmsApi.UpdateBlogLanguages

Update the languages for blog settings.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.RetrieveBlogRevisionDetails

Retrieve specific blog revision details by ID.

Parameters

• blog_id (string, required) The unique identifier for the blog post. It is required to fetch the specific revision details.
• revision_id (string, required) A unique string identifier for a specific blog revision to be retrieved.

HubspotCmsApi.GetBlogSettings

Fetch blog settings using a blog ID.

Parameters

• blog_id (string, required) The unique identifier of the blog for which you want to fetch the settings. This is required to specify which blog’s details to retrieve.

HubspotCmsApi.CreateBlogLanguageVariation

Create a language variation for a blog in HubSpot CMS.

Parameters

• blog_id (string, required) ID of the blog to clone for creating a language variation.
• blog_slug (string, optional) Path to the blog. Used to specify the location of the language variation within the CMS.
• primary_language (string, optional) Specify the language of the primary blog to clone. This determines the source content for the new language variation.
• target_language_for_blog_variant (string, optional) The language code for the new blog variant, specifying the target language for translation.

HubspotCmsApi.RetrieveBlogSettings

Retrieve current blog settings from the HubSpot CMS.

Parameters

• created_before (string, optional) Retrieve blog settings created before this date. Format as ‘YYYY-MM-DD’.
• created_timestamp (string, optional) The exact timestamp when the blog settings were created, formatted as an ISO 8601 string.
• filter_created_after_date (string, optional) Filter settings to only include blogs created after the specified date (ISO 8601 format).
• include_archived (boolean, optional) Set to true to include archived blog settings and false to exclude them.
• max_number_of_results (integer, optional) The maximum number of blog settings to retrieve. The value should be an integer.
• pagination_cursor (string, optional) A token to retrieve the next set of blog settings after the current page. Use this for paginating results.
• sort_options (array[string], optional) An array specifying fields to sort by, in order of priority (e.g., [‘createdAt’, ‘-updatedAt’] for ascending and descending).
• updated_after_timestamp (string, optional) Fetch settings for blogs updated after this date and time. Use ISO 8601 format.
• updated_at_exact_timestamp (string, optional) Fetch blogs with this exact update timestamp. Use ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
• updated_before_date (string, optional) The latest date (inclusive) to filter blog updates. Provide in ‘YYYY-MM-DD’ format.

HubspotCmsApi.SetNewBlogPrimaryLanguage

Set a new primary language for blogs.

Parameters

• primary_language_object_id (string, required) ID of the blog object to set as primary in the multi-language group.

HubspotCmsApi.DetachBlogFromLanguageGroup

Detach a blog from its multi-language group.

Parameters

• object_id_to_detach (string, required) ID of the blog to remove from its multi-language group in HubSpot CMS.

HubspotCmsApi.AttachBlogToLanguageGroup

Attach a blog to a multi-language group in HubSpot CMS.

Parameters

• designated_language (string, required) The language code of the blog to add to a multi-language group. Use standard language codes like ‘en’, ‘fr’, etc.
• object_id_to_add (string, required) ID of the blog object to be added to a multi-language group in HubSpot CMS.
• primary_language_object_id (string, required) ID of the primary language object in the multi-language group to which the blog will be attached.
• primary_language (string, optional) Primary language code for the multi-language group to which the blog should be attached (e.g., ‘en’, ‘fr’).

HubspotCmsApi.RetrieveAuditLogs

Retrieve audit logs based on specified filters.

Parameters

• event_types (array[string], optional) A list of event types to filter by, such as CREATED, UPDATED, PUBLISHED, DELETED, UNPUBLISHED.
• filter_by_object_ids (array[string], optional) List of object IDs to filter the audit logs by.
• filter_by_object_type (array[string], optional) List the object types to filter audit logs by, such as BLOG, LANDING_PAGE, DOMAIN, etc. Use a comma-separated format.
• number_of_logs_to_return (integer, optional) Specifies the number of audit logs to retrieve.
• sort_direction (array[string], optional) Specify the sort direction for audit logs by timestamp, e.g., ‘asc’ or ‘desc’.
• timestamp_after (string, optional) Timestamp (in ISO 8601 format) after which audit logs will be returned.
• timestamp_before (string, optional) A timestamp to filter audit logs before the specified date and time.
• user_ids_to_filter (array[string], optional) Array of user IDs to filter the audit logs by. Provide as a list of strings.

HubspotCmsApi.GetExistingDomains

Retrieve all existing domains in the CMS.

Parameters

• created_at_date_filter (string, optional) Specify a date to return only domains created on this exact date. Format: YYYY-MM-DD.
• created_before_date (string, optional) Filter to return only domains created before the specified date. Format: YYYY-MM-DD.
• filter_by_update_date (string, optional) Only return domains updated on this specific date. Use ‘YYYY-MM-DD’ format.
• filter_domains_updated_after (string, optional) Return domains updated after this specified date. Use ISO 8601 format (YYYY-MM-DD).
• filter_updated_before_date (string, optional) Return only domains updated before this date in ISO 8601 format (e.g., ‘2023-10-05T00:00:00Z’).
• get_domains_created_after_date (string, optional) Only return domains created after the specified date (in YYYY-MM-DD format).
• maximum_results_per_page (integer, optional) Specifies the maximum number of domain results to return per page.
• paging_cursor_token (string, optional) The paging cursor token of the last successfully read resource, used for paginated results.
• return_archived (boolean, optional) Return only archived domains if true. Return unarchived if false.
• sort_criteria (array[string], optional) Defines the order of the domain results. Provide an array of strings specifying fields to sort by, such as [‘createdAt’, ‘updatedAt’].

HubspotCmsApi.GetDomainById

Retrieve domain details by ID from HubSpot CMS.

Parameters

• domain_id (string, required) The unique ID of the domain to retrieve details for from HubSpot CMS.

HubspotCmsApi.ExportHubdbDraftTable

Export HubDB draft table to CSV or Excel format.

Parameters

• table_id_or_name (string, required) The ID or name of the table to export. Use this to specify the exact table you want to download.
• export_file_format (string, optional) The file format for exporting the draft table. Choose from CSV, XLSX, or XLS.

HubspotCmsApi.GetAllDraftTablesDetails

Retrieve details of all draft HubDB tables.

Parameters

• content_type (string, optional) Specify the content type filter for retrieving draft tables. Leave empty for no filter.
• created_after_date (string, optional) Return tables created after the specified date and time. Format: YYYY-MM-DDTHH:MM:SSZ.
• created_at_exact_time (string, optional) Return tables created at the specified exact time (ISO 8601 format).
• created_before_date (string, optional) Return tables created before this specified time.
• filter_by_updated_before_date (string, optional) Return tables last updated before this specified time in ISO 8601 format.
• include_archived_tables (boolean, optional) Set to true to include archived tables in the results, false by default.
• include_localized_schema (boolean, optional) Indicates whether to include localized schema information for draft tables. Accepts a boolean value.
• maximum_results_limit (integer, optional) Specifies the maximum number of draft table results to return, with a default of 1000.
• pagination_cursor_token (string, optional) Cursor token to fetch the next set of results from a paginated response.
• return_tables_updated_after (string, optional) Only return tables that were last updated after the specified timestamp (ISO 8601 format).
• sort_fields_for_results (array[string], optional) Fields to sort the results by. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. Defaults to createdAt.
• updated_at_specific_time (string, optional) Return tables last updated at the specified exact time.

HubspotCmsApi.GetTableRow

Get a single row from a HubSpot CMS table by ID.

Parameters

• row_id (string, required) The ID of the row to retrieve from the table.
• table_id_or_name (string, required) The ID or name of the HubSpot CMS table to retrieve the row from.
• archived (boolean, optional) A boolean to retrieve archived rows. Set to True to include archived rows, or False to exclude them.

HubspotCmsApi.GetDraftHubdbTableRows

Retrieve rows from a draft HubDB table with optional filtering.

Parameters

• table_id_or_name (string, required) The ID or name of the HubDB table to query for draft rows.
• include_archived_rows (boolean, optional) Specify whether to include archived rows in the results. Use true to include archived rows, false to exclude them.
• maximum_results_limit (integer, optional) Specifies the maximum number of results to return from the draft table. Default is 1000.
• next_page_cursor (string, optional) Cursor token to retrieve the next set of results, from paging.next.after in a paged response.
• result_offset (integer, optional) The number of rows to skip before starting to collect the result set from the draft version of a table.
• sort_columns (array[string], optional) List of column names to sort the results by. Use format like [‘column1’, ‘-column2’] to specify ascending or descending order.
• specified_columns (array[string], optional) Specify the column names to return only these columns in the result, instead of all columns.

HubspotCmsApi.CloneHubdbDraftRow

Clone a single row in a HubDB draft table.

Parameters

• row_id_to_clone (string, required) The ID of the row to be cloned in the draft table.
• table_id_or_name (string, required) The ID or name of the table to be cloned.
• new_row_name (string, optional) The name for the cloned row. Specify a new name if required.

HubspotCmsApi.ResetHubdbDraftToPublished

Reset HubDB draft table to match the published version.

Parameters

• table_identifier (string, required) The ID or name of the HubDB table to reset to the published version.
• include_foreign_ids (boolean, optional) Set to true to populate foreign ID values in the response.

HubspotCmsApi.ExportTableFromHubdb

Exports a HubDB table in the desired format.

Parameters

• hubdb_table_id_or_name (string, required) The ID or name of the HubDB table to export.
• file_format_to_export (string, optional) The file format for exporting the table. Options are CSV, XLSX, and XLS.

HubspotCmsApi.ReplaceDraftTableRows

Batch replace rows in HubSpot CMS draft tables.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• table_identifier (string, optional) The ID or name of the table in which you want to replace draft rows. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.CloneHubdbTable

Clone an existing HubDB table as a draft.

Parameters

• copy_rows (boolean, required) Boolean indicating whether to copy the rows during the cloning process.
• is_hubspot_defined (boolean, required) Indicate if the table is defined by HubSpot. This is a boolean value where true means the table is HubSpot-defined.
• source_table_id_or_name (string, required) The ID or name of the HubDB table to clone.
• new_table_label (string, optional) The label for the new cloned table. Specify a descriptive label for identification.
• new_table_name (string, optional) The desired new name for the cloned HubDB table draft.

HubspotCmsApi.PermanentlyDeleteHubdbDraftRows

Permanently delete draft rows from a HubDB table.

Parameters

• row_ids_to_delete (array[string], required) An array of up to 100 row IDs to permanently delete from the draft version of the table.
• table_id_or_name (string, required) The ID or name of the HubDB table to target for deleting draft rows.

HubspotCmsApi.GetDraftTableRowById

Retrieve a single draft row by ID from a HubDB table.

Parameters

• row_id (string, required) The ID of the row in the table’s draft version to retrieve.
• table_identifier (string, required) The ID or name of the HubDB table to fetch the draft row from.
• include_archived (boolean, optional) Set to true to include archived rows in the search result. Defaults to false.

HubspotCmsApi.ReplaceDraftTableRow

Replace a row in the draft version of a HubDB table.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• table_id_or_name (string, optional) The ID or name of the HubDB table to replace the row in. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• row_id (string, optional) The unique identifier of the row to be replaced in the draft table. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.DeleteDraftTableRowHubspot

Permanently delete a row from a HubDB draft table.

Parameters

• row_id (string, required) The unique ID of the row to be permanently deleted from the draft version of the HubDB table.
• table_id_or_name (string, required) The ID or name of the HubDB table from which the draft row will be deleted.

HubspotCmsApi.UpdateHubdbRowDraft

Update specific fields in a HubDB table’s draft row.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• table_identifier (string, optional) The ID or name of the HubDB table to update the draft row in. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• row_id (string, optional) The unique ID of the row to be updated in the draft table. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.FetchHubdbTableRows

Fetch rows from a HubDB table using filters and sorting.

Parameters

• table_identifier (string, required) The ID or name of the HubDB table to query for fetching row data.
• include_archived_rows (boolean, optional) Set to true to include archived rows in the results; false to exclude them.
• maximum_results_limit (integer, optional) Specifies the maximum number of results to return. The default value is 1000, which can be adjusted to retrieve fewer entries.
• pagination_cursor_token (string, optional) Cursor token to fetch the next set of results. Obtainable from the paging.next.after of a paged response.
• requested_columns (array[string], optional) Specify column names to retrieve only the required columns’ data, excluding others.
• row_offset (integer, optional) The starting point for fetching a subset of rows, useful for pagination. It’s similar to specifying which row to start fetching from.
• sort_columns (array[string], optional) List of column names to sort the results by. Each entry is a string representing a column. Prefix with ’-’ for descending order.

HubspotCmsApi.AddHubdbTableRow

Add a new row to a HubDB draft table.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• target_table_id_or_name (string, optional) The ID or name of the target HubDB table to add the row to. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.ReadHubdbTableRows

Retrieve rows from a published HubDB table.

Parameters

• hubdb_table_id_or_name (string, required) The ID or name of the HubDB table to query. Use this to specify which table’s rows to retrieve.
• row_ids (array[string], required) An array of strings representing the row IDs to retrieve from the specified HubDB table.

HubspotCmsApi.CreateDraftTableRows

Create draft rows in a specified HubSpot table.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• table_id_or_name (string, optional) The ID or name of the HubSpot table to which the draft rows are being added. This is required to specify which table you want to update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.GetHubdbTableDetails

Get details of a HubDB table, including columns and row count.

Parameters

• table_id_or_name (string, required) The ID or name of the HubDB table to retrieve details for.
• get_localized_schema (boolean, optional) Set to true to return the localized schema for the table. If false, returns the default schema.
• include_foreign_id_values (boolean, optional) Set this to true to populate foreign ID values in the result.
• return_archived_table_details (boolean, optional) Set to true to return details for an archived table. Defaults to false.

HubspotCmsApi.ArchiveHubdbTable

Archive a HubDB table in HubSpot CMS.

Parameters

• hubdb_table_identifier (string, required) The ID or name of the HubDB table to archive. Provides the reference needed to identify the table within the system.

HubspotCmsApi.GetHubdbDraftRows

Fetch draft rows from a specified HubDB table.

Parameters

• row_ids (array[string], required) An array of row IDs to retrieve draft rows from the specified HubDB table.
• table_id_or_name (string, required) ID or name of the HubDB table to retrieve draft rows from.

HubspotCmsApi.CloneDraftTableRowsHubspot

Clone rows in a draft HubDB table by row IDs.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• hubdb_table_id_or_name (string, optional) The ID or name of the HubDB table to clone rows from. Specify either the unique table ID or its name. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.GetAllHubdbTables

Retrieve details of all published HubDB tables.

Parameters

• content_type_filter (string, optional) Filter tables by the specified content type to return only those matching it.
• created_after (string, optional) Return tables created after the specified time in ISO 8601 format.
• created_before_timestamp (string, optional) Return tables created before this timestamp. Format should be in ISO 8601.
• cursor_token_for_next_results (string, optional) The cursor token to retrieve the next set of results. Obtain this from the paging.next.after in a paged response.
• filter_by_creation_time (string, optional) Return tables created at the specified time. Format: ISO 8601.
• include_archived_tables (boolean, optional) Specifies whether to include archived tables in the results. Defaults to false.
• include_localized_schema (boolean, optional) Include localized schema details in the response if true.
• last_updated_exact_time (string, optional) Only return tables last updated at exactly the specified time, formatted as a string.
• max_table_results (integer, optional) Maximum number of HubDB table results to return. Default is 1000.
• sort_fields (array[string], optional) Specify fields for sorting results: name, createdAt, updatedAt, createdBy, updatedBy. Defaults to createdAt.
• updated_after_timestamp (string, optional) Return tables last updated after this timestamp. Format: ‘YYYY-MM-DDTHH:MM:SSZ’.
• updated_before_time (string, optional) Return tables updated before this specific time.

HubspotCmsApi.CreateHubdbTable

Create a new draft HubDB table with a unique name and label.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.DeleteTableVersion

Delete a specific version of a HubDB table.

Parameters

• table_identifier (string, required) The unique ID or name of the HubDB table whose version you want to delete.
• table_version_id (integer, required) Specify the ID of the table version to delete. This should be an integer value that identifies a specific version in HubDB.

HubspotCmsApi.UnpublishHubdbTable

Unpublish a HubDB table to stop rendering data on website pages.

Parameters

• table_identifier (string, required) The ID or name of the HubDB table to unpublish.
• include_foreign_ids (boolean, optional) Set this to true to populate foreign ID values in the response.

HubspotCmsApi.GetDraftTableDetails

Retrieve details of a draft HubDB table by ID or name.

Parameters

• table_id_or_name (string, required) The ID or name of the HubDB table to retrieve draft details for.
• include_foreign_ids (boolean, optional) Set this to true to populate foreign ID values in the result.
• include_localized_schema (boolean, optional) Set to true to include the localized schema in the result.
• return_archived_table (boolean, optional) Set to true to return an archived table. Defaults to false.

HubspotCmsApi.UpdateHubdbDraftTable

Update or modify a HubDB table draft in HubSpot CMS.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• table_id_or_name (string, optional) The ID or name of the HubDB table to update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• return_archived_tables (boolean, optional) Set to true to return archived tables. Defaults to false. Only used when mode is ‘execute’.
• populate_foreign_ids (boolean, optional) Set to true to populate foreign ID values in the table result. Only used when mode is ‘execute’.
• retrieve_localized_schema (boolean, optional) Set to true to retrieve the localized schema of the HubDB table, if available. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.PublishTableDraft

Publish draft table to update website pages.

Parameters

• table_identifier (string, required) The ID or name of the HubSpot CMS table to publish. This identifies which draft table’s data and schema should be copied to the published version.
• include_foreign_id_values (boolean, optional) Set to true to populate foreign ID values in the response.

HubspotCmsApi.BatchUpdateTableRowsHubspot

Update multiple draft table rows in HubSpot CMS.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• table_id_or_name (string, optional) The ID or name of the table to update rows in the draft version. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.CreateAttentionSpanEvent

Log viewer’s attention span details for media events.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.TrackMediaMilestones

Log user progress milestones in media content viewing.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.CreateMediaPlayedEvent

Log an event when media playback starts.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.RetrievePreviousSitePageVersion

Retrieve a previous version of a site page.

Parameters

• site_page_id (string, required) The unique identifier for the site page whose previous version is to be retrieved.
• site_page_revision_id (string, required) The ID of the specific revision of the site page to retrieve.

HubspotCmsApi.GetLandingPagePreviousVersions

Retrieve previous versions of a Landing Page for review.

Parameters

• landing_page_id (string, required) The ID of the Landing Page to retrieve previous versions for.
• cursor_token_for_next_set (string, optional) The cursor token for retrieving the next set of results, from the paging.next.after JSON property.
• limit_page_fetching_before_cursor (string, optional) A token used for fetching results before a specific cursor position in paged results. Typically used in pagination to navigate backwards.
• max_results (integer, optional) The maximum number of previous landing page versions to return. Default is 100.

HubspotCmsApi.UpdateSitePagesBatch

Batch update specified site pages in HubSpot CMS.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• update_deleted_site_pages (boolean, optional) Specify true to update deleted Site Pages. Defaults to false. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.GetPreviousFolderVersions

Retrieve previous versions of a CMS folder.

Parameters

• folder_id (string, required) The unique ID of the folder to retrieve its previous versions.
• before_token (string, optional) A cursor token to fetch items before a certain point in the result set, used for pagination.
• max_results (integer, optional) Specifies the maximum number of folder versions to retrieve. Default is 100.
• pagination_cursor_after (string, optional) The cursor token to retrieve the next set of results from the paging.next.after property in a paged response.

HubspotCmsApi.RestorePageVersion

Restore a specific version of a HubSpot site page.

Parameters

• page_version_to_restore (string, required) The ID of the site page version to restore. Use this to revert to a previous version.
• site_page_id (string, required) The unique identifier for the Site Page to be restored.

HubspotCmsApi.GetLandingPageFolders

Retrieve the list of landing page folders from HubSpot CMS.

Parameters

• created_after (string, optional) Return folders created after this specified ISO 8601 timestamp.
• created_before_time (string, optional) Return folders created before this specific time.
• exact_update_time (string, optional) Return folders last updated at exactly the specified time. Use a string format for the timestamp.
• filter_folders_created_at (string, optional) Return folders created at an exact specified time. Use ISO 8601 format.
• folder_property (string, optional) Specify properties to include in the response for each folder. Leave empty for all properties.
• include_deleted_folders (boolean, optional) Include deleted folders in the results when set to true. Defaults to false.
• max_results_limit (integer, optional) The maximum number of folder results to return. Default is 100.
• next_page_cursor (string, optional) The cursor token to retrieve the next set of results from a paged response.
• sort_criteria (array[string], optional) Fields to use for sorting results. Valid options: name, createdAt, updatedAt, createdBy, updatedBy. Default: createdAt.
• updated_after_date (string, optional) Only return folders last updated after the specified time. Use ISO 8601 format for the date and time.
• updated_before_timestamp (string, optional) Return folders last updated before this specified timestamp.

HubspotCmsApi.CreateLandingPageFolder

Create a new folder in HubSpot CMS for landing pages.

Parameters

• deletion_timestamp (string, required) The ISO8601 timestamp indicating when the folder was deleted. Leave this empty if the folder is active.
• folder_category (integer, required) The type of object this folder applies to. Must be set to LANDING_PAGE.
• folder_creation_date (string, required) The ISO8601 timestamp when this folder was created.
• folder_name (string, required) The name of the folder to display in the app dashboard.
• folder_unique_id (string, required) The unique identifier for the content folder. This is a string that serves as the primary key for the folder.
• parent_folder_id (integer, required) The ID of the parent content folder under which the new folder will be nested.
• updated_timestamp (string, required) The timestamp in ISO8601 format indicating when the folder was last updated.

HubspotCmsApi.AttachPageToLanguageGroup

Attach a site page to a multi-language group.

Parameters

• object_id_to_add_to_language_group (string, required) ID of the site page object to add to a multi-language group.
• page_language (string, required) Designated language code (e.g., ‘en’, ‘fr’) of the page to add to a multi-language group.
• primary_language_object_id (string, required) ID of the primary language object in the multi-language group to which the page will be attached.
• primary_language_of_group (string, optional) Specify the primary language for the multi-language group.

HubspotCmsApi.ScheduleSitePagePublication

Schedule a site page for publication at a specified time.

Parameters

• object_id_to_schedule (string, required) The ID of the site page to be scheduled for publication.
• publication_date (string, required) The date and time when the site page should be published. Use ISO 8601 format (e.g., ‘2023-12-31T23:59:00Z’).

HubspotCmsApi.DetachSitePageFromLanguageGroup

Detach a site page from a multi-language group.

Parameters

• object_id_to_detach (string, required) The ID of the site page to detach from the multi-language group.

HubspotCmsApi.CreateLandingPageFolders

Create multiple landing page folders in HubSpot CMS.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.GetPreviousSitePageVersions

Retrieve previous versions of a site page.

Parameters

• site_page_id (string, required) The unique identifier for the Site Page to retrieve its previous versions.
• max_results_limit (integer, optional) The maximum number of previous versions to retrieve. Defaults to 100 if not specified.
• next_results_cursor (string, optional) The cursor token to fetch the next set of site page versions. Obtain this from paging.next.after in the response of a previous request.
• page_version_cursor_before (string, optional) The cursor token to get the set of results before a specific point. Useful for backward paging through results.

HubspotCmsApi.GetLandingPageDraft

Retrieve the full draft version of a landing page.

Parameters

• landing_page_id (string, required) The unique identifier for the Landing Page draft to be retrieved.

HubspotCmsApi.UpdateLandingPageDraft

Update draft of a specific landing page by ID.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• landing_page_id (string, optional) The ID of the landing page to be updated. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.GetLandingPages

Retrieve a list of HubSpot CMS landing pages.

Parameters

• created_after (string, optional) Return landing pages created after this specified timestamp (ISO 8601 format).
• created_at_timestamp (string, optional) Return landing pages created at the specified exact timestamp. Format: ISO 8601.
• created_before_timestamp (string, optional) Only return landing pages created before the specified ISO 8601 timestamp.
• cursor_after_token (string, optional) The token to get the next set of results. Obtainable from paging.next.after in a paged response.
• filter_by_property (string, optional) Specify a property to filter the landing pages by.
• include_archived_pages (boolean, optional) Specify whether to include deleted landing pages in the results. Defaults to false.
• last_updated_before (string, optional) Return landing pages updated before this specified datetime (ISO format).
• last_updated_exact_time (string, optional) Return Landing Pages last updated at exactly this time. Use ISO 8601 format.
• max_results (integer, optional) Specify the maximum number of landing pages to return. Default is 100.
• sort_fields_for_results (array[string], optional) Specifies fields for sorting results. Valid options: name, createdAt, updatedAt, createdBy, updatedBy. Default is createdAt.
• updated_after_datetime (string, optional) Return landing pages updated after this datetime in ISO 8601 format.

HubspotCmsApi.CreateLandingPage

Create a new landing page in HubSpot.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.EndActiveAbTest

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

Parameters

• test_id_to_end (string, required) The unique identifier of the A/B test that you want to conclude in the HubSpot CMS.
• winner_id (string, required) The ID of the object to designate as the winner of the A/B test. This should match the ID used in the CMS to identify the specific variant.

HubspotCmsApi.RestoreSitePageToDraft

Restore a specific site page version to draft.

Parameters

• site_page_id (string, required) The ID of the Site Page to be restored to draft.
• site_page_version_id_to_restore (integer, required) The ID of the Site Page version to restore as the new draft.

HubspotCmsApi.CreateLandingPages

Create multiple landing pages in HubSpot CMS.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.UpdateLandingPagesBatch

Batch update landing pages in HubSpot CMS.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• update_deleted_landing_pages (boolean, optional) Set to true to update deleted (archived) Landing Pages. Defaults to false. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.RetrieveLandingPages

Retrieve specified Landing Page objects from HubSpot CMS.

Parameters

• landing_page_ids (array[string], required) Array of strings, each representing a Landing Page ID to retrieve details for.
• return_archived_landing_pages (boolean, optional) Specify whether to return deleted Landing Pages. Defaults to false.

HubspotCmsApi.CloneLandingPageHubspot

Clone a landing page in HubSpot CMS.

Parameters

• landing_page_id (string, required) ID of the landing page to be cloned. Required for identifying the source page.
• cloned_landing_page_name (string, optional) The name to assign to the newly cloned landing page in HubSpot CMS.

HubspotCmsApi.RestoreFolderVersion

Restore a specific version of a folder in HubSpot CMS.

Parameters

• folder_id (string, required) The unique identifier for the folder you want to restore in HubSpot CMS.
• folder_version_id_to_restore (string, required) The ID of the folder version to be restored in HubSpot CMS.

HubspotCmsApi.SetPrimaryLandingPageLanguage

Set a landing page as the primary language for a group.

Parameters

• landing_page_id (string, required) The ID of the landing page to set as primary in the multi-language group.

HubspotCmsApi.RestoreLandingPageVersion

Restore a specific version of a HubSpot landing page.

Parameters

• landing_page_id (string, required) The unique identifier for the landing page you want to restore.
• landing_page_version_id (string, required) The ID of the Landing Page version to be restored.

HubspotCmsApi.GetSitePageDraft

Retrieve the full draft version of the Site Page.

Parameters

• site_page_id (string, required) The unique identifier for the site page to retrieve its draft version.

HubspotCmsApi.UpdateSitePageDraft

Update the draft version of a specific site page.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• site_page_id (string, optional) The unique identifier for the Site Page to update the draft. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.RetrieveSitePages

Retrieve Site Page objects from HubSpot CMS.

Parameters

• page_identifiers (array[string], required) An array of strings, each representing an identifier for a Site Page to be retrieved. Use these IDs to specify which Site Pages to access.
• return_deleted_site_pages (boolean, optional) Set to true to return deleted Site Pages; false to exclude them.

HubspotCmsApi.GetLandingPageFolderById

Retrieve details of a landing page folder by its ID.

Parameters

• folder_id (string, required) The unique identifier for the landing page folder to retrieve.
• filter_by_property (string, optional) Specify properties to include in the response for the folder object. Leave empty to fetch all properties.
• include_archived_folders (boolean, optional) Specifies whether to include deleted folders in the response. Use ‘true’ to include them; defaults to ‘false’.

HubspotCmsApi.DeleteLandingPageFolder

Deletes a CMS landing page folder by ID.

Parameters

• folder_id (string, required) The ID of the folder to be deleted. Provide the specific ID of the CMS landing page folder you wish to delete.
• return_only_archived_results (boolean, optional) Set to true to return only archived results.

HubspotCmsApi.UpdateLandingPageFolder

Update specific attributes of a landing page folder.

Parameters

• content_folder_unique_id (string, required) The unique ID of the landing page content folder to be updated.
• creation_timestamp (string, required) The creation timestamp of the folder in ISO8601 format. Used for reference only, typically not updated.
• deletion_timestamp_iso8601 (string, required) The timestamp in ISO8601 format indicating when the content folder was deleted. Required for specifying deletion time.
• folder_category (integer, required) Specify the object type for the folder. Must be LANDING_PAGE.
• folder_id (string, required) The unique ID of the landing page folder to be updated.
• folder_name (string, required) Specify the new name of the landing page folder to display in the app dashboard.
• parent_folder_id (integer, required) The ID of the content folder this folder is nested under. Specify this to set a new parent folder.
• update_timestamp (string, required) The timestamp when the folder was last updated, in ISO8601 format. This indicates when changes were made.
• update_deleted_folders (boolean, optional) Set to true to update folders marked as deleted. Defaults to false.

HubspotCmsApi.CreateAbTestVariation

Create a new A/B test variation in HubSpot CMS.

Parameters

• ab_test_variation_name (string, required) The name of the A/B test variation to be created.
• object_test_id (string, required) The ID of the object to be tested in the A/B test variation.

HubspotCmsApi.GetSitePagesList

Retrieve a list of site pages with filtering options.

Parameters

• created_at_time_filter (string, optional) Return Site Pages created at exactly the specified time. Accepts an exact timestamp in string format.
• created_before_date_time (string, optional) Return Site Pages created before this date-time. Use ISO 8601 format.
• filter_created_after (string, optional) Return Site Pages created after the specified time. Use an ISO 8601 timestamp format.
• filter_updated_after (string, optional) Return site pages updated after this specific time. Use ISO 8601 format.
• include_deleted_site_pages (boolean, optional) Set to true to include deleted Site Pages in the results. Defaults to false if not specified.
• include_property_details (string, optional) Specify the properties to include in the Site Pages results. Leave empty to include all properties.
• last_updated_before (string, optional) Return site pages last updated before this datetime. Format: ISO 8601 string.
• last_updated_exact_time (string, optional) Return site pages last updated at exactly the specified time in ISO 8601 format.
• maximum_results (integer, optional) The maximum number of site pages to return. Default is 100.
• next_page_cursor (string, optional) Cursor token for paged results; use paging.next.after for the next set.
• sort_fields_for_results (array[string], optional) Specify fields for sorting site pages. Options: name, createdAt, updatedAt, createdBy, updatedBy. Default is createdAt.

HubspotCmsApi.CreateSitePage

Create a new site page in HubSpot CMS.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.AttachLandingPageToLanguageGroup

Attach a landing page to a multi-language group.

Parameters

• designated_language_to_add (string, required) The language of the landing page to add to a multi-language group. Expect a language code.
• object_id_for_language_group (string, required) ID of the landing page to add to the multi-language group.
• primary_language_object_id (string, required) Provide the ID of the primary language object in the multi-language group to which the landing page will be attached.
• primary_language (string, optional) Specifies the primary language of the multi-language group to which the landing page will be attached.

HubspotCmsApi.CreateLanguageVariation

Create a new language variation for a site page.

Parameters

• content_id_to_clone (string, required) ID of the site page content to clone for creating a language variation.
• primary_content_language (string, optional) Specify the language of the primary content to clone for creating the variation.
• target_language (string, optional) Target language code for the new site page variant, e.g., ‘fr’ for French.

HubspotCmsApi.RetrievePreviousLandingPageVersion

Retrieve a previous version of a Landing Page.

Parameters

• landing_page_id (string, required) The unique identifier for the landing page.
• landing_page_version_id (string, required) The ID of the landing page version to retrieve.

HubspotCmsApi.EndAbTestSelectWinner

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

Parameters

• test_id_to_end (string, required) ID of the A/B test to be ended.
• winner_object_id (string, required) ID of the landing page variant to designate as the winner of the A/B test.

HubspotCmsApi.PublishLandingPageDraft

Publish changes from a landing page draft to live.

Parameters

• landing_page_id (string, required) The ID of the landing page whose draft will be pushed live.

HubspotCmsApi.DetachLandingPageFromLanguageGroup

Detach a landing page from a multi-language group.

Parameters

• landing_page_id (string, required) The ID of the landing page to detach from the multi-language group in HubSpot CMS.

HubspotCmsApi.NewAbTestVariation

Create a new A/B test variation in HubSpot CMS.

Parameters

• ab_test_variation_name (string, required) The name for the new A/B test variation to be created.
• object_id_to_test (string, required) ID of the object to be tested in the A/B test variation.

HubspotCmsApi.ScheduleLandingPage

Schedule a landing page for publication.

Parameters

• landing_page_id (string, required) The unique identifier for the landing page to be scheduled for publication.
• publication_date (string, required) The date when the landing page should be published. Use the format YYYY-MM-DD.

HubspotCmsApi.UpdateLandingPageLanguages

Update languages for landing pages in a multi-language group.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.UpdateSitePageLanguages

Set new languages for site pages in a multi-language group.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.RerunPreviousAbTest

Rerun a previous A/B test on a landing page.

Parameters

• test_id_to_rerun (string, required) Provide the ID of the test you want to rerun on the landing page.
• variation_id (string, required) Provide the ID of the object you wish to reactivate as a test variation. This ID is necessary to specify which variation of the landing page you intend to rerun in the A/B test.

HubspotCmsApi.DeleteLandingPageFolders

Delete specified landing page folders in HubSpot CMS.

Parameters

• folder_identifiers (array[string], required) An array of strings representing the identifiers of the folders to be deleted.

HubspotCmsApi.CreateSitePagesBatch

Create multiple site page objects in batch.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.DeleteCmsSitePages

Delete specified Site Page objects in the CMS.

Parameters

• page_ids_to_delete (array[string], required) An array of strings representing the IDs of the Site Page objects to delete.

HubspotCmsApi.UpdateLandingPageFolders

Update multiple HubSpot CMS landing page folders.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• only_include_archived_results (boolean, optional) Set to true to return only archived folder results; false to return all folders. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.CloneSitePage

Clone an existing site page in HubSpot CMS.

Parameters

• object_id_to_clone (string, required) ID of the site page to be cloned in HubSpot CMS.
• clone_name (string, optional) The desired name for the cloned site page object.

HubspotCmsApi.SetPrimaryLanguageForSitePage

Set a site page as the primary language of its group.

Parameters

• page_id_to_set_primary (string, required) The ID of the site page to set as the primary language in the multi-language group.

HubspotCmsApi.RetrieveFolderPreviousVersion

Retrieve a previous version of a folder in HubSpot CMS.

Parameters

• folder_id (string, required) The unique identifier for the folder whose previous version you want to retrieve.
• folder_version_id (string, required) The unique identifier for the folder version to be retrieved.

HubspotCmsApi.ResetLandingPageDraft

Reset a landing page draft to its live version.

Parameters

• landing_page_id (string, required) The ID of the Landing Page whose draft will be reset to the live version.

HubspotCmsApi.GetLandingPageById

Retrieve details of a specific landing page by ID.

Parameters

• landing_page_id (string, required) The unique identifier of the landing page to be retrieved.
• include_archived (boolean, optional) Include deleted landing pages in the response if set to true. Defaults to false.
• landing_page_property (string, optional) Specify which properties of the landing page to retrieve, such as ‘title’ or ‘url’. Leave blank to fetch all.

HubspotCmsApi.DeleteLandingPage

Delete a specified landing page by its ID.

Parameters

• landing_page_id (string, required) The unique identifier of the landing page to delete in HubSpot CMS.
• return_archived_results_only (boolean, optional) Set to true to only return results that have been archived.

HubspotCmsApi.UpdateLandingPage

Update specific fields of a landing page by ID.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• landing_page_id (string, optional) The unique ID of the landing page to update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• update_archived_pages (boolean, optional) Set to true to update archived (deleted) Landing Pages. Defaults to false. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.PublishSitePage

Publish draft changes to live site page.

Parameters

• site_page_id (string, required) The ID of the Site Page whose draft will be published live. Ensure it corresponds to the correct page in HubSpot CMS.

HubspotCmsApi.CreateMultilanguageLandingPage

Create a new language variation for a landing page.

Parameters

• content_id_to_clone (string, required) The ID of the landing page content to be cloned for creating a new language variation.
• primary_language_of_content (string, optional) Language code of the primary content to be cloned for creating the new language variation.
• target_language (string, optional) Specify the target language for the new landing page variant.

HubspotCmsApi.DeleteLandingPages

Deletes specified HubSpot landing pages permanently.

Parameters

• landing_page_ids (array[string], required) An array of strings representing the IDs of landing pages to delete permanently.

HubspotCmsApi.RestoreLandingPageDraft

Restore a specified landing page version to draft.

Parameters

• landing_page_id (string, required) The ID of the landing page to restore a specific version to draft.
• landing_page_version_id_to_restore (integer, required) The ID of the landing page version you want to restore as the new draft.

HubspotCmsApi.RestartAbTest

Rerun a previous A/B test to gain new insights.

Parameters

• ab_test_id (string, required) The unique ID of the A/B test you wish to rerun on your HubSpot CMS site pages.
• test_variation_id (string, required) ID of the object to reactivate as a test variation for the A/B test.

HubspotCmsApi.ResetHubspotPageDraft

Resets HubSpot CMS draft to the live version.

Parameters

• site_page_id (string, required) The ID of the HubSpot Site Page whose draft will be reset to the live version.

HubspotCmsApi.RetrieveSitePageById

Retrieve Site Page details by ID.

Parameters

• site_page_id (string, required) The unique identifier for the Site Page to retrieve.
• return_archived_site_pages (boolean, optional) Boolean indicating whether to return deleted Site Pages. Defaults to ‘false’.
• site_page_property (string, optional) Specify the property of the Site Page to return. Leave empty to retrieve all properties.

HubspotCmsApi.DeleteSitePage

Delete a specified site page in HubSpot CMS.

Parameters

• site_page_id (string, required) The unique identifier for the site page to be deleted in HubSpot CMS.
• return_only_archived_results (boolean, optional) Set to true to return only the pages that have been archived.

HubspotCmsApi.UpdateSitePage

Update specific fields of a HubSpot site page.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• site_page_id (string, optional) The unique identifier for the Site Page to be updated. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• update_deleted_site_pages (boolean, optional) Boolean to specify whether to update deleted Site Pages. Defaults to false. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.UpdateFolderObjects

Update specified folder objects in HubSpot CMS.

Parameters

• folder_identifiers (array[string], required) An array of strings identifying folder objects to update in HubSpot CMS.
• include_archived_folders (boolean, optional) Indicate whether to include archived folders in the results. Defaults to false.

HubspotCmsApi.ScheduleBlogPost

Schedule a blog post for future publication.

Parameters

• blog_post_id (string, required) The ID of the blog post to be scheduled for future publication.
• scheduled_publish_date (string, required) The date and time when the blog post should be published, formatted as a string (e.g., ‘2023-12-31T23:59:59’).

HubspotCmsApi.RetrieveBlogPostsById

Retrieve a batch of blog posts by their IDs.

Parameters

• blog_post_ids (array[string], required) A list of blog post IDs to retrieve. Each ID should be a string.
• include_archived_posts (boolean, optional) Include deleted blog posts if true. Defaults to false.

HubspotCmsApi.UpdateBlogPostLanguages

Set new languages for multi-language blog posts.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.CreateBatchBlogPosts

Create multiple blog posts in a single request.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.UpdateBlogPostsBatch

Update a batch of blog posts in the CMS.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• update_archived_posts (boolean, optional) Indicates whether to update deleted blog posts. Defaults to false. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.RestoreBlogPostToDraft

Restore a previous blog post version to draft.

Parameters

• blog_post_id (string, required) The unique identifier for the blog post to be restored to a draft version. This is the same as the blog post’s current ID in the HubSpot CMS.
• version_to_restore_id (integer, required) The ID of the blog post version to revert to the draft state.

HubspotCmsApi.GetBlogPostDraft

Retrieve the full draft version of a blog post.

Parameters

• blog_post_id (string, required) The ID of the blog post to retrieve the draft version.

HubspotCmsApi.UpdateBlogPostDraft

Update specific fields of a blog post draft.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• blog_post_id (string, optional) The ID of the blog post draft to update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.RetrievePreviousBlogVersion

Retrieve a previous version of a blog post.

Parameters

• blog_post_id (string, required) The unique identifier for the blog post whose previous version is to be retrieved.
• version_id (string, required) The ID of the specific blog post version to retrieve.

HubspotCmsApi.NewLanguageBlogVariation

Create a new language variation from an existing blog post.

Parameters

• blog_post_id (string, required) The ID of the blog post you want to clone into a new language variation.
• target_language (string, optional) The language code for the target language of the new blog post variation (e.g., ‘fr’ for French).

HubspotCmsApi.CloneBlogPost

Creates a copy of an existing blog post.

Parameters

• blog_post_id (string, required) ID of the blog post to be cloned. This identifies the specific blog post you want to duplicate.
• cloned_blog_post_name (string, optional) The name for the newly cloned blog post. This is how the cloned post will be titled or identified.

HubspotCmsApi.RetrieveBlogPosts

Retrieve all blog posts with optional paging and filtering.

Parameters

• created_after (string, optional) Return blog posts created after the specified time. Use ISO 8601 format for the date-time.
• created_before (string, optional) Only return blog posts created before the specified time in ISO 8601 format.
• filter_by_creation_time (string, optional) Return only blog posts created at the specified time in ISO 8601 format.
• filter_by_update_after (string, optional) Only return blog posts last updated after the specified timestamp. Use a format such as ISO 8601 for date and time.
• include_archived_posts (boolean, optional) Specify true to include archived (deleted) blog posts in the results. Defaults to false.
• max_results (integer, optional) The maximum number of blog post results to return. Default is 20.
• pagination_cursor_token (string, optional) The cursor token to retrieve the next set of blog post results. Obtain from paging.next.after in a previous response.
• return_specific_properties (string, optional) Comma-separated list of specific fields to return for each blog post (e.g., ‘title,author,date’). Leave empty to return all fields.
• sort_fields_for_results (array[string], optional) An array specifying fields to sort blog posts. Use fields like createdAt, name, updatedAt, createdBy, updatedBy.
• updated_at_exact (string, optional) Return blog posts last updated at the exact specified time in ISO 8601 format.
• updated_before_date (string, optional) Return blog posts last updated before this date. Use ISO 8601 format (e.g., ‘2023-09-04T15:00:00Z’).

HubspotCmsApi.CreateBlogPost

Create a new blog post with specified content.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.RestoreBlogPostVersion

Restore a blog post to a previous version.

Parameters

• blog_post_id (string, required) The ID of the blog post to be restored to a previous version.
• version_to_restore_id (string, required) The unique identifier of the blog post version to which you want to revert.

HubspotCmsApi.DetachBlogPostLanguageGroup

Detach a blog post from a multi-language group.

Parameters

• object_id_to_detach_from_language_group (string, required) ID of the blog post to be removed from the multi-language group.

HubspotCmsApi.PublishBlogPost

Publish a draft blog post to make it live.

Parameters

• blog_post_id (string, required) The unique identifier of the blog post to be published live.

HubspotCmsApi.DeleteBlogPost

Delete a blog post by its unique ID.

Parameters

• blog_post_ids_to_delete (array[string], required) An array of blog post IDs to delete. Each ID should be a string representing a unique blog post.

HubspotCmsApi.ResetBlogPostDraft

Resets a blog post draft to the currently published content.

Parameters

• blog_post_id (string, required) The unique ID of the blog post draft that you want to reset to the published version.

HubspotCmsApi.AttachBlogPostToLanguageGroup

Attach a blog post to a multi-language group in HubSpot CMS.

Parameters

• designated_language (string, required) Specify the language code (e.g., ‘en’, ‘fr’, ‘es’) for the blog post to be added to the multi-language group.
• object_id (string, required) The ID of the blog post to attach to a multi-language group.
• primary_language_object_id (string, required) ID of the primary language object in the multi-language group.
• primary_language (string, optional) Primary language of the multi-language group. Specify in ISO language code format (e.g., ‘en’, ‘fr’).

HubspotCmsApi.SetPrimaryLanguageBlogPost

Set the primary language of a blog post in a multi-language group.

Parameters

• blog_post_id (string, required) The ID of the blog post to set as primary in its multi-language group.

HubspotCmsApi.GetPreviousBlogPostVersions

Retrieve all previous versions of a blog post in HubSpot.

Parameters

• blog_post_id (string, required) The unique ID of the blog post for retrieving its previous versions in HubSpot CMS.
• before_timestamp (string, optional) The timestamp to retrieve versions updated before this time.
• maximum_results_limit (integer, optional) The maximum number of blog post versions to return. Default is 100.
• next_page_cursor (string, optional) The cursor token to retrieve the next set of blog post versions, obtained from paging.next.after.

HubspotCmsApi.RetrieveBlogPostById

Retrieve a blog post by its ID from HubSpot CMS.

Parameters

• blog_post_id (string, required) The unique identifier of the blog post to retrieve from HubSpot CMS.
• include_archived_posts (boolean, optional) If true, includes deleted (archived) blog posts in the retrieval. Defaults to false.
• return_specific_properties (string, optional) Comma-separated list of specific properties to retrieve from the blog post.

HubspotCmsApi.RemoveBlogPost

Delete a blog post by its ID.

Parameters

• blog_post_id (string, required) The unique ID of the blog post to delete. This ID identifies which specific post will be removed.
• only_archived_results (boolean, optional) Set to true to return only deleted (archived) blog posts.

HubspotCmsApi.UpdateBlogPost

Update specific fields of a blog post by ID.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• blog_post_id (string, optional) The unique identifier of the blog post to update. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• update_archived_posts (boolean, optional) Set to true to update deleted (archived) blog posts. Defaults to false. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.RetrieveIndexedDataByContentId

Retrieve all indexed data for a specific document by ID.

Parameters

• document_id (string, required) ID of the target document when searching for indexed properties in HubSpot CMS.
• document_type (string, optional) Specify the document type, such as SITE_PAGE, BLOG_POST, or KNOWLEDGE_ARTICLE.

HubspotCmsApi.SearchWebsiteContent

Search for website content on a HubSpot account.

Parameters

• blog_ids_to_search (array[integer], optional) List of blog IDs to search within. Allows searching multiple blogs by their IDs.
• boost_recent_time_window (string, optional) A relative time window to boost scores of documents published within this period. Use ‘10d’ for 10 days. Supported units: ms, s, m, h, d. Applicable to blog posts only.
• content_language_code (string, optional) Specifies the language of content to be searched using a valid ISO 639-1 code (e.g. ‘es’ for Spanish).
• content_type_filters (array[string], optional) List of content types to search, such as SITE_PAGE, LANDING_PAGE, BLOG_POST, LISTING_PAGE, and KNOWLEDGE_ARTICLE.
• hubdb_query_filter (string, optional) Specify a HubDB query to filter search results in the specified table.
• hubdb_table_id (integer, optional) Specifies a specific HubDB table to search. Only results from this table are returned. Can be combined with ‘hubdb_query’ for further filtering.
• invert_path_prefix_filter (boolean, optional) Set to ‘false’ to apply the normal behavior of the pathPrefix filter; ‘true’ to invert it.
• maximum_boost_limit (number, optional) Specifies the maximum amount a result will be boosted based on its view count. Defaults to 5.0.
• pagination_offset (integer, optional) Integer used to page through results. Use the offset from the previous request to access the next set of results.
• path_prefixes (array[string], optional) An array of strings to filter search results by URL path prefix. Only returns results with paths starting with specified prefixes.
• popularity_boost (number, optional) Specify the boost factor for a result based on its view count. Defaults to 1.0.
• result_length (string, optional) Specifies whether search results should be detailed (LONG) or brief (SHORT).
• results_limit (integer, optional) The number of search results to return. Defaults to 10 and has a maximum of 100.
• search_domains (array[string], optional) List of domains to match search results for. Multiple domains can be included by separating them with ’&’.
• search_properties (array[string], optional) A list of properties to include in the search. Options: title, description, html. By default, all properties are searched.
• search_term (string, optional) The term to search for in the HubSpot website content.
• show_autocomplete (boolean, optional) Specify whether autocomplete results should be shown. Defaults to false.

HubspotCmsApi.GetFileMetadata

Retrieve metadata for a file in a specified environment.

Parameters

• file_environment (string, required) Specify the environment of the file, either ‘draft’ or ‘published’.
• file_path (string, required) The file system location of the file to retrieve metadata for.
• include_properties (string, optional) Comma-separated list of additional properties to include in the metadata response, if applicable.

HubspotCmsApi.DownloadFileFromHubspotCms

Download file content from HubSpot CMS by path and environment.

Parameters

• file_environment (string, required) Specify the environment of the file. Options are ‘draft’ or ‘published’.
• file_system_path (string, required) The file system path to the file within HubSpot CMS to be downloaded.

HubspotCmsApi.DeleteFileInCmsEnvironment

Deletes a file in a specified CMS environment.

Parameters

• file_environment (string, required) Specify the environment of the file to delete. Valid values are “draft” or “published”.
• file_system_location (string, required) The file system location of the file to be deleted.

HubspotCmsApi.ExtractZipFileAsync

Initiate asynchronous extraction of a zip file on HubSpot CMS.

Parameters

• zip_file_path (string, required) The path to the zip file in the developer file system that needs extraction.

HubspotCmsApi.CheckExtractionStatus

Retrieve the current status of a source-code extraction task.

Parameters

• extraction_task_id (integer, required) The unique ID of the extraction task, obtained from the initial extract/async request. This ID is required to check the status of the extraction.

HubspotCmsApi.UpdateBlogTags

Update multiple blog tags in HubSpot CMS.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• update_deleted_blog_tags (boolean, optional) Specifies whether to update deleted blog tags. Defaults to false. Only used when mode is ‘execute’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.UpdateBlogTagLanguages

Update languages for blog tags in a multi-language group.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.DetachBlogTagFromLanguageGroup

Detach a Blog Tag from a multi-language group.

Parameters

• blog_tag_id (string, required) ID of the blog tag to remove from a multi-language group in HubSpot CMS.

HubspotCmsApi.CreateBlogTagsBatch

Create multiple blog tags in a single request.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

HubspotCmsApi.ArchiveBlogTags

Archive multiple blog tags in HubSpot CMS.

Parameters

• blog_tag_identifiers (array[string], required) An array of strings representing the blog tag identifiers to be archived.

HubspotCmsApi.SetBlogTagPrimaryLanguage

Set a blog tag as the primary language in a multi-language group.

Parameters

• primary_language_tag_id (string, required) ID of the blog tag to set as the primary language in a multi-language group.

HubspotCmsApi.RetrieveBlogTags

Retrieve Blog Tag objects based on specified IDs.

Parameters

• blog_tag_ids (array[string], required) A list of strings representing the IDs of the Blog Tag objects to retrieve.
• include_deleted_tags (boolean, optional) Boolean indicating if deleted Blog Tags should be included in the response. If true, deleted tags are returned.

HubspotCmsApi.GetBlogTags

Retrieve a list of blog tags with paging and filtering options.

Parameters

• additional_properties (string, optional) Include additional fields in the response. Specify the properties you want to retrieve.
• created_after_time (string, optional) Only return Blog Tags created after the specified time. Provide the time in ISO 8601 format.
• filter_by_creation_time (string, optional) Filter blog tags to return only those created at the specified exact time. Use ISO 8601 format for the date-time.
• filter_tags_created_before (string, optional) Only return blog tags created before the specified date and time in UTC, formatted as an ISO 8601 string.
• include_archived_tags (boolean, optional) Specify whether to return deleted blog tags. Defaults to false.
• last_updated_before (string, optional) Return blog tags updated before this date and time (in ISO 8601 format).
• maximum_results_to_return (integer, optional) Specify the maximum number of blog tags to return. Default is 100.
• pagination_cursor_token (string, optional) The token to retrieve the next set of results from a paginated response. Obtain this from the paging.next.after property in the previous response.
• sort_fields_for_results (array[string], optional) Fields to sort results by. Options: name, createdAt, updatedAt, createdBy, updatedBy. Default is createdAt.
• updated_after (string, optional) Return Blog Tags last updated after the specified date and time. Provide in ISO 8601 format, e.g., ‘2023-10-21T15:30:00Z’.
• updated_at_exact (string, optional) Return blog tags last updated at the specified exact time (ISO 8601 format).

HubspotCmsApi.CreateBlogTag

Create a new blog tag in HubSpot CMS.

Parameters

• blog_tag_unique_id (string, required) The unique ID assigned to the Blog Tag.
• creation_timestamp (string, required) The timestamp (ISO8601 format) when this Blog Tag was created. Leave empty if not applicable.
• deletion_timestamp (string, required) The ISO8601 timestamp marking when the blog tag was deleted.
• language_code (string, required) The explicit ISO 639 language code for the tag, such as ‘en’ for English or ‘es’ for Spanish.
• primary_tag_translation_id (integer, required) Specify the ID of the primary tag that this tag was translated from.
• tag_name (string, required) The name for the new blog tag to be created in HubSpot CMS.
• updated_timestamp (string, required) The timestamp (ISO8601 format) when the Blog Tag was last updated.

HubspotCmsApi.AttachTagToLanguageGroup

Attach a blog tag to a multi-language group.

Parameters

• designated_language (string, required) Specify the language of the blog tag to add to a multi-language group. Use a language code like ‘en’ for English.
• object_id_for_multilanguage_group (string, required) ID of the blog tag to add to the multi-language group.
• primary_language_object_id (string, required) ID of the primary language object in the multi-language group.
• primary_language (string, optional) Specifies the primary language of the multi-language group.

HubspotCmsApi.RetrieveBlogTagById

Retrieve blog tag details using its ID.

Parameters

• blog_tag_id (string, required) The unique identifier for the Blog Tag to be retrieved.
• include_archived_blog_tags (boolean, optional) Specify whether to include archived blog tags in the response. Defaults to false.
• property_name (string, optional) Specify a property of the blog tag to retrieve. Leave blank to get all details.

HubspotCmsApi.DeleteBlogTag

Delete a specified Blog Tag in HubSpot CMS.

Parameters

• blog_tag_id (string, required) The unique identifier for the Blog Tag to be deleted.
• return_only_archived_results (boolean, optional) Set to true to return only blog tags that have been archived.

HubspotCmsApi.UpdateBlogTag

Update specific fields of a blog tag by its ID.

Parameters

• blog_tag_id (string, required) The unique identifier for the blog tag to be updated.
• blog_tag_unique_id (string, required) The unique ID of the Blog Tag to be updated.
• created_timestamp (string, required) The timestamp (ISO8601 format) when the blog tag was created. This field is optional and can be used if the creation time needs to be updated.
• deleted_timestamp (string, required) The ISO8601 timestamp indicating when the blog tag was deleted.
• language (string, required) The ISO 639 language code for the tag. Select from the available options.
• last_updated_timestamp (string, required) The ISO8601 timestamp when the blog tag was last updated.
• primary_tag_translated_from_id (integer, required) ID of the primary tag from which this tag was translated.
• tag_name (string, required) The new name for the blog tag to be updated. This is a required field when changing the tag’s name.
• update_deleted_blog_tags (boolean, optional) Set to true to update deleted Blog Tags. Defaults to false.

HubspotCmsApi.CreateBlogTagLanguageVariation

Create a new language variation from an existing blog tag.

Parameters

• blog_tag_id (string, required) ID of the existing blog tag to be cloned for creating a language variation.
• new_blog_tag_name (string, required) The name for the newly cloned blog tag language variation.
• primary_blog_tag_language (string, optional) Specify the language code of the primary blog tag to be cloned, such as ‘en’, ‘fr’, etc.
• target_language_for_blog_tag_variation (string, optional) Specifies the target language for the new blog tag variant.

HubspotCmsApi.FetchUrlRedirects

Retrieve all URL redirects with optional filters.

Parameters

• created_after_date (string, optional) Return redirects created after this date (format: YYYY-MM-DD).
• created_at (string, optional) Return redirects created exactly on this date. Format: YYYY-MM-DD.
• filter_by_exact_update_date (string, optional) Return redirects last updated on this exact date. Use a valid date format (e.g., YYYY-MM-DD).
• filter_created_before_date (string, optional) Return redirects created before this date. Expected format: YYYY-MM-DD.
• filter_updated_after (string, optional) Only include redirects updated after this specified date (ISO 8601 format).
• paging_cursor_token (string, optional) Token for the last read resource to fetch additional results.
• results_per_page_limit (integer, optional) Maximum number of URL redirects to return per page. Use to control pagination.
• return_archived_only (boolean, optional) Set to true to return only archived URL redirects, false to exclude them.
• sort_criteria (array[string], optional) Specify fields to sort the URL redirects by. Can include multiple fields such as ‘createdAt’ or ‘updatedAt’.
• updated_before_date (string, optional) Only return redirects last updated before this date (in YYYY-MM-DD format).

HubspotCmsApi.CreateUrlRedirect

Creates and configures a new URL redirect in HubSpot CMS.

Parameters

• redirect_destination_url (string, required) The target URL to which the redirect will point. This should be a valid and complete URL.
• redirect_style (integer, required) Integer indicating the style of the redirect. Defines the behavior and type of the redirect, such as permanent (301) or temporary (302).
• route_prefix (string, required) Defines the prefix for the URL route to be redirected. Provide the specific path without the domain, e.g., ‘/example-path’.
• apply_only_after_not_found (boolean, optional) Applies the redirect only after a 404 Not Found response if true.
• enable_pattern_matching (boolean, optional) Set to true to enable URL pattern matching for the redirect. False matches exact URLs only.
• enable_protocol_agnostic (boolean, optional) Set to true to ignore the protocol (HTTP/HTTPS) when matching URLs. Enables protocol-agnostic redirects.
• ignore_trailing_slash (boolean, optional) Set to true to ignore trailing slashes, allowing flexibility in URL matches.
• match_full_url (boolean, optional) Set to true to match the entire URL exactly. False applies partial matching.
• match_query_string (boolean, optional) Indicates whether the redirect should match the query string. Set to true to match, false to ignore.
• redirect_precedence (integer, optional) An integer indicating the priority of the redirect if multiple rules match. Higher numbers take precedence.

HubspotCmsApi.GetUrlRedirectDetailsById

Retrieve details of a URL redirect by ID.

Parameters

• url_redirect_id (string, required) The ID of the target URL redirect to fetch details for.

HubspotCmsApi.DeleteUrlRedirect

Deletes an existing URL redirect in HubSpot CMS.

Parameters

• url_redirect_id (string, required) The unique identifier of the URL redirect to be deleted within the HubSpot CMS.

HubspotCmsApi.UpdateUrlRedirectSettings

Update settings for an existing URL redirect in HubSpot CMS.

Parameters

• mode (Enum ToolMode, required) Operation mode: ‘get_request_schema’ returns the OpenAPI spec for the request body, ‘execute’ performs the actual operation
• url_redirect_id (string, optional) The unique identifier for the URL redirect to be updated. This ID specifies which redirect’s settings will be modified. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’.
• request_body (string, optional) Stringified JSON representing the request body. Required when mode is ‘execute’, ignored when mode is ‘get_request_schema’

Reference

Below is a reference of enumerations used by some of the tools in the HubspotCmsApi MCP Server:

ToolMode

• GET_REQUEST_SCHEMA: get_request_schema
• EXECUTE: execute

Auth

The HubspotCmsApi MCP Server uses the Auth Provider with id arcade-hubspot to connect to users’ HubspotCmsApi accounts. In order to use the MCP Server, you will need to configure the arcade-hubspot auth provider.

pip install arcade_hubspot_cms_api