Skip to Content

HubSpot Marketing API

HubSpot Marketing API icon
Arcade Starter

Tools that enable LLMs to interact directly with the Hubspot Marketing API.

Author:Arcade
Version:1.0.0
Auth:User authorization
90tools
PyPI VersionPython VersionsWheel StatusDownloadsLicense

This documentation describes the HubspotMarketingApi toolkit, which allows LLMs to directly interact with the HubSpot Marketing API to manage and analyze marketing campaigns effectively.

Capabilities

  • Create, update, and delete marketing campaigns, forms, emails, and events.
  • Manage budget items associated with campaigns.
  • Record and analyze event participation and contact interactions.
  • Retrieve detailed metrics and statistics for marketing activities.

OAuth

  • Provider: Unknown
  • Scopes: content, crm.objects.marketing_events.read, crm.objects.marketing_events.write, forms, marketing-email, marketing.campaigns.read, marketing.campaigns.revenue.read, marketing.campaigns.write, transactional-email.

Available tools(90)

90 of 90
Tool nameDescriptionSecrets
Add a new budget item to a marketing campaign. Use this tool to add a budget item to an existing campaign in HubSpot Marketing. Ideal for updating campaign financials.
Delete a batch of marketing campaigns. Use this tool to delete multiple marketing campaigns in a single batch request (up to 50 campaigns). The response will indicate if the request was processed, but it won't specify the success of individual deletions. 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.
Archive a marketing form in HubSpot. Use this tool to archive a form in HubSpot Marketing, preventing new submissions. The form will be permanently deleted after 3 months.
Associate a specified asset with a HubSpot campaign. This tool is used to link various asset types such as forms, lists, or emails with a specific HubSpot campaign. It's useful for managing and organizing marketing efforts across different platforms.
Associate a list with a marketing event by their IDs. This tool associates a specific list with a marketing event using the marketing event ID and the list ID. It is used when you need to connect a list of contacts to a marketing event for tracking and management purposes.
Cancel a HubSpot marketing event. Use this tool to mark a specific HubSpot marketing event as cancelled by providing the external event ID.
Clone an existing HubSpot marketing email. Use this tool to create a copy of an existing email in HubSpot's marketing platform. Ideal for reusing email templates and maintaining consistency in marketing campaigns.
Create a new variation for an email A/B test. Use this tool to generate a new variation of an existing email for conducting A/B tests in your marketing campaigns. This is useful for testing different email content to optimize engagement and performance.
Create a new campaign spend item for a marketing campaign. This tool creates a new spend item for a specified marketing campaign. It should be called when you need to add or track expenditures related to a specific campaign.
Create a marketing campaign and retrieve its details. This tool creates a marketing campaign using provided properties and returns the campaign object, including essential details like campaignGuid and created properties. 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 batch of marketing campaigns in HubSpot. This tool is used to batch create up to 50 marketing campaigns in HubSpot Marketing. The campaigns in the response may not be in the same order as they were submitted in the request. 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 marketing email in HubSpot. Use this tool to create a new marketing email through HubSpot's marketing platform, allowing for effective email campaigns. 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 marketing event in HubSpot. This tool is used to create a new marketing event within the HubSpot platform. It should be called when a new event needs to be added to HubSpot's marketing event 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 new marketing form in HubSpot. This tool is used to add a new form to HubSpot's marketing systems. It should be called whenever you need to create a new form for collecting marketing data. 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 a SMTP API token for transaction emails. This tool is used to create a new SMTP API token for sending transactional emails through HubSpot's marketing service. It should be called when a new token is needed for email operations.
Delete a specific campaign budget item by ID. Use this tool to delete a specific budget item from a campaign using the campaignGuid and budgetId. Useful for managing or updating campaign budgets.
Delete a specified marketing campaign. Use this tool to delete a marketing campaign from the system by providing the campaign's GUID. A 204 No Content response is returned, indicating the request was processed, regardless of whether the campaign existed.
Delete an existing marketing email by ID. Use this tool to remove a specific marketing email from the HubSpot system by providing its unique email ID. This is useful for managing email lists and ensuring outdated or incorrect emails are removed.
Deletes a specified HubSpot marketing event. Use this tool to delete an existing marketing event in HubSpot by specifying the externalEventId. The event must have been created by the same app requesting the deletion.
Delete multiple marketing events by object ID. This tool deletes specified marketing events based on their object IDs. Use it to clean up events from the portal. It returns a status indicating whether all or only some events were successfully deleted. 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.
Delete an SMTP token by ID in HubSpot Marketing. Use this tool to delete a specific SMTP token from HubSpot Marketing by providing the token ID. This is useful for managing and revoking access tokens when they are no longer needed or for security reasons.
Disassociate an asset from a HubSpot marketing campaign. Use this tool to remove a specified asset from a marketing campaign. Supported asset types include Forms, Static lists, and External website pages.
Disassociate a list from a marketing event using event and list IDs. Use this tool to remove the association between a specific list and a marketing event by providing the marketing event ID and the list ID. It ensures that the list is no longer linked to the specified marketing event.
Disassociate a list from a HubSpot marketing event using IDs. Use this tool to disassociate a list from a specific marketing event in HubSpot by providing the external account ID, external event ID, and list ID. This action is useful when you need to update or manage your marketing event associations.
Fetch contact IDs for a specific campaign and contact type. Use this tool to obtain the contact IDs associated with a particular marketing campaign and specified contact type in HubSpot. It is useful for analyzing campaign reach and engagement with specific contact demographics.
Page 1 of 4(25 of 90)

Selected tools

No tools selected.

Click "Show all tools" to add tools.

Requirements

Select tools to see requirements

#

HubspotMarketingApi.AddCampaignBudgetItem

Add a new budget item to a marketing campaign. Use this tool to add a budget item to an existing campaign in HubSpot Marketing. Ideal for updating campaign financials.

Parameters

ParameterTypeReq.Description
budget_amountnumberRequiredThe monetary amount for the budget item. It should be a numeric value denoting the budget amount to add to the campaign.
budget_item_namestringRequiredName of the budget item to be added to the campaign. It should be descriptive and concise.
budget_item_orderintegerRequiredThe position or priority of the budget item in the list. Provide as an integer.
campaign_idstringRequiredUnique identifier for the campaign in HubSpot Marketing.
budget_item_descriptionstringOptionalA brief description of the budget item being added to the campaign. This can include details about what the budget will be used for and any other relevant information.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/campaigns/{campaignGuid}/budget'.
#

HubspotMarketingApi.ArchiveCampaignsBatch

Delete a batch of marketing campaigns. Use this tool to delete multiple marketing campaigns in a single batch request (up to 50 campaigns). The response will indicate if the request was processed, but it won't specify the success of individual deletions. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/campaigns/batch/archive'.
#

HubspotMarketingApi.ArchiveMarketingForm

Archive a marketing form in HubSpot. Use this tool to archive a form in HubSpot Marketing, preventing new submissions. The form will be permanently deleted after 3 months.

Parameters

ParameterTypeReq.Description
form_idstringRequiredThe ID of the form to archive in HubSpot. This is required to process the archive request.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'delete-/marketing/v3/forms/{formId}_archive'.
#

HubspotMarketingApi.AssociateAssetWithCampaign

Associate a specified asset with a HubSpot campaign. This tool is used to link various asset types such as forms, lists, or emails with a specific HubSpot campaign. It's useful for managing and organizing marketing efforts across different platforms.

Parameters

ParameterTypeReq.Description
asset_idstringRequiredThe unique identifier for the asset to be associated with a campaign. This should be provided as a string.
asset_typestringRequiredSpecify the asset type to associate with the campaign. Allowed values are FORM, OBJECT_LIST, and EXTERNAL_WEB_URL.
campaign_unique_identifierstringRequiredUnique identifier for the campaign, formatted as a UUID. Essential for associating an asset with the correct campaign.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'put-/marketing/v3/campaigns/{campaignGuid}/assets/{assetType}/{assetId}'.
#

HubspotMarketingApi.AssociateListWithMarketingEvent

Associate a list with a marketing event by their IDs. This tool associates a specific list with a marketing event using the marketing event ID and the list ID. It is used when you need to connect a list of contacts to a marketing event for tracking and management purposes.

Parameters

ParameterTypeReq.Description
list_idstringRequiredThe ILS ID of the list to associate with the marketing event.
marketing_event_idstringRequiredThe internal ID of the marketing event in HubSpot for association.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'put-/marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}_associateByMarketingEventId'.
#

HubspotMarketingApi.CancelMarketingEvent

Cancel a HubSpot marketing event. Use this tool to mark a specific HubSpot marketing event as cancelled by providing the external event ID.

Parameters

ParameterTypeReq.Description
external_account_idstringRequiredThe account ID associated with the marketing event in the external event application.
external_event_idstringRequiredThe ID of the marketing event in the external event application. Required to identify the event to be cancelled.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/marketing-events/events/{externalEventId}/cancel_cancel'.
#

HubspotMarketingApi.CloneHubspotEmail

Clone an existing HubSpot marketing email. Use this tool to create a copy of an existing email in HubSpot's marketing platform. Ideal for reusing email templates and maintaining consistency in marketing campaigns.

Parameters

ParameterTypeReq.Description
original_email_idstringRequiredThe unique identifier of the email you wish to clone in HubSpot.
cloned_email_namestringOptionalThe new name for the cloned email. This should be a descriptive string to identify the copy.
email_languagestringOptionalSpecify the language for the cloned email, e.g., 'en' for English, 'fr' for French.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/emails/clone'.
#

HubspotMarketingApi.CreateAbTestEmailVariation

Create a new variation for an email A/B test. Use this tool to generate a new variation of an existing email for conducting A/B tests in your marketing campaigns. This is useful for testing different email content to optimize engagement and performance.

Parameters

ParameterTypeReq.Description
email_content_idstringRequiredID of the email content to create a variation for A/B testing.
variation_namestringRequiredThe name of the new email variation for the A/B test. Provide a descriptive name to easily identify this variation.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/emails/ab-test/create-variation'.
#

HubspotMarketingApi.CreateCampaignSpend

Create a new campaign spend item for a marketing campaign. This tool creates a new spend item for a specified marketing campaign. It should be called when you need to add or track expenditures related to a specific campaign.

Parameters

ParameterTypeReq.Description
campaign_idstringRequiredUnique identifier for the marketing campaign to add the spend item to.
spend_amountnumberRequiredThe monetary value of the spend item to be added to the campaign. This should be a numerical value representing the amount in the currency used by the campaign.
spend_item_namestringRequiredThe name of the spend item to be created for the campaign. This should be a descriptive title or label for the expenditure.
spend_item_orderintegerRequiredThe order of the spend item in the campaign. Use an integer to specify the sequence.
spend_descriptionstringOptionalA brief description of the campaign spend item, detailing the nature or purpose of the expenditure.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/campaigns/{campaignGuid}/spend'.
#

HubspotMarketingApi.CreateMarketingCampaign

Create a marketing campaign and retrieve its details. This tool creates a marketing campaign using provided properties and returns the campaign object, including essential details like campaignGuid and created properties. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/campaigns/'.
#

HubspotMarketingApi.CreateMarketingCampaignBatch

Create a batch of marketing campaigns in HubSpot. This tool is used to batch create up to 50 marketing campaigns in HubSpot Marketing. The campaigns in the response may not be in the same order as they were submitted in the request. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/campaigns/batch/create'.
#

HubspotMarketingApi.CreateMarketingEmail

Create a new marketing email in HubSpot. Use this tool to create a new marketing email through HubSpot's marketing platform, allowing for effective email campaigns. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/emails/'.
#

HubspotMarketingApi.CreateMarketingEvent

Create a new marketing event in HubSpot. This tool is used to create a new marketing event within the HubSpot platform. It should be called when a new event needs to be added to HubSpot's marketing event 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/marketing-events/events_create'.
#

HubspotMarketingApi.CreateMarketingForm

Create a new marketing form in HubSpot. This tool is used to add a new form to HubSpot's marketing systems. It should be called whenever you need to create a new form for collecting marketing data. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/forms/_create'.
#

HubspotMarketingApi.CreateSmtpApiToken

Creates a SMTP API token for transaction emails. This tool is used to create a new SMTP API token for sending transactional emails through HubSpot's marketing service. It should be called when a new token is needed for email operations.

Parameters

ParameterTypeReq.Description
campaign_namestringRequiredThe name of the campaign associated with the SMTP API token.
create_contact_for_recipientsbooleanRequiredIndicates whether a contact should be created for email recipients. Set to true to create a contact.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/transactional/smtp-tokens_createToken'.
#

HubspotMarketingApi.DeleteCampaignBudgetItem

Delete a specific campaign budget item by ID. Use this tool to delete a specific budget item from a campaign using the campaignGuid and budgetId. Useful for managing or updating campaign budgets.

Parameters

ParameterTypeReq.Description
budget_item_idintegerRequiredUnique identifier for the budget item to be deleted.
campaign_guidstringRequiredUnique identifier for the campaign to delete the budget item from.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'delete-/marketing/v3/campaigns/{campaignGuid}/budget/{budgetId}'.
#

HubspotMarketingApi.DeleteMarketingCampaign

Delete a specified marketing campaign. Use this tool to delete a marketing campaign from the system by providing the campaign's GUID. A 204 No Content response is returned, indicating the request was processed, regardless of whether the campaign existed.

Parameters

ParameterTypeReq.Description
campaign_guidstringRequiredUnique identifier for the campaign, formatted as a UUID.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'delete-/marketing/v3/campaigns/{campaignGuid}'.
#

HubspotMarketingApi.DeleteMarketingEmail

Delete an existing marketing email by ID. Use this tool to remove a specific marketing email from the HubSpot system by providing its unique email ID. This is useful for managing email lists and ensuring outdated or incorrect emails are removed.

Parameters

ParameterTypeReq.Description
email_idstringRequiredThe unique ID of the marketing email to be deleted.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'delete-/marketing/v3/emails/{emailId}'.
#

HubspotMarketingApi.DeleteMarketingEvent

Deletes a specified HubSpot marketing event. Use this tool to delete an existing marketing event in HubSpot by specifying the externalEventId. The event must have been created by the same app requesting the deletion.

Parameters

ParameterTypeReq.Description
external_account_idstringRequiredThe account ID associated with the marketing event to be deleted in the external event application.
marketing_event_idstringRequiredThe ID of the marketing event in the external event application to be deleted.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'delete-/marketing/v3/marketing-events/events/{externalEventId}_archive'.
#

HubspotMarketingApi.DeleteMarketingEvents

Delete multiple marketing events by object ID. This tool deletes specified marketing events based on their object IDs. Use it to clean up events from the portal. It returns a status indicating whether all or only some events were successfully deleted. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/marketing-events/batch/archive_archiveByObjectId'.
#

HubspotMarketingApi.DeleteSmtpToken

Delete an SMTP token by ID in HubSpot Marketing. Use this tool to delete a specific SMTP token from HubSpot Marketing by providing the token ID. This is useful for managing and revoking access tokens when they are no longer needed or for security reasons.

Parameters

ParameterTypeReq.Description
smtp_token_idstringRequiredThe unique identifier of the SMTP token to be deleted, provided during token creation.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'delete-/marketing/v3/transactional/smtp-tokens/{tokenId}_archiveToken'.
#

HubspotMarketingApi.DisassociateCampaignAsset

Disassociate an asset from a HubSpot marketing campaign. Use this tool to remove a specified asset from a marketing campaign. Supported asset types include Forms, Static lists, and External website pages.

Parameters

ParameterTypeReq.Description
asset_idstringRequiredUnique identifier for the asset to be disassociated from the campaign.
asset_typestringRequiredSpecify the type of asset to disassociate, limited to FORM, OBJECT_LIST, or EXTERNAL_WEB_URL.
campaign_unique_identifierstringRequiredUnique identifier for the campaign, formatted as a UUID.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'delete-/marketing/v3/campaigns/{campaignGuid}/assets/{assetType}/{assetId}'.
#

HubspotMarketingApi.DisassociateListFromMarketingEvent

Disassociate a list from a marketing event using event and list IDs. Use this tool to remove the association between a specific list and a marketing event by providing the marketing event ID and the list ID. It ensures that the list is no longer linked to the specified marketing event.

Parameters

ParameterTypeReq.Description
list_identifierstringRequiredThe ILS ID of the list to be disassociated from the marketing event.
marketing_event_idstringRequiredThe internal ID of the marketing event in HubSpot to disassociate the list from.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'delete-/marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}_disassociateByMarketingEventId'.
#

HubspotMarketingApi.DisassociateMarketingEventList

Disassociate a list from a HubSpot marketing event using IDs. Use this tool to disassociate a list from a specific marketing event in HubSpot by providing the external account ID, external event ID, and list ID. This action is useful when you need to update or manage your marketing event associations.

Parameters

ParameterTypeReq.Description
external_account_idstringRequiredThe account ID linked to the marketing event in the external application.
list_idstringRequiredThe ILS ID of the list to be disassociated from the marketing event.
marketing_event_idstringRequiredID of the marketing event in the external application to be disassociated.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'delete-/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}_disassociateByExternalAccountAndEventIds'.
#

HubspotMarketingApi.FetchCampaignContactIds

Fetch contact IDs for a specific campaign and contact type. Use this tool to obtain the contact IDs associated with a particular marketing campaign and specified contact type in HubSpot. It is useful for analyzing campaign reach and engagement with specific contact demographics.

Parameters

ParameterTypeReq.Description
campaign_identifierstringRequiredUnique identifier for the campaign formatted as a UUID.
contact_type_filterstringRequiredSpecifies the type of metric for filtering contacts. Options: contactFirstTouch, contactLastTouch, influencedContacts.
contact_fetch_limitintegerOptionalSpecify the maximum number of contact IDs to retrieve, with a default of 100.
pagination_cursorstringOptionalA string cursor for pagination to start results after the given point. Example: NTI1Cg%3D%3D
report_end_datestringOptionalThe end date for the report data in YYYY-MM-DD format. Defaults to the current date if not specified.
start_datestringOptionalThe start date for the report data in YYYY-MM-DD format. Default is 2006-01-01.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/campaigns/{campaignGuid}/reports/contacts/{contactType}'.
#

HubspotMarketingApi.FetchEmailStatistics

Fetch aggregated email statistics in specified intervals. This tool retrieves aggregated email statistics over specified time intervals, providing insights into email performance during each period.

Parameters

No parameters required.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/emails/statistics/histogram'.
#

HubspotMarketingApi.FetchEventDetails

Fetch details of a marketing event by its object ID. Use this tool to retrieve detailed information about a specific marketing event by providing its object ID. This can be useful for gaining insights into the event's specifics and managing marketing activities.

Parameters

ParameterTypeReq.Description
marketing_event_object_idstringRequiredThe internal ID of the marketing event in HubSpot. Used to fetch specific event details.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/marketing-events/{objectId}_getByObjectId'.
#

HubspotMarketingApi.FetchMarketingCampaignBatches

Retrieve a batch of HubSpot marketing campaigns and assets. Use this tool to read a batch of marketing campaigns from HubSpot, along with their associated assets. The tool allows for processing up to 50 campaigns per request. Note that the campaigns returned may not be in the order requested, and duplicate campaign IDs will be handled by returning only unique entries. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query 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 query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
fetch_start_datestringOptionalStart date to fetch asset metrics, formatted as YYYY-MM-DD. Determines the period for asset metrics. Optional. Only used when mode is 'execute'.
end_date_for_asset_metricsstringOptionalEnd date to fetch asset metrics, formatted as YYYY-MM-DD. If not provided, no asset metrics will be fetched. Only used when mode is 'execute'.
requested_propertiesarray<string>OptionalComma-separated list of properties to return in the response. Ignored if values are empty, resulting in an empty properties map if not specified. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/campaigns/batch/read'.
#

HubspotMarketingApi.FindHubspotMarketingEvents

Fetch HubSpot marketing events by externalEventId. Use this tool to retrieve marketing events from HubSpot where the externalEventId matches the given request parameter. It only returns events created by the app making the request, excluding those made by other apps.

Parameters

ParameterTypeReq.Description
external_event_idstringRequiredThe ID of the marketing event in the external application (externalEventId) to search for.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/marketing-events/events/search_doSearch'.
#

HubspotMarketingApi.GetAllMarketingEvents

Retrieve all marketing events from the portal. This tool fetches all available marketing events, including manually created ones and those generated through the application. The events are sorted by objectId.

Parameters

ParameterTypeReq.Description
cursor_position_afterstringOptionalThe cursor indicating the position of the last retrieved item for pagination purposes.
response_limitintegerOptionalSets the maximum number of marketing events to retrieve, between 10 and 100.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/marketing-events/_getAll'.
#

HubspotMarketingApi.GetCampaignAttributionMetrics

Retrieve attribution metrics for a specific campaign. Retrieves key attribution metrics for a specified campaign, including sessions, new contacts, and influenced contacts. Use this tool to analyze campaign performance.

Parameters

ParameterTypeReq.Description
campaign_unique_identifierstringRequiredUnique identifier for the campaign, formatted as a UUID. Required to retrieve specific campaign metrics.
report_end_datestringOptionalSet the end date for the report data in YYYY-MM-DD format. Defaults to the current date if not specified.
start_date_for_reportstringOptionalThe start date for the report data, formatted as YYYY-MM-DD. Default is 2006-01-01.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/campaigns/{campaignGuid}/reports/metrics'.
#

HubspotMarketingApi.GetCampaignBudget

Retrieve details of a specific marketing campaign budget item. This tool is used to obtain information about a specific budget item within a marketing campaign by providing the campaign GUID and budget ID. Use this tool to access detailed budget data for analysis or reporting purposes.

Parameters

ParameterTypeReq.Description
budget_item_idintegerRequiredUnique identifier for the budget item to retrieve details.
campaign_guidstringRequiredThe unique identifier for the marketing campaign to access its budget details.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/campaigns/{campaignGuid}/budget/{budgetId}'.
#

HubspotMarketingApi.GetCampaignBudgetDetails

Retrieve detailed budget and spend details for a campaign. This tool retrieves detailed information regarding the budget and spending for a specific marketing campaign, including total budget, total spend, and remaining budget. It's useful for understanding financial aspects of a campaign.

Parameters

ParameterTypeReq.Description
campaign_unique_identifierstringRequiredUnique identifier for the campaign, formatted as a UUID.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/campaigns/{campaignGuid}/budget/totals'.
#

HubspotMarketingApi.GetCampaignDetails

Retrieve details and metrics for a specific marketing campaign. Use this tool to get detailed information about a marketing campaign using its campaignGuid. It also provides information about associated assets, and if start and end dates are given, metrics for those assets.

Parameters

ParameterTypeReq.Description
campaign_guidstringRequiredUnique identifier for the campaign, formatted as a UUID.
end_date_for_asset_metricsstringOptionalEnd date to fetch asset metrics, formatted as YYYY-MM-DD. If omitted, no metrics will be retrieved.
metrics_start_datestringOptionalStart date for fetching asset metrics. Format as YYYY-MM-DD. Metrics are only retrieved if both start and end dates are provided.
properties_listarray<string>OptionalList specific properties to return in the response. Leave empty for an empty properties map.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/campaigns/{campaignGuid}'.
#

HubspotMarketingApi.GetCampaignRevenueReport

Fetch revenue attribution report for a specific campaign. This tool retrieves the revenue attribution report data for a specified marketing campaign using its unique campaign GUID.

Parameters

ParameterTypeReq.Description
campaign_unique_identifierstringRequiredUnique identifier for the campaign, formatted as a UUID.
attribution_modelstringOptionalThe revenue attribution model to be used. Allowed values: LINEAR, FIRST_INTERACTION, LAST_INTERACTION, FULL_PATH, U_SHAPED, W_SHAPED, TIME_DECAY, J_SHAPED, INVERSE_J_SHAPED. Defaults to LINEAR.
report_end_datestringOptionalEnd date for the report data in YYYY-MM-DD format. Defaults to the current date.
report_start_datestringOptionalThe start date for the report data in the format YYYY-MM-DD. Default is 2006-01-01.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/campaigns/{campaignGuid}/reports/revenue'.
#

HubspotMarketingApi.GetCampaignSpendItem

Retrieve details of a specific campaign spend item. Use this tool to get information about a campaign spend item by providing its spendId and campaignGuid.

Parameters

ParameterTypeReq.Description
campaign_guidstringRequiredUnique identifier for the marketing campaign to retrieve the spend item from.
spend_item_identifierintegerRequiredUnique identifier for the spend item in the campaign.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/campaigns/{campaignGuid}/spend/{spendId}'.
#

HubspotMarketingApi.GetContactParticipationsBreakdown

Retrieve a contact's event participation details by ID or email. This tool retrieves participation details for a specific contact in marketing events using their email or internal ID. It is useful for analyzing a contact's engagement in various events.

Parameters

ParameterTypeReq.Description
contact_identifierstringRequiredThe identifier of the contact, which can be either an email or an internal ID.
pagination_cursorstringOptionalCursor for the last retrieved item to manage pagination.
participation_statestringOptionalThe participation state for the contact. Options: REGISTERED, CANCELLED, ATTENDED, NO_SHOW.
response_size_limitintegerOptionalSpecify the maximum number of participation records to return. The default is 10, and the maximum is 100.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/marketing-events/participations/contacts/{contactIdentifier}/breakdown_getParticipationsBreakdownByContactId'.
#

HubspotMarketingApi.GetEmailAbTestVariation

Retrieve the variation of an A/B test marketing email. Use this tool to get the opposite variation of a specified A/B marketing email. Ideal for determining the alternative version presented in a marketing email campaign.

Parameters

ParameterTypeReq.Description
email_identifierstringRequiredThe unique identifier of the marketing email to obtain its A/B test variation.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/emails/{emailId}/ab-test/get-variation'.
#

HubspotMarketingApi.GetEmailRevisions

Retrieve all versions of a marketing email. Use this tool to get a comprehensive list of all versions of a specified marketing email, each containing the full state of that version.

Parameters

ParameterTypeReq.Description
email_idstringRequiredThe unique identifier of the marketing email to retrieve revisions for.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/emails/{emailId}/revisions'.
#

HubspotMarketingApi.GetEmailStatistics

Get aggregated email statistics in a specified time span. Use this tool to obtain aggregated statistics for emails sent within a specific time period. It also provides a list of all emails sent during that period.

Parameters

No parameters required.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/emails/statistics/list'.
#

HubspotMarketingApi.GetEventParticipationCounters

Retrieve participation counters for a specific marketing event. This tool fetches participation metrics for a marketing event using the externalAccountId and externalEventId. It should be called when you need detailed participation statistics for a specific event in HubSpot's marketing platform.

Parameters

ParameterTypeReq.Description
event_idstringRequiredThe unique identifier for the marketing event in the external application. Required to retrieve participation data.
external_account_idstringRequiredThe account ID associated with the marketing event in the external application.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}_getParticipationsCountersByEventExternalId'.
#

HubspotMarketingApi.GetFormById

Retrieve a marketing form by its ID. Use this tool to get detailed information about a specific marketing form by providing its unique form ID.

Parameters

ParameterTypeReq.Description
form_idstringRequiredThe unique identifier for the specific marketing form to retrieve. This ID is required to fetch the form details.
return_archived_onlybooleanOptionalSet to true to return only archived forms.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/forms/{formId}_getById'.
#

HubspotMarketingApi.GetMarketingCampaigns

Retrieve a page of marketing campaigns with optional filters. This tool allows retrieval of a page of marketing campaigns based on query parameters such as name filtering, sorting, and pagination. You can also control the properties included in the response.

Parameters

ParameterTypeReq.Description
campaign_name_filterstringOptionalA substring to filter campaigns by name. Returns campaigns containing this substring. Optional: returns all if not provided.
max_results_limitintegerOptionalMaximum number of campaigns to return (1-100). Default is 50.
pagination_cursorstringOptionalA cursor for pagination. If provided, results start after the given cursor. Example: NTI1Cg%3D%3D
requested_propertiesarray<string>OptionalA list of properties to be included in the response. Comma-separate values are required. If any specified property is empty, it will be ignored.
sort_bystringOptionalSpecify the field to sort results by. Use '-' to denote descending order. Options are hs_name, createdAt, updatedAt. Default is hs_name.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/campaigns/'.
#

HubspotMarketingApi.GetMarketingEmailDetails

Retrieve details for a specific marketing email. Use this tool to get comprehensive information about a marketing email by specifying its email ID.

Parameters

ParameterTypeReq.Description
email_idstringRequiredThe unique identifier for the specific marketing email. Required to retrieve email details.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/emails/{emailId}'.
#

HubspotMarketingApi.GetMarketingEmailRevision

Retrieve a specific revision of a marketing email. Use this tool to get details about a specific revision of a marketing email by providing the email and revision IDs.

Parameters

ParameterTypeReq.Description
email_idstringRequiredThe unique identifier for the marketing email. This ID is required to specify which email's revision details to retrieve.
email_revision_idstringRequiredThe unique ID of the specific email revision to retrieve. Provide the revisionId for accessing the exact version.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/emails/{emailId}/revisions/{revisionId}'.
#

HubspotMarketingApi.GetMarketingEventAssociatedLists

Retrieve lists associated with a specific marketing event. Call this tool to get lists associated with a marketing event using external account and event IDs. Useful for accessing participant or attendee lists linked to specific marketing events.

Parameters

ParameterTypeReq.Description
external_account_idstringRequiredThe account ID associated with the marketing event in the external application.
external_event_idstringRequiredThe ID of the marketing event from the external event application.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists_getAllByExternalAccountAndEventIds'.
#

HubspotMarketingApi.GetMarketingEventDetails

Retrieve details of a specific marketing event. Fetches details of a marketing event using its externalEventId. Only events created by the requesting app can be accessed.

Parameters

ParameterTypeReq.Description
external_account_idstringRequiredThe accountId associated with this marketing event in the external event application.
marketing_event_idstringRequiredThe unique identifier of the marketing event in the external application.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/marketing-events/events/{externalEventId}_getDetails'.
#

HubspotMarketingApi.GetMarketingEventLists

Retrieve lists associated with a specific marketing event. This tool fetches all lists associated with a given marketing event using the marketing event ID. It should be called when you need to obtain lists connected to a particular marketing event for analysis or reporting purposes.

Parameters

ParameterTypeReq.Description
marketing_event_idstringRequiredThe internal ID of the marketing event in HubSpot to retrieve associated lists.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/marketing-events/associations/{marketingEventId}/lists_getAllByMarketingEventId'.
#

HubspotMarketingApi.GetMarketingEventParticipationBreakdown

Retrieve the participation breakdown for a marketing event. This tool fetches the participation breakdown for a specified marketing event, filtered by externalAccountId and externalEventId. It provides detailed insights on event participation metrics.

Parameters

ParameterTypeReq.Description
external_account_idstringRequiredThe ID associated with the marketing event's account in the external application.
external_event_idstringRequiredThe ID of the marketing event in the external event application.
contact_identifierstringOptionalThe unique identifier for the contact, such as an email or internal ID.
pagination_cursorstringOptionalThe cursor indicating the position of the last retrieved item, used for pagination.
participation_state_filterstringOptionalThe participation state to filter results. Possible values: REGISTERED, CANCELLED, ATTENDED, NO_SHOW.
response_size_limitintegerOptionalMaximum number of participations to retrieve. Default is 10, maximum is 100.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}/breakdown_getParticipationsBreakdownByExternalEventId'.
#

HubspotMarketingApi.GetMarketingEventParticipationCounters

Retrieve participation counters for a marketing event. This tool fetches the participation statistics for a specified marketing event using its internal identifier.

Parameters

ParameterTypeReq.Description
marketing_event_idintegerRequiredThe internal ID of the marketing event in HubSpot, required to fetch participation counters.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/marketing-events/participations/{marketingEventId}_getParticipationsCountersByMarketingEventId'.
#

HubspotMarketingApi.GetMarketingEventParticipationsBreakdown

Retrieve participations breakdown for a specific marketing event. This tool fetches a detailed breakdown of participations for a specific marketing event identified by marketingEventId. It can be used to analyze participation metrics and insights for a given event.

Parameters

ParameterTypeReq.Description
marketing_event_idintegerRequiredThe internal id of the marketing event in HubSpot.
contact_identifierstringOptionalThe identifier of the Contact. It can be an email or internal ID.
last_retrieved_position_cursorstringOptionalThe cursor indicating the position of the last retrieved item for pagination.
participation_statestringOptionalThe participation state filter, which can be REGISTERED, CANCELLED, ATTENDED, or NO_SHOW.
response_size_limitintegerOptionalSet the maximum number of records to return. Default is 10, maximum is 100.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/marketing-events/participations/{marketingEventId}/breakdown_getParticipationsBreakdownByMarketingEventId'.
#

HubspotMarketingApi.GetSmtpTokenById

Retrieve details of an SMTP token using its ID. This tool is used to query a specific SMTP token by its ID within the HubSpot Marketing platform. Call this tool when you need to access detailed information about a particular SMTP transactional token.

Parameters

ParameterTypeReq.Description
smtp_token_idstringRequiredThe unique identifier of the SMTP token to be queried.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/transactional/smtp-tokens/{tokenId}_getTokenById'.
#

HubspotMarketingApi.HubspotMarketingEmailFilter

Retrieve and filter HubSpot marketing emails. Use this tool to retrieve and filter marketing emails from HubSpot. It allows you to apply various filters to find specific sets of emails based on your criteria.

Parameters

No parameters required.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/emails/'.
#

HubspotMarketingApi.LinkListToEvent

Associates a marketing list with an event in HubSpot. This tool associates a list with a marketing event using the external account ID, external event ID, and ILS list ID. It should be called when you need to link a specific list to a marketing event for tracking or organizational purposes.

Parameters

ParameterTypeReq.Description
external_account_idstringRequiredThe account ID associated with the marketing event in the external event application.
external_event_idstringRequiredThe ID of the marketing event in the external event application. Used to specify which event to associate with the list.
ils_list_idstringRequiredThe ILS ID of the list to associate with the marketing event.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'put-/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}_associateByExternalAccountAndEventIds'.
#

HubspotMarketingApi.ListCampaignAssets

Retrieve all assets of a specified type for a campaign. This tool lists all assets of a particular type within a specified marketing campaign. It can also fetch asset metrics if start and end dates are provided, allowing for detailed analysis of campaign performance.

Parameters

ParameterTypeReq.Description
asset_typestringRequiredThe type of asset to fetch for the campaign, e.g., 'email', 'webpage'.
campaign_identifierstringRequiredUnique identifier for the campaign in UUID format.
end_date_for_asset_metricsstringOptionalEnd date to fetch asset metrics, formatted as YYYY-MM-DD. Used for fetching metrics of assets within a specified period. Optional parameter.
maximum_results_limitstringOptionalThe maximum number of asset results to return. Default is 10.
metrics_start_datestringOptionalStart date to fetch asset metrics, formatted as YYYY-MM-DD. Used to fetch metrics for a specified period. If not provided, no metrics will be fetched.
pagination_cursorstringOptionalA cursor for pagination. If provided, results start after this cursor. Example: NTI1Cg%3D%3D

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/campaigns/{campaignGuid}/assets/{assetType}'.
#

HubspotMarketingApi.ListHubspotForms

Retrieve a list of HubSpot marketing forms. Call this tool to obtain a list of marketing forms from HubSpot. It applies search filters if provided, otherwise returns the first 20 forms by default.

Parameters

ParameterTypeReq.Description
included_form_typesarray<string>OptionalList of form types to include in results, e.g., 'hubspot', 'workflow', etc.
paging_cursor_tokenstringOptionalThe token indicating the cursor position for paginated results. Use `paging.next.after` from the previous response to fetch more results.
results_per_pageintegerOptionalSpecify the maximum number of forms to retrieve per page.
return_only_archived_formsbooleanOptionalSet to true to return only archived forms in the results.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/forms/_getPage'.
#

HubspotMarketingApi.MarkMarketingEventCompleted

Mark a marketing event as completed in HubSpot. Use this tool to mark a marketing event as completed in HubSpot, identified by its externalEventId. This confirms that the specified event has been finalized.

Parameters

ParameterTypeReq.Description
event_end_datetimestringRequiredThe date and time when the marketing event ended. Expected in ISO 8601 format.
event_start_date_timestringRequiredThe start date and time of the marketing event, formatted as an ISO 8601 string.
external_account_idstringRequiredThe account ID associated with the marketing event in the external application.
marketing_event_idstringRequiredThe unique ID of the marketing event in the external event application.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/marketing-events/events/{externalEventId}/complete_complete'.
#

HubspotMarketingApi.ModifyEventInformation

Update details of a specific marketing event. Use this tool to update the details of an existing marketing event by providing the object's ID. It confirms whether the update was successful. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
event_internal_idstringOptionalThe internal ID of the marketing event in HubSpot to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'patch-/marketing/v3/marketing-events/{objectId}_updateByObjectId'.
#

HubspotMarketingApi.PublishHubspotEmail

Publish a HubSpot marketing email. Use this tool to publish a marketing email in HubSpot by specifying the email ID. This should be called when you need to make an email live as part of a marketing campaign.

Parameters

ParameterTypeReq.Description
hubspot_email_idstringRequiredThe unique identifier for the HubSpot marketing email to publish.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/emails/{emailId}/publish'.
#

HubspotMarketingApi.QuerySmtpTokens

Retrieve SMTP API tokens by campaign name or emailCampaignId. Use this tool to query multiple SMTP API tokens associated with a campaign by its name, or to retrieve a single token using an emailCampaignId. This is useful for managing email campaigns and accessing specific token information.

Parameters

ParameterTypeReq.Description
campaign_namestringOptionalName of the campaign tied to the SMTP API token to query tokens.
email_campaign_idstringOptionalIdentifier assigned to the campaign provided during the token creation. Used to retrieve a specific SMTP API token.
maximum_tokens_to_returnintegerOptionalSpecify the maximum number of SMTP API tokens to return in the response.
result_pagination_startstringOptionalSpecify a starting point for retrieving the next set of results. Use this for paginating through results.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/transactional/smtp-tokens_getTokensPage'.
#

HubspotMarketingApi.RecordEventAttendance

Record participation of HubSpot contacts in a marketing event. Use this tool to record the attendance of multiple HubSpot contacts at a marketing event using their HubSpot contact IDs. This also adds a timeline event to each contact's record. The tool is applicable for the "attend" state with optional properties like "joinedAt" and "leftAt". 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
marketing_event_idstringOptionalThe internal ID of the marketing event in HubSpot for which attendance is being recorded. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
attendance_statestringOptionalSpecifies the attendance state of the contact: 'register', 'attend', or 'cancel'. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/create_recordByContactId'.
#

HubspotMarketingApi.RecordEventParticipationHubspot

Record participation of contacts in a HubSpot marketing event. Use this tool to record the attendance of HubSpot contacts in a marketing event using their email addresses. It can automatically create contacts if they do not exist and adds a timeline event for them. This is particularly useful for logging who attended or participated in specific marketing events. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query 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, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
external_event_idstringOptionalThe ID of the marketing event in the external event application. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
subscriber_statestringOptionalThe new subscriber state for HubSpot contacts in the specified event. Options: 'register', 'attend', 'cancel'. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
external_account_idstringOptionalThe account ID linked to the marketing event in the external event application. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/email-create_recordByContactEmails'.
#

HubspotMarketingApi.RecordHubspotSubscriberState

Record subscriber state for HubSpot contacts and events. Record a subscriber state between multiple HubSpot contacts and a marketing event using HubSpot contact IDs. Note: Contacts must already exist in HubSpot. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query 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, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
external_account_idstringOptionalThe account ID associated with this marketing event in the external event application. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
event_id_in_external_appstringOptionalThe ID of the marketing event in the external application. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
subscriber_statestringOptionalThe new subscriber state for the HubSpot contacts and the specified marketing event, such as 'register', 'attend', or 'cancel'. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/upsert_upsertByContactId'.
#

HubspotMarketingApi.RecordMarketingEventAttendance

Record participation of HubSpot contacts in a Marketing Event. Use this tool to mark multiple HubSpot contacts as having participated in a specific marketing event. It is useful for updating contact records and timelines when contacts attend an event. The tool supports additional properties like 'joinedAt' and 'leftAt' for the 'attend' state. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query 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, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
external_event_idstringOptionalThe identifier for the marketing event in the external event application. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
new_subscriber_statestringOptionalSpecifies the new state of the contact in relation to the marketing event, such as 'register', 'attend', or 'cancel'. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
external_account_idstringOptionalThe ID identifying the account associated with the marketing event in the external application. Only used when mode is 'execute'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/create_recordByContactIds'.
#

HubspotMarketingApi.RecordSubscriberState

Record a subscriber's state for a marketing event using email. This tool records the subscriber state of a HubSpot contact in relation to a specific marketing event using the contact's email. Note: the contact must already exist in HubSpot. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query 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, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
external_account_idstringOptionalThe account ID linked to the marketing event in the external application, required for identifying events. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
marketing_event_idstringOptionalThe unique identifier for the marketing event in the external application. Required to record subscriber state. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
subscriber_statestringOptionalThe new subscriber state for a HubSpot contact in the specified marketing event. Options include 'register', 'attend', or 'cancel'. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/email-upsert_upsertByContactEmail'.
#

HubspotMarketingApi.RegisterEventParticipation

Logs event participation for contacts using email addresses. Records participation of HubSpot contacts in a marketing event using emails. Automatically creates non-existing contacts and logs the event on their timeline. Applicable for 'attend' state, with optional 'joinedAt' and 'leftAt' properties. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
marketing_event_idstringOptionalThe internal ID of the marketing event in HubSpot. It is required to log participation for contacts. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
attendance_statestringOptionalThe attendance state for the contact in the event. Options: 'register', 'attend', or 'cancel'. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/email-create_recordByEmail'.
#

HubspotMarketingApi.RemoveCampaignSpendItem

Deletes a specific campaign spend item by ID. Use this tool to delete a specific spend item from a marketing campaign using its ID. This is useful for managing and updating campaign expenses in HubSpot Marketing.

Parameters

ParameterTypeReq.Description
campaign_identifierstringRequiredUnique identifier for the specific marketing campaign.
spend_item_idintegerRequiredUnique identifier for the specific spend item to be deleted from the campaign.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'delete-/marketing/v3/campaigns/{campaignGuid}/spend/{spendId}'.
#

HubspotMarketingApi.RemoveMarketingEvent

Deletes a specified marketing event by objectId. Use this tool to delete an existing marketing event in HubSpot Marketing using its objectId. Call this tool when you need to remove a marketing event from the system.

Parameters

ParameterTypeReq.Description
marketing_event_idstringRequiredThe internal ID of the marketing event to be deleted in HubSpot.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'delete-/marketing/v3/marketing-events/{objectId}_archiveByObjectId'.
#

HubspotMarketingApi.RemoveMarketingEvents

Delete multiple HubSpot marketing events by specific IDs. This tool deletes multiple HubSpot marketing events based on provided external account, event, and app IDs. It is used to remove events created by the calling app, ensuring events from other apps remain unaffected. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/marketing-events/events/delete_archive'.
#

HubspotMarketingApi.ResetEmailDraftToLive

Reset an email draft to match the live version. Use this tool to reset an email draft to a copy of its currently live version in HubSpot Marketing. This is useful when you want to discard changes made to a draft and revert to the original published version.

Parameters

ParameterTypeReq.Description
email_idstringRequiredThe unique identifier for the email draft to be reset. This is a string value used to specify which draft to revert.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/emails/{emailId}/draft/reset'.
#

HubspotMarketingApi.ResetPasswordForToken

Resets the password for a specified token. This tool allows you to create a new password for a specified token, invalidating the old password. Use it when you need to reset the password associated with a specific SMTP token in HubSpot's marketing system.

Parameters

ParameterTypeReq.Description
token_identifierstringRequiredThe unique string identifier for the token, used to reset its password.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/transactional/smtp-tokens/{tokenId}/password-reset_resetPassword'.
#

HubspotMarketingApi.RestoreEmailRevision

Restore a previous revision of a marketing email. Use this tool to revert a marketing email to a specified previous revision. The current version is archived, and the restored revision is assigned a new version number.

Parameters

ParameterTypeReq.Description
email_idstringRequiredThe unique identifier for the marketing email you want to restore. This ID is required to specify which email's revision needs restoration.
revision_idstringRequiredThe unique identifier for the specific revision of the email to be restored.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/emails/{emailId}/revisions/{revisionId}/restore'.
#

HubspotMarketingApi.RestoreEmailRevisionToDraft

Restore a previous email revision to draft state. Use this tool to revert a marketing email back to a previous revision, setting it to DRAFT. This will overwrite any current content in the draft for that email.

Parameters

ParameterTypeReq.Description
email_identifierstringRequiredThe unique identifier of the marketing email whose revision is to be restored to draft. This should match the specific email ID format used by HubSpot.
revision_idstringRequiredThe unique identifier of the email revision to be restored to draft state.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/emails/{emailId}/revisions/{revisionId}/restore-to-draft'.
#

HubspotMarketingApi.RetrieveEmailDraft

Retrieve the draft version of a specified email. This tool retrieves the draft version of a specified email by its ID from HubSpot Marketing. If no draft exists, the published version is returned instead. It should be used when you need to access the current draft or latest version of an email.

Parameters

ParameterTypeReq.Description
email_idstringRequiredThe unique identifier of the email to retrieve the draft for. This ID is used to specify which email's draft or published version should be accessed.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/emails/{emailId}/draft'.
#

HubspotMarketingApi.SearchMarketingEventsByExternalId

Search for marketing events by external ID. This tool retrieves all marketing events whose externalEventId matches the provided value. It returns object IDs and additional details for each matching event. Useful for finding all marketing events linked to a specific external ID after creation.

Parameters

ParameterTypeReq.Description
external_event_idstringRequiredThe ID of the marketing event in the external event application used to search for matching events.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'get-/marketing/v3/marketing-events/{externalEventId}/identifiers_searchPortalEvents'.
#

HubspotMarketingApi.SendMarketingEmail

Send a template email to a specific recipient. This tool sends a marketing email using a predefined template to a specified recipient via HubSpot. It's useful for automating email campaigns and reaching target audiences efficiently. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v4/email/single-send'.
#

HubspotMarketingApi.SendTransactionalEmail

Send a transactional email asynchronously. Use this tool to send a transactional email asynchronously and obtain the status of the email send with a statusId, which can be queried further using the Email Send Status API. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/transactional/single-email/send_sendEmail'.
#

HubspotMarketingApi.UnpublishMarketingEmail

Unpublish a HubSpot marketing email. This tool is used to unpublish a specific email in HubSpot Marketing. It should be called when you want to deactivate or withdraw an email from being publicly available.

Parameters

ParameterTypeReq.Description
email_identifierstringRequiredThe unique identifier of the email you wish to unpublish in HubSpot Marketing.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/emails/{emailId}/unpublish'.
#

HubspotMarketingApi.UpdateCampaignBatch

Update a batch of marketing campaigns efficiently. Use this tool to update multiple marketing campaigns in a single request. The tool handles up to 50 campaigns per request, and can reset property values when an empty string is provided. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/campaigns/batch/update'.
#

HubspotMarketingApi.UpdateCampaignBudget

Update a specific campaign budget item by ID. Use this tool to update a particular budget item in a marketing campaign by providing the campaign GUID and the budget ID.

Parameters

ParameterTypeReq.Description
budget_amountnumberRequiredThe amount to set for the budget item. This is a numerical value representing the budget in the specified currency.
budget_idintegerRequiredUnique identifier for the budget item to be updated.
budget_item_namestringRequiredThe new name for the budget item. It should be a descriptive label that clearly identifies the budget item within the campaign.
campaign_guidstringRequiredA unique identifier for the campaign. Use this to specify which campaign's budget item to update.
priority_orderintegerRequiredSpecify the order in which the budget item appears. Accepted values are integers.
budget_item_descriptionstringOptionalA string to describe the budget item. Provide a brief explanation of what this budget is for.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'put-/marketing/v3/campaigns/{campaignGuid}/budget/{budgetId}'.
#

HubspotMarketingApi.UpdateCampaignProperties

Update properties of a HubSpot marketing campaign. Use this tool to perform a partial update of a marketing campaign in HubSpot by providing the campaignGuid and the new property values. Note that only existing, mutable properties can be updated; read-only and non-existent properties will cause an error. Passing an empty string will reset a property's value. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
campaign_uuidstringOptionalUnique identifier for the campaign, formatted as a UUID. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'patch-/marketing/v3/campaigns/{campaignGuid}'.
#

HubspotMarketingApi.UpdateCampaignSpend

Update a specific campaign spend item by ID. Use this tool to modify the details of a particular spend item in a marketing campaign by providing the campaign and spend identifiers.

Parameters

ParameterTypeReq.Description
campaign_guidstringRequiredUnique identifier for the campaign.
spend_amountnumberRequiredThe new amount value for the campaign spend. Specify this as a number representing the monetary value.
spend_identifierintegerRequiredUnique identifier for the spend item in the campaign to be updated.
spend_item_namestringRequiredThe new name for the campaign spend item. This should be a descriptive string defining the spend item.
spend_orderintegerRequiredThe order or sequence number of the spend item within the campaign. It determines the priority or arrangement of the spend items.
spend_item_descriptionstringOptionalDetails or notes about the campaign spend item.

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'put-/marketing/v3/campaigns/{campaignGuid}/spend/{spendId}'.
#

HubspotMarketingApi.UpdateEmailDraft

Create or update the draft version of a marketing email. This tool creates or updates the draft version of a marketing email. If no draft exists, it creates a draft from the current live email and applies changes. Use this tool to modify email drafts before finalizing them. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
email_idstringOptionalThe unique identifier of the marketing email to update or create a draft for. This is required to specify which email draft you are modifying. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'patch-/marketing/v3/emails/{emailId}/draft'.
#

HubspotMarketingApi.UpdateHubspotForm

Update all fields of a HubSpot form. Use this tool to update every field in a specified HubSpot form by replacing the current form definition. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
hubspot_form_idstringOptionalThe unique identifier for the HubSpot form to update. This ID specifies which form's fields will be replaced. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'put-/marketing/v3/forms/{formId}_replace'.
#

HubspotMarketingApi.UpdateHubspotMarketingForm

Update components of a HubSpot marketing form. Use this tool to modify specific components of an existing marketing form in HubSpot by providing the form ID. Ideal for updating form details without creating a new form. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
form_idstringOptionalThe unique identifier for the form to update. Must be provided to specify which form's components to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'patch-/marketing/v3/forms/{formId}_update'.
#

HubspotMarketingApi.UpdateMarketingEmailProperties

Change properties of a marketing email. Use this tool to update properties of an existing marketing email by specifying the email ID. It helps in modifying content or settings of your marketing campaigns. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
email_identifierstringOptionalThe unique identifier of the marketing email to be updated. Required to specify which email's properties are being changed. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'patch-/marketing/v3/emails/{emailId}'.
#

HubspotMarketingApi.UpdateMarketingEventDetails

Update details of an existing marketing event. Use this tool to update the details of an existing marketing event identified by its external event ID. It is applicable only for events created by the same app. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query 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, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
external_account_idstringOptionalThe account ID associated with this marketing event in the external event application. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
external_event_idstringOptionalThe unique identifier of the marketing event in the external event application. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'patch-/marketing/v3/marketing-events/events/{externalEventId}_update'.
#

HubspotMarketingApi.UpdateMarketingEventsBatch

Update multiple marketing events by objectId. This tool updates multiple marketing events in the HubSpot portal based on their objectId, if they exist. It should be called when you need to batch update event details efficiently. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/marketing-events/batch/update_updateByObjectId'.
#

HubspotMarketingApi.UpsertMarketingEvent

Upsert a marketing event in HubSpot. Upserts a marketing event using the provided external event ID. If an event with that ID exists, it updates the event; otherwise, it creates a new one. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
external_event_idstringOptionalThe ID of the marketing event in the external application. Used to upsert the event in HubSpot. Required when mode is 'execute', ignored when mode is 'get_request_schema'.
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'put-/marketing/v3/marketing-events/events/{externalEventId}_upsert'.
#

HubspotMarketingApi.UpsertMarketingEvents

Upsert multiple marketing events in HubSpot. Upserts multiple marketing events. Updates existing events with the same ID or creates new ones if they don't exist. Only events created by the same app can be updated. 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.

Parameters

ParameterTypeReq.Description
modestringRequiredOperation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operation
get_request_schemaexecute
request_bodystringOptionalStringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema'

Requirements

No secrets required

Output

Type:json— Response from the API endpoint 'post-/marketing/v3/marketing-events/events/upsert_upsert'.
Last updated on