HubSpot connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Set up the connector

   Register your HubSpot credentials with Scalekit so it handles the token lifecycle. You do this once per environment.

   Dashboard setup steps

   Register your Scalekit environment with the HubSpot connector so Scalekit handles the authentication flow and token lifecycle for you. The connection name you create will be used to identify and invoke the connection programmatically. Then complete the configuration in your application as follows:

   1. Set up auth redirects

      • In Scalekit dashboard, go to AgentKit > Connections > Create Connection. Find HubSpot and click Create. Copy the redirect URI. It looks like https://<SCALEKIT_ENVIRONMENT_URL>/sso/v1/oauth/<CONNECTION_ID>/callback.

        

      • Log in to your HubSpot developer dashboard, click Manage apps, click Create app, and select Public app. If you already have an existing HubSpot app, open that app instead — see the Choosing a HubSpot app type section above for guidance on Public, Private, and legacy apps.

      • Go to Auth > Auth settings > Redirect URL, paste the redirect URI from Scalekit, and click Save.

        

      • Under Auth > Auth settings > Scopes, select the scopes your application needs. The scopes you select here must match exactly what you configure in Scalekit. For a read-only CRM enrichment flow, start with:

        crm.objects.contacts.read
        crm.objects.companies.read
        crm.objects.deals.read

        These assume a modern Public app with dotted scope names. For legacy apps or the full scope reference, see the Required and optional scopes section on this page.

   2. Get client credentials

      • In your HubSpot app, go to Auth > Auth settings.

      • Copy your Client ID and Client Secret.

   3. Add credentials in Scalekit

      • In Scalekit dashboard, go to AgentKit > Connections and open the connection you created.

      • Enter your credentials:

        • Client ID (from your HubSpot app)
        • Client Secret (from your HubSpot app)
        • Permissions (OAuth scope strings such as crm.objects.contacts.read, entered exactly as configured in the HubSpot app). For a full list of available scopes and guidance on optional scopes, see the Required and optional scopes section on this page.

        

      • Click Save.

4. Authorize and make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'hubspot'
   const identifier = 'user_123'
   
   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize HubSpot:', link)
   process.stdout.write('Press Enter after authorizing...')
   await new Promise(r => process.stdin.once('data', r))
   
   // Make your first call — list CRM owners
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'hubspot_owners_list',
     toolInput: {},
   })
   console.log('HubSpot owners:', result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "hubspot"
   identifier = "user_123"
   
   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize HubSpot:", link_response.link)
   input("Press Enter after authorizing...")
   
   # Make your first call — list CRM owners
   result = actions.execute_tool(
       tool_input={},
       tool_name="hubspot_owners_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print("HubSpot owners:", result)

What you can do

Connect this agent connector to let your agent:

• Manage contacts — create, update, search, and list contacts; batch create, update, upsert, read, and archive
• Manage companies and deals — create and update company records and deals; batch create, update, upsert, read, and archive
• Manage tickets and tasks — create and update support tickets; create tasks with due dates and priorities
• Batch operations with inline associations — create contacts, companies, deals, or tickets and link them to related records in a single call
• Log engagements — record calls, meetings, notes, and emails against any CRM record
• Search, associate, and extend — full-text search across all CRM objects, batch-manage associations, list owners, discover properties, and work with custom objects

Choosing a HubSpot app type

HubSpot has three app shapes. The shape you choose determines which OAuth flow, scope format, and Scalekit configuration apply.

App type	OAuth redirect	Scope format	Use with Scalekit
Public app	Supported	Modern (crm.objects.contacts.read)	Recommended
Private app	Not supported	N/A — static API token only	Not supported
Legacy / developer-account app	Supported	Bare strings (contacts, automation)	Supported — enter bare strings in Permissions

Public apps are the standard choice for production integrations. They support the OAuth redirect flow that Scalekit manages, and they use the modern dotted scope format.

Private apps issue static API tokens and have no OAuth redirect endpoint. Scalekit’s HubSpot connector requires an OAuth flow, so Private apps are not compatible.

Legacy apps (older apps created in HubSpot developer test accounts before the current console) still support OAuth but use an older scope vocabulary. If you already have a legacy app, you can connect it — you just need to enter the older bare scope strings exactly as HubSpot lists them in that app’s Auth > Scopes page.

Legacy app scope strings

Legacy HubSpot apps reject the modern crm.objects.* format. Copy scope strings from your app’s Auth > Scopes screen in HubSpot and paste them into Scalekit’s Permissions field as-is.

Common workflows

Proxy API call

Node.js

const result = await actions.request({
  connectionName: 'hubspot',
  identifier: 'user_123',
  path: '/crm/v3/owners',
  method: 'GET',
});
console.log(result);

Python

result = actions.request(
    connection_name='hubspot',
    identifier='user_123',
    path="/crm/v3/owners",
    method="GET"
)
print(result)

Create a contact

Node.js

const contact = await actions.executeTool({
  connector: 'hubspot',
  identifier: 'user_123',
  toolName: 'hubspot_contact_create',
  toolInput: {
    email: 'jane.smith@acme.com',
    firstname: 'Jane',
    lastname: 'Smith',
    jobtitle: 'VP of Engineering',
    company: 'Acme Corp',
    lifecyclestage: 'lead',
  },
});
console.log('Created contact ID:', contact.id);

Python

contact = actions.execute_tool(
    connection_name='hubspot',
    identifier='user_123',
    tool_name="hubspot_contact_create",
    tool_input={
        "email": "jane.smith@acme.com",
        "firstname": "Jane",
        "lastname": "Smith",
        "jobtitle": "VP of Engineering",
        "company": "Acme Corp",
        "lifecyclestage": "lead",
    },
)
print("Created contact ID:", contact["id"])

Search deals

Node.js

const deals = await actions.executeTool({
  connector: 'hubspot',
  identifier: 'user_123',
  toolName: 'hubspot_deals_search',
  toolInput: {
    query: 'enterprise',
    filterGroups: JSON.stringify([{
      filters: [{ propertyName: 'dealstage', operator: 'EQ', value: 'qualifiedtobuy' }]
    }]),
    properties: 'dealname,amount,dealstage,closedate',
    limit: 10,
  },
});
console.log('Found deals:', deals.results);

Python

import json

deals = actions.execute_tool(
    connection_name='hubspot',
    identifier='user_123',
    tool_name="hubspot_deals_search",
    tool_input={
        "query": "enterprise",
        "filterGroups": json.dumps([{
            "filters": [{"propertyName": "dealstage", "operator": "EQ", "value": "qualifiedtobuy"}]
        }]),
        "properties": "dealname,amount,dealstage,closedate",
        "limit": 10,
    },
)
print("Found deals:", deals["results"])

Log a call

Node.js

const call = await actions.executeTool({
  connector: 'hubspot',
  identifier: 'user_123',
  toolName: 'hubspot_call_log',
  toolInput: {
    hs_call_title: 'Q4 Renewal Discussion',
    hs_timestamp: new Date().toISOString(),
    hs_call_body: 'Discussed renewal terms. Customer is interested in the enterprise plan.',
    hs_call_direction: 'OUTBOUND',
    hs_call_duration: 900000, // 15 minutes in ms
    hs_call_status: 'COMPLETED',
  },
});
console.log('Logged call ID:', call.id);

Python

from datetime import datetime, timezone

call = actions.execute_tool(
    connection_name='hubspot',
    identifier='user_123',
    tool_name="hubspot_call_log",
    tool_input={
        "hs_call_title": "Q4 Renewal Discussion",
        "hs_timestamp": datetime.now(timezone.utc).isoformat(),
        "hs_call_body": "Discussed renewal terms. Customer is interested in the enterprise plan.",
        "hs_call_direction": "OUTBOUND",
        "hs_call_duration": 900000,  # 15 minutes in ms
        "hs_call_status": "COMPLETED",
    },
)
print("Logged call ID:", call["id"])

Create and associate a ticket

Node.js

// Create the ticket
const ticket = await actions.executeTool({
  connector: 'hubspot',
  identifier: 'user_123',
  toolName: 'hubspot_ticket_create',
  toolInput: {
    subject: 'Cannot export data to CSV',
    hs_pipeline_stage: '1', // "New" stage
    content: 'Customer reports that the CSV export button is unresponsive on the Reports page.',
    hs_ticket_priority: 'HIGH',
  },
});

// Associate with a contact
await actions.executeTool({
  connector: 'hubspot',
  identifier: 'user_123',
  toolName: 'hubspot_association_create',
  toolInput: {
    from_object_type: 'tickets',
    from_object_id: ticket.id,
    to_object_type: 'contacts',
    to_object_id: '12345',
  },
});
console.log('Ticket created and associated:', ticket.id);

Python

# Create the ticket
ticket = actions.execute_tool(
    connection_name='hubspot',
    identifier='user_123',
    tool_name="hubspot_ticket_create",
    tool_input={
        "subject": "Cannot export data to CSV",
        "hs_pipeline_stage": "1",  # "New" stage
        "content": "Customer reports that the CSV export button is unresponsive on the Reports page.",
        "hs_ticket_priority": "HIGH",
    },
)

# Associate with a contact
actions.execute_tool(
    connection_name='hubspot',
    identifier='user_123',
    tool_name="hubspot_association_create",
    tool_input={
        "from_object_type": "tickets",
        "from_object_id": ticket["id"],
        "to_object_type": "contacts",
        "to_object_id": "12345",
    },
)
print("Ticket created and associated:", ticket["id"])

Required and optional scopes

HubSpot’s OAuth connection requires one scope and supports up to 23 optional scopes. Grant only the scopes your tools actually need — a smaller scope set means a simpler consent screen and a faster app review for public listings.

Required scope

oauth — included automatically on every HubSpot connection. You do not need to add it manually.

Optional scopes

Add scopes that match the tools you plan to call. Common choices:

Scope	Enables
crm.objects.contacts.read	Read contacts
crm.objects.contacts.write	Create and update contacts
crm.objects.companies.read	Read companies
crm.objects.companies.write	Create and update companies
crm.objects.deals.read	Read deals
crm.objects.deals.write	Create and update deals
crm.objects.line_items.read	Read line items
crm.objects.line_items.write	Create and update line items
crm.objects.quotes.read	Read quotes
crm.lists.read	Read contact lists
crm.lists.write	Create and manage contact lists
tickets	Read and write support tickets
forms	Read forms and form submissions
automation	Read and trigger workflows and engagements
e-commerce	Products and orders

See HubSpot’s scope reference for the full list.

Configure optional scopes in your HubSpot app

In your HubSpot app, go to Auth > Auth settings > Scopes. You’ll see three categories: Required scopes (always requested), Conditionally required scopes, and Optional scopes (requested only when the user’s account has access to them).

Click Add new scope and select the optional scopes your app needs. Optional scopes let users without access to a feature still install your app — HubSpot simply skips those scopes at consent time.

Enable the same optional scopes in Scalekit

1. Open the connection in AgentKit > Connections.
2. In the Permissions field, enter the scopes you need, space-separated. Example for a read-only CRM flow: crm.objects.contacts.read crm.objects.companies.read crm.objects.deals.read.
3. Make sure the scope set here matches exactly what you’ve configured in your HubSpot app. A mismatch causes an invalid_scope error when the user authorizes.

Keep scope sets aligned

Your Scalekit connection, your HubSpot app, and any SDK calls must use the same scope set. The safest workflow: configure scopes in your HubSpot app first, then copy them into Scalekit’s Permissions field.

Getting resource IDs

Most HubSpot batch and update tools require record IDs. Always fetch IDs from the API — never guess or hard-code them.

Resource	Tool to get ID	Field in response
Contact ID	hubspot_contacts_search or hubspot_contacts_list	results[].id
Company ID	hubspot_companies_search	results[].id
Deal ID	hubspot_deals_search	results[].id
Ticket ID	hubspot_tickets_search	results[].id
Line Item ID	hubspot_deal_line_items_get	results[].id
Product ID	hubspot_products_list	results[].id
Owner ID	hubspot_owners_list	results[].id
Pipeline ID	hubspot_deal_pipelines_list	results[].id
Pipeline Stage ID	hubspot_deal_pipelines_list	results[].stages[].id
Custom Object Type ID	hubspot_schemas_list	results[].objectTypeId
Custom Object Record ID	hubspot_custom_object_records_search	results[].id
Quote ID	hubspot_quote_get	id

Association type IDs

When linking records, use the correct association_type_id for the object pair:

From → To	Association Type ID
Contact → Company (primary)	1
Contact → Company	279
Contact → Deal	4
Contact → Ticket	15
Deal → Contact	3
Deal → Company	5
Ticket → Contact	16
Ticket → Company	340
Line Item → Deal	20
Company → Contact	280
Company → Deal	6

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

hubspot_account_details_get#Retrieve account details for the HubSpot portal including hub ID, timezone, currency, and data hosting location.2 params▾

Retrieve account details for the HubSpot portal including hub ID, timezone, currency, and data hosting location.

NameTypeRequiredDescription

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_association_create#Create a default association between two HubSpot CRM objects. For example, associate a contact with a deal, or a company with a ticket.4 params▾

Create a default association between two HubSpot CRM objects. For example, associate a contact with a deal, or a company with a ticket.

NameTypeRequiredDescription

from_object_idstringrequiredID of the source object

from_object_typestringrequiredType of the source object (e.g. contacts, companies, deals, tickets)

to_object_idstringrequiredID of the target object

to_object_typestringrequiredType of the target object (e.g. contacts, companies, deals, tickets)

hubspot_association_label_create#Create a new association label between two CRM object types.7 params▾

Create a new association label between two CRM object types.

NameTypeRequiredDescription

from_object_typestringrequiredFrom object type.

labelstringrequiredLabel display text.

namestringrequiredLabel name.

to_object_typestringrequiredTo object type.

inverse_labelstringoptionalInverse label.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_association_label_delete#Delete a custom association label definition.5 params▾

Delete a custom association label definition.

NameTypeRequiredDescription

association_type_idstringrequiredAssociation type ID.

from_object_typestringrequiredFrom object type.

to_object_typestringrequiredTo object type.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_association_label_update#Update an existing association label definition.7 params▾

Update an existing association label definition.

NameTypeRequiredDescription

association_type_idstringrequiredAssociation type ID.

from_object_typestringrequiredFrom object type.

labelstringrequiredLabel display text.

to_object_typestringrequiredTo object type.

inverse_labelstringoptionalInverse label.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_association_labels_list#List all association label definitions between two CRM object types.4 params▾

List all association label definitions between two CRM object types.

NameTypeRequiredDescription

from_object_typestringrequiredFrom object type.

to_object_typestringrequiredTo object type.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_association_set#Create or update a labeled association between two CRM records.8 params▾

Create or update a labeled association between two CRM records.

NameTypeRequiredDescription

association_categorystringrequiredAssociation category.

association_type_idintegerrequiredAssociation type ID.

object_idstringrequiredFrom object ID.

object_typestringrequiredFrom object type.

to_object_idstringrequiredTo object ID.

to_object_typestringrequiredTo object type.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_associations_batch_archive#Remove an association between two HubSpot CRM objects using the v4 associations API.3 params▾

Remove an association between two HubSpot CRM objects using the v4 associations API.

NameTypeRequiredDescription

from_object_typestringrequiredThe type of the source object

inputsstringrequiredJSON array of associations to archive in HubSpot v4 format.

to_object_typestringrequiredThe type of the target object

hubspot_associations_batch_create#Create one or more associations between HubSpot records using the batch API. Pass arrays of IDs — up to 100 pairs per call.3 params▾

Create one or more associations between HubSpot records using the batch API. Pass arrays of IDs — up to 100 pairs per call.

NameTypeRequiredDescription

from_object_typestringrequiredObject type of the source records (e.g. contacts, deals, companies, tickets)

inputsstringrequiredJSON array of association objects in HubSpot v4 format.

to_object_typestringrequiredObject type of the target records (e.g. deals, companies, contacts, tickets)

hubspot_audit_logs_get#Retrieve account audit logs filtered by user, event type, object type, or date range.9 params▾

Retrieve account audit logs filtered by user, event type, object type, or date range.

NameTypeRequiredDescription

acting_user_idintegeroptionalFilter by user ID who performed the action.

afterstringoptionalPagination cursor.

fill_final_timestampbooleanoptionalInclude final timestamp in response.

limitintegeroptionalMaximum number of results per page.

occurred_afterstringoptionalReturn logs after this timestamp.

occurred_beforestringoptionalReturn logs before this timestamp.

schema_versionstringoptionalSchema version

sortstringoptionalSort parameters.

tool_versionstringoptionalTool version

hubspot_bulk_export#Initiate a bulk export of CRM records for the specified object type.15 params▾

Initiate a bulk export of CRM records for the specified object type.

NameTypeRequiredDescription

export_namestringrequiredName for the export.

export_typestringrequiredType of export.

formatstringrequiredFile format for the export.

include_labeled_associationsstringrequiredInclude labeled associations.

include_primary_display_propertystringrequiredInclude primary display property for associated objects.

languagestringrequiredLanguage for the export.

object_propertiesstringrequiredProperties to include in the export.

object_typestringrequiredCRM object type to export.

override_association_limitstringrequiredOverride 1000 association limit per row.

associated_object_typestringoptionalAssociated object types to include.

export_internal_values_optionsstringoptionalHow to export internal values.

list_idstringoptionalList ID for LIST exports.

public_crm_search_requestobjectoptionalAdvanced filter and sort criteria for the export.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_bulk_export_status#Check the status of a bulk export job and retrieve the download URL when complete.3 params▾

Check the status of a bulk export job and retrieve the download URL when complete.

NameTypeRequiredDescription

export_idstringrequiredExport job ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_call_get#Retrieve a single call engagement by its ID.8 params▾

Retrieve a single call engagement by its ID.

NameTypeRequiredDescription

call_idstringrequiredCall ID.

archivedbooleanoptionalReturn archived record.

associationsstringoptionalAssociations to return.

id_propertystringoptionalID property name.

propertiesstringoptionalProperties to return.

properties_with_historystringoptionalProperties with history.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_call_log#Log a call engagement in HubSpot CRM. Records details of a phone call including title, duration, notes, status, and direction.6 params▾

Log a call engagement in HubSpot CRM. Records details of a phone call including title, duration, notes, status, and direction.

NameTypeRequiredDescription

hs_call_titlestringrequiredTitle or subject of the call

hs_timestampstringrequiredDate and time when the call took place (ISO 8601 format)

hs_call_bodystringoptionalNotes or transcript from the call

hs_call_directionstringoptionalDirection of the call

hs_call_durationnumberoptionalDuration of the call in milliseconds

hs_call_statusstringoptionalOutcome status of the call

hubspot_call_transcript_get#Retrieve the full transcript for a recorded HubSpot call by transcript ID.1 param▾

Retrieve the full transcript for a recorded HubSpot call by transcript ID.

NameTypeRequiredDescription

transcript_idstringrequiredThe unique ID of the call transcript.

hubspot_call_update#Update an existing call engagement in HubSpot CRM by call ID. Provide any fields to update — only the fields you include will be changed.11 params▾

Update an existing call engagement in HubSpot CRM by call ID. Provide any fields to update — only the fields you include will be changed.

NameTypeRequiredDescription

call_idstringrequiredID of the call to update

hs_call_bodystringoptionalNotes or transcript from the call

hs_call_directionstringoptionalDirection of the call

hs_call_durationnumberoptionalDuration of the call in milliseconds

hs_call_from_numberstringoptionalPhone number the call originated from

hs_call_recording_urlstringoptionalHTTPS URL pointing to the call recording (.mp3 or .wav)

hs_call_statusstringoptionalOutcome status of the call

hs_call_titlestringoptionalTitle or subject of the call

hs_call_to_numberstringoptionalPhone number that received the call

hs_timestampstringoptionalDate and time when the call took place

hubspot_owner_idstringoptionalID of the HubSpot owner associated with the call

hubspot_calls_search#Search HubSpot call engagements using filters and full-text search. Returns logged calls with their properties.5 params▾

Search HubSpot call engagements using filters and full-text search. Returns logged calls with their properties.

NameTypeRequiredDescription

afterstringoptionalPagination offset to get results starting from a specific position

filterGroupsstringoptionalJSON string containing filter groups for advanced filtering

limitnumberoptionalNumber of results to return per page (max 100)

propertiesstringoptionalComma-separated list of properties to include in the response

querystringoptionalFull-text search term across call properties

hubspot_campaign_asset_create#Associate a marketing asset with a HubSpot campaign. Supported asset types include BLOG_POST, LANDING_PAGE, MARKETING_EMAIL, CTA, FORM, VIDEO, SOCIAL_POST, WORKFLOW, and more.5 params▾

Associate a marketing asset with a HubSpot campaign. Supported asset types include BLOG_POST, LANDING_PAGE, MARKETING_EMAIL, CTA, FORM, VIDEO, SOCIAL_POST, WORKFLOW, and more.

NameTypeRequiredDescription

assetIdstringrequiredThe unique ID of the asset to associate.

assetTypestringrequiredType of asset. Accepted values: MARKETING_EMAIL, LANDING_PAGE, BLOG_POST, CTA, SOCIAL.

campaignGuidstringrequiredThe unique GUID of the campaign.

schema_versionstringoptionalOptional schema version

tool_versionstringoptionalOptional tool version

hubspot_campaign_asset_delete#Remove the association between a marketing asset and a campaign.5 params▾

Remove the association between a marketing asset and a campaign.

NameTypeRequiredDescription

assetIdstringrequiredThe unique ID of the asset to disassociate.

assetTypestringrequiredType of asset to disassociate.

campaignGuidstringrequiredThe unique GUID of the campaign.

schema_versionstringoptionalOptional schema version

tool_versionstringoptionalOptional tool version

hubspot_campaign_assets_get#List all assets of a specific type associated with a HubSpot campaign. Optionally include asset metrics by providing startDate and endDate.8 params▾

List all assets of a specific type associated with a HubSpot campaign. Optionally include asset metrics by providing startDate and endDate.

NameTypeRequiredDescription

assetTypestringrequiredType of assets to retrieve. Accepted values: MARKETING_EMAIL, LANDING_PAGE, BLOG_POST, CTA, SOCIAL.

campaignGuidstringrequiredThe unique GUID of the campaign.

afterstringoptionalPagination cursor from previous response paging.next.after.

endDatestringoptionalEnd date for asset metrics (YYYY-MM-DD).

limitstringoptionalMaximum number of results per page.

schema_versionstringoptionalOptional schema version

startDatestringoptionalStart date for asset metrics (YYYY-MM-DD).

tool_versionstringoptionalOptional tool version

hubspot_campaign_create#Create a new HubSpot marketing campaign.3 params▾

Create a new HubSpot marketing campaign.

NameTypeRequiredDescription

propertiesobjectrequiredCampaign property key-value pairs.

schema_versionstringoptionalOptional schema version

tool_versionstringoptionalOptional tool version

hubspot_campaign_delete#Permanently delete a HubSpot marketing campaign by its GUID.3 params▾

Permanently delete a HubSpot marketing campaign by its GUID.

NameTypeRequiredDescription

campaignGuidstringrequiredThe unique GUID of the campaign to delete.

schema_versionstringoptionalOptional schema version

tool_versionstringoptionalOptional tool version

hubspot_campaign_get#Retrieve details of a specific HubSpot marketing campaign by campaign ID.1 param▾

Retrieve details of a specific HubSpot marketing campaign by campaign ID.

NameTypeRequiredDescription

campaign_idstringrequiredID of the campaign to retrieve

hubspot_campaign_revenue_get#Retrieve revenue attribution report for a specific HubSpot marketing campaign.6 params▾

Retrieve revenue attribution report for a specific HubSpot marketing campaign.

NameTypeRequiredDescription

campaignGuidstringrequiredThe unique GUID of the campaign.

attributionModelstringoptionalRevenue attribution model for calculating deal revenue credit.

endDatestringoptionalEnd date for attribution data (YYYY-MM-DD).

schema_versionstringoptionalOptional schema version

startDatestringoptionalStart date for attribution data (YYYY-MM-DD).

tool_versionstringoptionalOptional tool version

hubspot_campaign_update#Update an existing HubSpot marketing campaign by its GUID.4 params▾

Update an existing HubSpot marketing campaign by its GUID.

NameTypeRequiredDescription

campaignGuidstringrequiredThe unique GUID of the campaign to update.

propertiesobjectrequiredCampaign property key-value pairs to update.

schema_versionstringoptionalOptional schema version

tool_versionstringoptionalOptional tool version

hubspot_campaigns_list#List all HubSpot marketing campaigns with pagination support.2 params▾

List all HubSpot marketing campaigns with pagination support.

NameTypeRequiredDescription

afterstringoptionalPagination cursor for the next page of results

limitnumberoptionalNumber of campaigns to return per page

hubspot_companies_batch_archive#Archive (soft delete) a company in HubSpot CRM using the batch archive API. Archived records are hidden from the UI but can be restored.1 param▾

Archive (soft delete) a company in HubSpot CRM using the batch archive API. Archived records are hidden from the UI but can be restored.

NameTypeRequiredDescription

inputsstringrequiredJSON array of record IDs to archive. Each item has an 'id' field.

hubspot_companies_batch_create#Create one or more companys in HubSpot using the batch API. Pass a list of records — up to 100 per call.1 param▾

Create one or more companys in HubSpot using the batch API. Pass a list of records — up to 100 per call.

NameTypeRequiredDescription

inputsstringrequiredJSON array of objects to create in HubSpot batch format.

hubspot_companies_batch_read#Retrieve a company record from HubSpot CRM using the batch read API. Returns the specified properties for the record.2 params▾

Retrieve a company record from HubSpot CRM using the batch read API. Returns the specified properties for the record.

NameTypeRequiredDescription

inputsstringrequiredJSON array of record IDs to read. Each item has an 'id' field.

propertiesstringoptionalJSON array of property names to return. Omit to get default properties.

hubspot_companies_batch_update#Update one or more companys in HubSpot using the batch API. Pass a list of records with IDs — up to 100 per call.1 param▾

Update one or more companys in HubSpot using the batch API. Pass a list of records with IDs — up to 100 per call.

NameTypeRequiredDescription

inputsstringrequiredJSON array of objects to update in HubSpot batch format.

hubspot_companies_batch_upsert#Upsert one or more companys in HubSpot using the batch API. Pass a list of records — up to 100 per call.1 param▾

Upsert one or more companys in HubSpot using the batch API. Pass a list of records — up to 100 per call.

NameTypeRequiredDescription

inputsstringrequiredJSON array of objects to upsert in HubSpot batch format.

hubspot_companies_merge#Merge two company records into one, keeping the primary company.4 params▾

Merge two company records into one, keeping the primary company.

NameTypeRequiredDescription

object_id_to_mergestringrequiredRecord ID to merge.

primary_object_idstringrequiredPrimary record ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_companies_search#Search HubSpot companies using full-text search and pagination. Returns matching companies with specified properties.5 params▾

Search HubSpot companies using full-text search and pagination. Returns matching companies with specified properties.

NameTypeRequiredDescription

afterstringoptionalPagination offset to get results starting from a specific position

filterGroupsstringoptionalJSON string containing filter groups for advanced filtering

limitnumberoptionalNumber of results to return per page (max 100)

propertiesarrayoptionalList of properties to include in the response

querystringoptionalSearch term for full-text search across company properties

hubspot_company_create#Create a new company in HubSpot CRM. Requires a company name as the unique identifier. Supports additional properties like domain, industry, phone, location, and revenue information.10 params▾

Create a new company in HubSpot CRM. Requires a company name as the unique identifier. Supports additional properties like domain, industry, phone, location, and revenue information.

NameTypeRequiredDescription

namestringrequiredCompany name (required, serves as primary identifier)

annualrevenuenumberoptionalAnnual revenue of the company

citystringoptionalCompany city location

countrystringoptionalCompany country location

descriptionstringoptionalCompany description or overview

domainstringoptionalCompany website domain

industrystringoptionalIndustry type of the company

numberofemployeesnumberoptionalNumber of employees at the company

phonestringoptionalCompany phone number

statestringoptionalCompany state or region

hubspot_company_get#Retrieve details of a specific company from HubSpot by company ID. Returns company properties and associated data.2 params▾

Retrieve details of a specific company from HubSpot by company ID. Returns company properties and associated data.

NameTypeRequiredDescription

company_idstringrequiredID of the company to retrieve

propertiesstringoptionalComma-separated list of properties to include in the response

hubspot_company_update#Update an existing company in HubSpot CRM by company ID. Provide any fields to update.12 params▾

Update an existing company in HubSpot CRM by company ID. Provide any fields to update.

NameTypeRequiredDescription

company_idstringrequiredID of the company to update

annualrevenuestringoptionalAnnual revenue of the company

citystringoptionalCity where the company is located

countrystringoptionalCountry where the company is located

descriptionstringoptionalDescription of the company

domainstringoptionalCompany website domain

industrystringoptionalIndustry the company operates in

namestringoptionalName of the company

numberofemployeesnumberoptionalNumber of employees at the company

phonestringoptionalCompany phone number

statestringoptionalState or region where the company is located

websitestringoptionalCompany website URL

hubspot_contact_create#Create a new contact in HubSpot CRM. Requires an email address as the unique identifier. Supports additional properties like name, company, phone, and lifecycle stage.9 params▾

Create a new contact in HubSpot CRM. Requires an email address as the unique identifier. Supports additional properties like name, company, phone, and lifecycle stage.

NameTypeRequiredDescription

emailstringrequiredPrimary email address for the contact (required, serves as unique identifier)

companystringoptionalCompany name where the contact works

firstnamestringoptionalFirst name of the contact

hs_lead_statusstringoptionalLead status of the contact

jobtitlestringoptionalJob title of the contact

lastnamestringoptionalLast name of the contact

lifecyclestagestringoptionalLifecycle stage of the contact

phonestringoptionalPhone number of the contact

websitestringoptionalPersonal or company website URL

hubspot_contact_email_events_get#Retrieve marketing email events for a specific contact by their email address. Returns open, click, bounce, and unsubscribe events.3 params▾

Retrieve marketing email events for a specific contact by their email address. Returns open, click, bounce, and unsubscribe events.

NameTypeRequiredDescription

emailstringrequiredEmail address of the contact to retrieve events for

eventTypestringoptionalFilter by event type (e.g., OPEN, CLICK, BOUNCE, UNSUBSCRIBE)

limitnumberoptionalNumber of events to return per page

hubspot_contact_get#Retrieve details of a specific contact from HubSpot by contact ID. Returns contact properties and associated data.2 params▾

Retrieve details of a specific contact from HubSpot by contact ID. Returns contact properties and associated data.

NameTypeRequiredDescription

contact_idstringrequiredID of the contact to retrieve

propertiesstringoptionalComma-separated list of properties to include in the response

hubspot_contact_list_membership_get#Retrieve all HubSpot lists that a specific contact belongs to, identified by contact ID.1 param▾

Retrieve all HubSpot lists that a specific contact belongs to, identified by contact ID.

NameTypeRequiredDescription

contact_idstringrequiredID of the contact to retrieve list memberships for

hubspot_contact_sequence_enrollments_get#Retrieve all sequence enrollments for a specific contact, showing which sequences they are currently enrolled in.1 param▾

Retrieve all sequence enrollments for a specific contact, showing which sequences they are currently enrolled in.

NameTypeRequiredDescription

contact_idstringrequiredThe ID of the contact whose sequence enrollments to retrieve.

hubspot_contact_update#Update an existing contact in HubSpot CRM by contact ID. Provide any fields to update.10 params▾

Update an existing contact in HubSpot CRM by contact ID. Provide any fields to update.

NameTypeRequiredDescription

contact_idstringrequiredID of the contact to update

companystringoptionalCompany name where the contact works

emailstringoptionalPrimary email address of the contact

firstnamestringoptionalFirst name of the contact

hs_lead_statusstringoptionalLead status of the contact

jobtitlestringoptionalJob title of the contact

lastnamestringoptionalLast name of the contact

lifecyclestagestringoptionalLifecycle stage of the contact

phonestringoptionalPhone number of the contact

websitestringoptionalWebsite URL of the contact

hubspot_contacts_batch_archive#Archive (soft delete) a contact in HubSpot CRM using the batch archive API. Archived records are hidden from the UI but can be restored.1 param▾

Archive (soft delete) a contact in HubSpot CRM using the batch archive API. Archived records are hidden from the UI but can be restored.

NameTypeRequiredDescription

inputsstringrequiredJSON array of record IDs to archive. Each item has an 'id' field.

hubspot_contacts_batch_create#Create one or more contacts in HubSpot using the batch API. Pass the inputs array in native HubSpot format — up to 100 records per call.1 param▾

Create one or more contacts in HubSpot using the batch API. Pass the inputs array in native HubSpot format — up to 100 records per call.

NameTypeRequiredDescription

inputsstringrequiredJSON array of contact objects in HubSpot batch format. Each item has a 'properties' object and optional 'associations' array.

hubspot_contacts_batch_read#Retrieve a contact record from HubSpot CRM using the batch read API. Returns the specified properties for the record.2 params▾

Retrieve a contact record from HubSpot CRM using the batch read API. Returns the specified properties for the record.

NameTypeRequiredDescription

inputsstringrequiredJSON array of record IDs to read. Each item has an 'id' field.

propertiesstringoptionalJSON array of property names to return. Omit to get default properties.

hubspot_contacts_batch_update#Update one or more contacts in HubSpot using the batch API. Pass a list of records with IDs — up to 100 per call.1 param▾

Update one or more contacts in HubSpot using the batch API. Pass a list of records with IDs — up to 100 per call.

NameTypeRequiredDescription

inputsstringrequiredJSON array of objects to update in HubSpot batch format.

hubspot_contacts_batch_upsert#Upsert one or more contacts in HubSpot using the batch API. Pass a list of records — up to 100 per call.1 param▾

Upsert one or more contacts in HubSpot using the batch API. Pass a list of records — up to 100 per call.

NameTypeRequiredDescription

inputsstringrequiredJSON array of objects to upsert in HubSpot batch format.

hubspot_contacts_list#Retrieve a list of contacts from HubSpot with filtering and pagination. Returns contact properties and supports pagination through cursor-based navigation.4 params▾

Retrieve a list of contacts from HubSpot with filtering and pagination. Returns contact properties and supports pagination through cursor-based navigation.

NameTypeRequiredDescription

afterstringoptionalPagination cursor to get the next set of results

archivedbooleanoptionalWhether to include archived contacts in the results

limitnumberoptionalNumber of results to return per page (max 100)

propertiesstringoptionalComma-separated list of properties to include in the response

hubspot_contacts_merge#Merge two contact records into one, keeping the primary contact.4 params▾

Merge two contact records into one, keeping the primary contact.

NameTypeRequiredDescription

object_id_to_mergestringrequiredRecord ID to merge.

primary_object_idstringrequiredPrimary record ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_contacts_search#Search HubSpot contacts using full-text search and pagination. Returns matching contacts with specified properties.5 params▾

Search HubSpot contacts using full-text search and pagination. Returns matching contacts with specified properties.

NameTypeRequiredDescription

afterstringoptionalPagination offset to get results starting from a specific position

filterGroupsstringoptionalJSON string containing filter groups for advanced filtering

limitnumberoptionalNumber of results to return per page (max 100)

propertiesarrayoptionalList of properties to include in the response

querystringoptionalSearch term for full-text search across contact properties

hubspot_custom_object_record_create#Create a new record for a HubSpot custom object type.2 params▾

Create a new record for a HubSpot custom object type.

NameTypeRequiredDescription

object_type_idstringrequiredThe object type ID of the custom object (e.g., contacts)

propertiesstringrequiredJSON object containing the properties for the new record

hubspot_custom_object_record_get#Retrieve a specific record of a HubSpot custom object by object type ID and record ID.3 params▾

Retrieve a specific record of a HubSpot custom object by object type ID and record ID.

NameTypeRequiredDescription

object_type_idstringrequiredThe object type ID of the custom object (e.g., contacts)

record_idstringrequiredID of the record to retrieve

propertiesstringoptionalComma-separated list of properties to include in the response

hubspot_custom_object_record_update#Update an existing record of a HubSpot custom object by object type ID and record ID. Use hubspot_schemas_list to discover available object type IDs and their properties.3 params▾

Update an existing record of a HubSpot custom object by object type ID and record ID. Use hubspot_schemas_list to discover available object type IDs and their properties.

NameTypeRequiredDescription

object_type_idstringrequiredThe object type ID of the custom object (e.g., contacts)

propertiesobjectrequiredKey-value pairs of custom object properties to update

record_idstringrequiredID of the record to update

hubspot_custom_object_records_search#Search records of a HubSpot custom object by object type ID. Use hubspot_schemas_list to find the objectTypeId for your custom object.6 params▾

Search records of a HubSpot custom object by object type ID. Use hubspot_schemas_list to find the objectTypeId for your custom object.

NameTypeRequiredDescription

object_type_idstringrequiredThe object type ID of the custom object (e.g., contacts)

afterstringoptionalPagination offset to get results starting from a specific position

filterGroupsstringoptionalJSON string containing filter groups for advanced filtering

limitnumberoptionalNumber of results to return per page (max 100)

propertiesstringoptionalComma-separated list of properties to include in the response

querystringoptionalFull-text search term across record properties

hubspot_deal_create#Create a new deal in HubSpot CRM. Requires dealname and dealstage. Supports additional properties like amount, pipeline, close date, and deal type.8 params▾

Create a new deal in HubSpot CRM. Requires dealname and dealstage. Supports additional properties like amount, pipeline, close date, and deal type.

NameTypeRequiredDescription

dealnamestringrequiredName of the deal (required)

dealstagestringrequiredCurrent stage of the deal (required)

amountnumberoptionalDeal amount/value

closedatestringoptionalExpected close date (YYYY-MM-DD format)

dealtypestringoptionalType of deal

descriptionstringoptionalDeal description

hs_prioritystringoptionalDeal priority (high, medium, low)

pipelinestringoptionalDeal pipeline

hubspot_deal_get#Retrieve details of a specific deal from HubSpot by deal ID. Returns deal properties and associated data.3 params▾

Retrieve details of a specific deal from HubSpot by deal ID. Returns deal properties and associated data.

NameTypeRequiredDescription

deal_idstringrequiredID of the deal to retrieve

associationsstringoptionalComma-separated list of object types to retrieve associations for

propertiesstringoptionalComma-separated list of properties to include in the response

hubspot_deal_line_items_get#Retrieve all line items associated with a specific HubSpot deal.1 param▾

Retrieve all line items associated with a specific HubSpot deal.

NameTypeRequiredDescription

deal_idstringrequiredID of the deal to retrieve line items for

hubspot_deal_pipelines_list#Retrieve all deal pipelines in HubSpot, including pipeline stages. Use this to get valid pipeline IDs and stage IDs for creating or updating deals.1 param▾

Retrieve all deal pipelines in HubSpot, including pipeline stages. Use this to get valid pipeline IDs and stage IDs for creating or updating deals.

NameTypeRequiredDescription

archivedstringoptionalInclude archived pipelines in the response

hubspot_deal_splits_read#Retrieve deal split records for a batch of deal IDs.3 params▾

Retrieve deal split records for a batch of deal IDs.

NameTypeRequiredDescription

inputsarrayrequiredDeal split IDs to read.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_deal_splits_upsert#Create or update deal splits for a batch of deals.3 params▾

Create or update deal splits for a batch of deals.

NameTypeRequiredDescription

inputsarrayrequiredDeal split inputs to upsert.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_deal_update#Update an existing deal in HubSpot CRM by deal ID. Provide any fields to update.9 params▾

Update an existing deal in HubSpot CRM by deal ID. Provide any fields to update.

NameTypeRequiredDescription

deal_idstringrequiredID of the deal to update

amountnumberoptionalUpdated deal amount/value

closedatestringoptionalUpdated expected close date (YYYY-MM-DD format)

dealnamestringoptionalUpdated name of the deal

dealstagestringoptionalUpdated stage of the deal

dealtypestringoptionalUpdated type of deal

descriptionstringoptionalUpdated deal description

hs_prioritystringoptionalUpdated deal priority

pipelinestringoptionalUpdated deal pipeline

hubspot_deals_batch_archive#Archive (soft delete) a deal in HubSpot CRM using the batch archive API. Archived records are hidden from the UI but can be restored.1 param▾

Archive (soft delete) a deal in HubSpot CRM using the batch archive API. Archived records are hidden from the UI but can be restored.

NameTypeRequiredDescription

inputsstringrequiredJSON array of record IDs to archive. Each item has an 'id' field.

hubspot_deals_batch_create#Create one or more deals in HubSpot using the batch API. Pass a list of records — up to 100 per call.1 param▾

Create one or more deals in HubSpot using the batch API. Pass a list of records — up to 100 per call.

NameTypeRequiredDescription

inputsstringrequiredJSON array of objects to create in HubSpot batch format.

hubspot_deals_batch_read#Retrieve a deal record from HubSpot CRM using the batch read API. Returns the specified properties for the record.2 params▾

Retrieve a deal record from HubSpot CRM using the batch read API. Returns the specified properties for the record.

NameTypeRequiredDescription

inputsstringrequiredJSON array of record IDs to read. Each item has an 'id' field.

propertiesstringoptionalJSON array of property names to return. Omit to get default properties.

hubspot_deals_batch_update#Update one or more deals in HubSpot using the batch API. Pass a list of records with IDs — up to 100 per call.1 param▾

Update one or more deals in HubSpot using the batch API. Pass a list of records with IDs — up to 100 per call.

NameTypeRequiredDescription

inputsstringrequiredJSON array of objects to update in HubSpot batch format.

hubspot_deals_batch_upsert#Upsert one or more deals in HubSpot using the batch API. Pass a list of records — up to 100 per call.1 param▾

Upsert one or more deals in HubSpot using the batch API. Pass a list of records — up to 100 per call.

NameTypeRequiredDescription

inputsstringrequiredJSON array of objects to upsert in HubSpot batch format.

hubspot_deals_merge#Merge two deal records of the same type into one, keeping the primary deal.4 params▾

Merge two deal records of the same type into one, keeping the primary deal.

NameTypeRequiredDescription

object_id_to_mergestringrequiredRecord ID to merge.

primary_object_idstringrequiredPrimary record ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_deals_search#Search HubSpot deals using full-text search and pagination. Returns matching deals with specified properties.5 params▾

Search HubSpot deals using full-text search and pagination. Returns matching deals with specified properties.

NameTypeRequiredDescription

afterstringoptionalPagination offset to get results starting from a specific position

filterGroupsstringoptionalJSON string containing filter groups for advanced filtering

limitnumberoptionalNumber of results to return per page (max 100)

propertiesarrayoptionalList of properties to include in the response

querystringoptionalSearch term for full-text search across deal properties

hubspot_email_create#Create an email engagement in HubSpot CRM to log an email interaction on a record's timeline. Use this to record sent, received, or forwarded emails against contacts, companies, or deals.8 params▾

Create an email engagement in HubSpot CRM to log an email interaction on a record's timeline. Use this to record sent, received, or forwarded emails against contacts, companies, or deals.

NameTypeRequiredDescription

hs_email_directionstringrequiredDirection the email was sent

hs_timestampstringrequiredDate and time of the email

hs_email_headersstringoptionalEmail headers as a JSON-escaped string containing sender and recipient details

hs_email_htmlstringoptionalHTML body of the email

hs_email_statusstringoptionalSend status of the email

hs_email_subjectstringoptionalSubject line of the email

hs_email_textstringoptionalPlain-text body of the email

hubspot_owner_idstringoptionalID of the HubSpot owner associated with the email

hubspot_email_engagement_get#Retrieve a single email engagement record by its ID.8 params▾

Retrieve a single email engagement record by its ID.

NameTypeRequiredDescription

email_idstringrequiredEmail ID.

archivedbooleanoptionalReturn archived record.

associationsstringoptionalAssociations to return.

id_propertystringoptionalID property name.

propertiesstringoptionalProperties to return.

properties_with_historystringoptionalProperties with history.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_email_statistics_histogram#Retrieve a time-series histogram of marketing email statistics (opens, clicks, deliveries, etc.) bucketed by a specified interval over a time range.5 params▾

Retrieve a time-series histogram of marketing email statistics (opens, clicks, deliveries, etc.) bucketed by a specified interval over a time range.

NameTypeRequiredDescription

endTimestampstringrequiredEnd of the time range for the histogram in ISO 8601 date-time format

intervalstringrequiredTime bucket interval for grouping histogram data

startTimestampstringrequiredStart of the time range for the histogram in ISO 8601 date-time format

afterstringoptionalPagination cursor to get the next set of results

emailIdsarrayoptionalList of marketing email IDs to filter histogram data by

hubspot_email_statistics_list#Retrieve aggregated send, open, click, and other statistics for marketing emails over a specified time range. Optionally filter by specific email IDs.4 params▾

Retrieve aggregated send, open, click, and other statistics for marketing emails over a specified time range. Optionally filter by specific email IDs.

NameTypeRequiredDescription

endTimestampstringrequiredEnd of the time range for statistics in ISO 8601 date-time format

startTimestampstringrequiredStart of the time range for statistics in ISO 8601 date-time format

emailIdsarrayoptionalList of marketing email IDs to filter statistics by

propertystringoptionalComma-separated list of metric properties to include in the response

hubspot_email_update#Update an existing email engagement in HubSpot CRM by email ID. Provide any fields to update — only the fields you include will be changed.9 params▾

Update an existing email engagement in HubSpot CRM by email ID. Provide any fields to update — only the fields you include will be changed.

NameTypeRequiredDescription

email_idstringrequiredID of the email engagement to update

hs_email_directionstringoptionalDirection the email was sent

hs_email_headersstringoptionalEmail headers as a JSON-escaped string containing sender and recipient details

hs_email_htmlstringoptionalHTML body of the email

hs_email_statusstringoptionalSend status of the email

hs_email_subjectstringoptionalSubject line of the email

hs_email_textstringoptionalPlain-text body of the email

hs_timestampstringoptionalDate and time of the email

hubspot_owner_idstringoptionalID of the HubSpot owner associated with the email

hubspot_emails_search#Search HubSpot email engagements (logged emails) using filters and full-text search. Returns logged email records with their properties.5 params▾

Search HubSpot email engagements (logged emails) using filters and full-text search. Returns logged email records with their properties.

NameTypeRequiredDescription

afterstringoptionalPagination offset to get results starting from a specific position

filterGroupsstringoptionalJSON string containing filter groups for advanced filtering

limitnumberoptionalNumber of results to return per page (max 100)

propertiesstringoptionalComma-separated list of properties to include in the response

querystringoptionalFull-text search term across email properties

hubspot_engagements_list#List engagements (notes, tasks, calls, emails, meetings) from HubSpot CRM. Supports filtering by engagement type and pagination.3 params▾

List engagements (notes, tasks, calls, emails, meetings) from HubSpot CRM. Supports filtering by engagement type and pagination.

NameTypeRequiredDescription

engagement_typestringrequiredType of engagement to list

afterstringoptionalPagination cursor to get the next page of results

limitintegeroptionalNumber of results to return (max 100)

hubspot_export_details_get#Retrieve details and download URL for a completed bulk export job.3 params▾

Retrieve details and download URL for a completed bulk export job.

NameTypeRequiredDescription

task_idstringrequiredTask ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_export_get#Retrieve detailed information about a specific CRM export by its export ID.3 params▾

Retrieve detailed information about a specific CRM export by its export ID.

NameTypeRequiredDescription

export_idstringrequiredExport ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_feedback_submission_get#Retrieve a single feedback submission by ID, including survey type, response, and contact association.6 params▾

Retrieve a single feedback submission by ID, including survey type, response, and contact association.

NameTypeRequiredDescription

submission_idstringrequiredThe unique ID of the feedback submission.

archivedbooleanoptionalWhether to return only archived submissions.

associationsstringoptionalObject types to retrieve associated IDs for.

id_propertystringoptionalName of a unique property to use for lookup.

propertiesstringoptionalProperties to include in the response.

properties_with_historystringoptionalProperties to return with their full change history.

hubspot_feedback_submissions_list#List feedback survey submissions (NPS, CSAT, CES) from HubSpot with pagination.6 params▾

List feedback survey submissions (NPS, CSAT, CES) from HubSpot with pagination.

NameTypeRequiredDescription

afterstringoptionalPagination cursor from the previous response.

archivedbooleanoptionalWhether to return only archived submissions.

associationsstringoptionalObject types to retrieve associated IDs for.

limitintegeroptionalNumber of results per page (max 100).

propertiesstringoptionalProperties to include in the response.

properties_with_historystringoptionalProperties to return with their full change history.

hubspot_file_get#Retrieve metadata for a file stored in HubSpot by its file ID.4 params▾

Retrieve metadata for a file stored in HubSpot by its file ID.

NameTypeRequiredDescription

file_idstringrequiredFile ID.

propertiesstringoptionalProperties to return.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_file_signed_url_get#Get a signed download URL for a file in HubSpot. The URL expires after the specified duration.6 params▾

Get a signed download URL for a file in HubSpot. The URL expires after the specified duration.

NameTypeRequiredDescription

file_idstringrequiredFile ID.

expiration_secondsintegeroptionalExpiration seconds.

schema_versionstringoptionalSchema version

sizestringoptionalImage resize size.

tool_versionstringoptionalTool version

upscalebooleanoptionalUpscale image to fit size.

hubspot_files_search#Search files in HubSpot file manager by name, type, extension, date range, or size.19 params▾

Search files in HubSpot file manager by name, type, extension, date range, or size.

NameTypeRequiredDescription

afterstringoptionalPagination cursor.

allows_anonymous_accessbooleanoptionalPublic files only.

beforestringoptionalBefore timestamp.

created_at_gtestringoptionalCreated after.

created_at_ltestringoptionalCreated before.

extensionstringoptionalFile extension.

is_usable_in_contentbooleanoptionalUsable in content.

limitintegeroptionalPage size.

namestringoptionalFile name search.

pathstringoptionalFile path.

propertiesstringoptionalProperties to return.

schema_versionstringoptionalSchema version

size_gteintegeroptionalMin file size.

size_lteintegeroptionalMax file size.

sortstringoptionalSort field.

tool_versionstringoptionalTool version

typestringoptionalFile type.

updated_at_gtestringoptionalUpdated after.

updated_at_ltestringoptionalUpdated before.

hubspot_forecast_get#Retrieve a single forecast by its ID.8 params▾

Retrieve a single forecast by its ID.

NameTypeRequiredDescription

forecast_idstringrequiredForecast ID.

archivedbooleanoptionalReturn archived.

associationsstringoptionalAssociations to return.

id_propertystringoptionalID property name.

propertiesstringoptionalProperties to return.

properties_with_historystringoptionalProperties with history.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_forecast_types_list#Retrieve all available forecast type definitions.2 params▾

Retrieve all available forecast type definitions.

NameTypeRequiredDescription

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_forecasts_list#Retrieve a list of sales forecasts.8 params▾

Retrieve a list of sales forecasts.

NameTypeRequiredDescription

afterstringoptionalPagination cursor.

archivedbooleanoptionalReturn archived forecasts.

associationsstringoptionalAssociations to return.

limitintegeroptionalPage size.

propertiesstringoptionalProperties to return.

properties_with_historystringoptionalProperties with history.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_form_create#Create a new HubSpot form with fields, configuration, and submission settings.10 params▾

Create a new HubSpot form with fields, configuration, and submission settings.

NameTypeRequiredDescription

archivedbooleanrequiredWhether the form is archived.

configurationobjectrequiredForm configuration including post-submit action, language, lifecycle stages, and notification settings.

createdAtstringrequiredCreation timestamp in ISO 8601 format.

displayOptionsobjectrequiredVisual display options for the form including submit button text, CSS styling, and render mode.

fieldGroupsarrayrequiredArray of field groups defining the form layout and fields.

formTypestringrequiredType of form. Accepted values: hubspot, captured, flow, blog_comment, hubspot_internal.

legalConsentOptionsobjectrequiredGDPR legal consent configuration. Accepted types: none, implicit_consent_to_process, legitimate_interest, explicit_consent_to_process.

namestringrequiredDisplay name for the form.

schema_versionstringoptionalOptional schema version

tool_versionstringoptionalOptional tool version

hubspot_form_delete#Archive a HubSpot form definition. New submissions will not be accepted and the form will be permanently deleted after 3 months.3 params▾

Archive a HubSpot form definition. New submissions will not be accepted and the form will be permanently deleted after 3 months.

NameTypeRequiredDescription

formIdstringrequiredThe unique ID of the form to delete.

schema_versionstringoptionalOptional schema version

tool_versionstringoptionalOptional tool version

hubspot_form_submissions_get#Retrieve all submissions for a specific HubSpot form. Returns submitted field values and submission timestamps.3 params▾

Retrieve all submissions for a specific HubSpot form. Returns submitted field values and submission timestamps.

NameTypeRequiredDescription

form_idstringrequiredID of the form to retrieve submissions for

afterstringoptionalPagination offset token for the next page

limitnumberoptionalNumber of submissions to return per page

hubspot_form_update#Update all fields of a HubSpot form definition. This is a full update — all required fields must be provided.11 params▾

Update all fields of a HubSpot form definition. This is a full update — all required fields must be provided.

NameTypeRequiredDescription

archivedbooleanrequiredWhether the form is archived.

configurationobjectrequiredForm configuration including post-submit action, language, lifecycle stages, and notification settings.

createdAtstringrequiredCreation timestamp in ISO 8601 format.

displayOptionsobjectrequiredVisual display options for the form.

fieldGroupsarrayrequiredArray of field groups defining the form layout and fields.

formIdstringrequiredThe unique ID of the form to update.

formTypestringrequiredThe type of form.

legalConsentOptionsobjectrequiredGDPR legal consent configuration. Accepted types: none, implicit_consent_to_process, legitimate_interest, explicit_consent_to_process.

namestringrequiredThe display name of the form.

schema_versionstringoptionalOptional schema version

tool_versionstringoptionalOptional tool version

hubspot_forms_list#List all HubSpot marketing forms. Returns form IDs, names, and field definitions.3 params▾

List all HubSpot marketing forms. Returns form IDs, names, and field definitions.

NameTypeRequiredDescription

afterstringoptionalPagination cursor for the next page of results

formTypesstringoptionalComma-separated list of form types to filter by (e.g., hubspot,captured,flow)

limitnumberoptionalNumber of forms to return per page (max 50)

hubspot_goal_get#Retrieve a single HubSpot goal by its ID.3 params▾

Retrieve a single HubSpot goal by its ID.

NameTypeRequiredDescription

goal_idstringrequiredThe unique ID of the goal.

associationsstringoptionalComma-separated associated object types to include.

propertiesstringoptionalComma-separated list of properties to return.

hubspot_goal_target_delete#Permanently delete a goal target record.3 params▾

Permanently delete a goal target record.

NameTypeRequiredDescription

goal_target_idstringrequiredGoal target ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_goal_target_get#Retrieve a single HubSpot goal target by ID. Goal targets are the specific targets assigned to users within a goal.6 params▾

Retrieve a single HubSpot goal target by ID. Goal targets are the specific targets assigned to users within a goal.

NameTypeRequiredDescription

goal_target_idstringrequiredThe unique ID of the goal target.

archivedbooleanoptionalWhether to return only archived goal targets.

associationsstringoptionalObject types to retrieve associated IDs for.

id_propertystringoptionalName of a unique property to use for lookup.

propertiesstringoptionalProperties to include in the response.

properties_with_historystringoptionalProperties to return with full change history.

hubspot_goal_target_update#Update an existing goal target record by its ID.5 params▾

Update an existing goal target record by its ID.

NameTypeRequiredDescription

goal_target_idstringrequiredGoal target ID.

id_propertystringoptionalID property name.

propertiesobjectoptionalProperties to update.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_goal_targets_batch_update#Batch update multiple goal target records.3 params▾

Batch update multiple goal target records.

NameTypeRequiredDescription

inputsarrayrequiredGoal target updates.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_goal_targets_create#Create a new goal target record with specified properties and optional associations.4 params▾

Create a new goal target record with specified properties and optional associations.

NameTypeRequiredDescription

associationsarrayrequiredAssociations to link with this goal target.

propertiesobjectrequiredGoal target properties.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_goal_targets_list#List HubSpot goal targets — the specific targets assigned to users within goals — with optional property filters and pagination.6 params▾

List HubSpot goal targets — the specific targets assigned to users within goals — with optional property filters and pagination.

NameTypeRequiredDescription

afterstringoptionalPagination cursor from the previous response.

archivedbooleanoptionalWhether to return only archived goal targets.

associationsstringoptionalObject types to retrieve associated IDs for.

limitintegeroptionalNumber of results per page (max 100).

propertiesstringoptionalProperties to include in the response.

properties_with_historystringoptionalProperties to return with full change history.

hubspot_goals_list#List HubSpot goals with optional property selection and pagination.4 params▾

List HubSpot goals with optional property selection and pagination.

NameTypeRequiredDescription

afterstringoptionalPagination cursor from the previous response.

associationsstringoptionalComma-separated associated object types to include.

limitintegeroptionalNumber of results per page (max 100).

propertiesstringoptionalComma-separated list of properties to return.

hubspot_graphql_execute#Execute a GraphQL query against HubSpot data using the CRM GraphQL endpoint.5 params▾

Execute a GraphQL query against HubSpot data using the CRM GraphQL endpoint.

NameTypeRequiredDescription

querystringrequiredGraphQL query string.

operation_namestringoptionalOperation name.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

variablesobjectoptionalQuery variables.

hubspot_import_cancel#Cancel an active import job.3 params▾

Cancel an active import job.

NameTypeRequiredDescription

import_idstringrequiredImport ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_import_errors_get#Retrieve validation errors for a specific import job.7 params▾

Retrieve validation errors for a specific import job.

NameTypeRequiredDescription

import_idstringrequiredImport ID.

afterstringoptionalPagination cursor.

include_error_messagebooleanoptionalInclude error message.

include_row_databooleanoptionalInclude row data.

limitintegeroptionalPage size.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_import_get#Get details and status of a specific import job by its ID.3 params▾

Get details and status of a specific import job by its ID.

NameTypeRequiredDescription

import_idstringrequiredImport ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_imports_list#Retrieve all active and recently completed CRM imports.4 params▾

Retrieve all active and recently completed CRM imports.

NameTypeRequiredDescription

afterstringoptionalPagination cursor.

limitintegeroptionalPage size.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_inboxes_list#Retrieve all conversation inboxes in the HubSpot account.6 params▾

Retrieve all conversation inboxes in the HubSpot account.

NameTypeRequiredDescription

afterstringoptionalPagination cursor.

archivedbooleanoptionalReturn archived inboxes only.

limitintegeroptionalMaximum results per page.

schema_versionstringoptionalSchema version

sortstringoptionalSort parameters.

tool_versionstringoptionalTool version

hubspot_lead_create#Create a new lead in HubSpot CRM with optional pipeline stage and contact associations.5 params▾

Create a new lead in HubSpot CRM with optional pipeline stage and contact associations.

NameTypeRequiredDescription

associationsarrayrequiredObjects to associate with this lead.

hs_lead_namestringrequiredName of the lead.

hs_pipelinestringoptionalPipeline ID for this lead.

hs_pipeline_stagestringoptionalPipeline stage ID.

propertiesobjectoptionalAdditional lead properties as key-value pairs.

hubspot_lead_get#Retrieve a single HubSpot lead by its ID with specified properties.6 params▾

Retrieve a single HubSpot lead by its ID with specified properties.

NameTypeRequiredDescription

lead_idstringrequiredThe unique ID of the lead.

archivedbooleanoptionalWhether to return only archived leads.

associationsstringoptionalObject types to retrieve associated IDs for.

id_propertystringoptionalName of a unique property to use for lookup instead of the internal object ID.

propertiesstringoptionalProperties to include in the response.

properties_with_historystringoptionalProperties to return with full change history.

hubspot_lead_update#Update an existing HubSpot lead by ID. Only provided fields are modified.6 params▾

Update an existing HubSpot lead by ID. Only provided fields are modified.

NameTypeRequiredDescription

lead_idstringrequiredThe unique ID of the lead to update.

hs_lead_namestringoptionalUpdated lead name.

hs_pipelinestringoptionalUpdated pipeline ID.

hs_pipeline_stagestringoptionalUpdated pipeline stage ID.

id_propertystringoptionalName of a unique property to use for lookup instead of the internal object ID.

propertiesobjectoptionalAdditional lead properties as key-value pairs.

hubspot_leads_search#Search HubSpot leads using filters, full-text query, and property selection.6 params▾

Search HubSpot leads using filters, full-text query, and property selection.

NameTypeRequiredDescription

filterGroupsarrayrequiredFilter groups for advanced lead filtering.

limitintegerrequiredNumber of results to return (max 100).

propertiesarrayrequiredProperties to return for each lead.

sortsarrayrequiredSort criteria as property name strings.

afterstringoptionalPagination cursor from the previous response.

querystringoptionalFull-text search query across lead properties.

hubspot_line_item_create#Create a new line item in HubSpot. Line items represent individual products or services in a deal.5 params▾

Create a new line item in HubSpot. Line items represent individual products or services in a deal.

NameTypeRequiredDescription

namestringrequiredName of the line item

deal_idstringoptionalID of the deal to associate this line item with

hs_product_idstringoptionalID of the associated product from HubSpot product library

pricestringoptionalUnit price of the line item

quantitystringoptionalQuantity of the line item

hubspot_line_items_batch_archive#Archive (soft delete) a line item in HubSpot CRM using the batch archive API. Archived records are hidden from the UI but can be restored.1 param▾

Archive (soft delete) a line item in HubSpot CRM using the batch archive API. Archived records are hidden from the UI but can be restored.

NameTypeRequiredDescription

inputsstringrequiredJSON array of record IDs to archive. Each item has an 'id' field.

hubspot_line_items_batch_create#Create one or more line items in HubSpot using the batch API. Pass a list of records — up to 100 per call.1 param▾

Create one or more line items in HubSpot using the batch API. Pass a list of records — up to 100 per call.

NameTypeRequiredDescription

inputsstringrequiredJSON array of objects to create in HubSpot batch format.

hubspot_line_items_batch_read#Retrieve a line item record from HubSpot CRM using the batch read API. Returns the specified properties for the record.2 params▾

Retrieve a line item record from HubSpot CRM using the batch read API. Returns the specified properties for the record.

NameTypeRequiredDescription

inputsstringrequiredJSON array of record IDs to read. Each item has an 'id' field.

propertiesstringoptionalJSON array of property names to return. Omit to get default properties.

hubspot_line_items_batch_update#Update one or more line items in HubSpot using the batch API. Pass a list of records with IDs — up to 100 per call.1 param▾

Update one or more line items in HubSpot using the batch API. Pass a list of records with IDs — up to 100 per call.

NameTypeRequiredDescription

inputsstringrequiredJSON array of objects to update in HubSpot batch format.

hubspot_line_items_search#Search line item records using filters, sorting, and pagination.8 params▾

Search line item records using filters, sorting, and pagination.

NameTypeRequiredDescription

afterstringrequiredPagination cursor.

filter_groupsarrayrequiredFilter groups.

limitintegerrequiredPage size.

propertiesarrayrequiredProperties to return.

sortsarrayrequiredSort order.

querystringoptionalSearch query string.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_list_create#Create a new HubSpot CRM list for contacts, companies, or deals. Supports static (MANUAL), one-time snapshot (SNAPSHOT), and auto-updating dynamic (DYNAMIC) lists.8 params▾

Create a new HubSpot CRM list for contacts, companies, or deals. Supports static (MANUAL), one-time snapshot (SNAPSHOT), and auto-updating dynamic (DYNAMIC) lists.

NameTypeRequiredDescription

namestringrequiredDisplay name of the list. Must be unique across all public lists in the portal.

objectTypeIdstringrequiredObject type the list will contain. Use 0-1 for contacts, 0-2 for companies, 0-3 for deals.

processingTypestringrequiredHow list membership is determined. MANUAL for static lists, SNAPSHOT for a one-time filter run, DYNAMIC for continuously updated lists.

customPropertiesstringoptionalCustom key-value metadata to attach to the list.

filterBranchstringoptionalNested filter tree defining membership criteria for DYNAMIC or SNAPSHOT lists.

listFolderIdintegeroptionalID of the folder to place this list in. Defaults to the root folder if omitted.

listPermissionsstringoptionalTeams and users that should have edit access to this list, identified by their numeric HubSpot IDs.

membershipSettingsstringoptionalControls whether unassigned records are included in the list and which team owns the membership.

hubspot_list_delete#Permanently delete a HubSpot CRM list by its list ID. This removes the list definition but does not delete the records it contains.1 param▾

Permanently delete a HubSpot CRM list by its list ID. This removes the list definition but does not delete the records it contains.

NameTypeRequiredDescription

listIdstringrequiredThe ID of the list to delete.

hubspot_list_filters_update#Replace the filter branch of a DYNAMIC HubSpot list. The new filterBranch fully replaces the existing definition — include any filters you want to keep. The list immediately begins reprocessing its membership after the update.2 params▾

Replace the filter branch of a DYNAMIC HubSpot list. The new filterBranch fully replaces the existing definition — include any filters you want to keep. The list immediately begins reprocessing its membership after the update.

NameTypeRequiredDescription

filterBranchstringrequiredThe new filter branch definition that replaces the existing one. Must be a complete OR root branch with nested AND branches.

listIdstringrequiredThe ID of the list whose filters should be updated.

hubspot_list_get#Retrieve a specific CRM list by its list ID.4 params▾

Retrieve a specific CRM list by its list ID.

NameTypeRequiredDescription

list_idstringrequiredList ID.

include_filtersbooleanoptionalInclude filters.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_list_memberships_add#Add one or more records to a MANUAL HubSpot list by their record IDs.2 params▾

Add one or more records to a MANUAL HubSpot list by their record IDs.

NameTypeRequiredDescription

listIdstringrequiredID of the list to add contacts to.

recordIdsstringrequiredJSON array of contact record IDs to add to the list.

hubspot_list_memberships_get#Fetch memberships of a list sorted by recordId. Use after/before for pagination; after takes precedence over before when both are provided.6 params▾

Fetch memberships of a list sorted by recordId. Use after/before for pagination; after takes precedence over before when both are provided.

NameTypeRequiredDescription

list_idstringrequiredThe ILS ID of the list.

afterstringoptionalPaging offset token for the next page (ascending order).

beforestringoptionalPaging offset token for the previous page (descending order).

limitintegeroptionalNumber of records to return per page (max 250, default 100).

schema_versionstringoptionalOptional schema version to use for tool execution

tool_versionstringoptionalOptional tool version to use for execution

hubspot_list_memberships_remove#Remove one or more records from a MANUAL HubSpot list by their record IDs.2 params▾

Remove one or more records from a MANUAL HubSpot list by their record IDs.

NameTypeRequiredDescription

listIdstringrequiredID of the list to remove contacts from.

recordIdsstringrequiredJSON array of contact record IDs to remove from the list.

hubspot_list_name_update#Rename a HubSpot CRM list. The new name must be unique across all public lists in the portal. Optionally return filter definitions in the response by setting includeFilters to true.3 params▾

Rename a HubSpot CRM list. The new name must be unique across all public lists in the portal. Optionally return filter definitions in the response by setting includeFilters to true.

NameTypeRequiredDescription

listIdstringrequiredThe ID of the list to update.

listNamestringrequiredThe new name for the list.

includeFiltersbooleanoptionalWhether to include filter branch definitions in the response.

hubspot_list_restore#Restore a previously deleted CRM list by its list ID.3 params▾

Restore a previously deleted CRM list by its list ID.

NameTypeRequiredDescription

list_idstringrequiredList ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_lists_list#Retrieve all CRM lists with optional filters and pagination.4 params▾

Retrieve all CRM lists with optional filters and pagination.

NameTypeRequiredDescription

include_filtersbooleanoptionalInclude filter definitions in response.

list_idsstringoptionalFilter by specific list IDs.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_lists_search#Search CRM lists by name, IDs, object type, or processing type with pagination.10 params▾

Search CRM lists by name, IDs, object type, or processing type with pagination.

NameTypeRequiredDescription

additional_propertiesarrayrequiredAdditional properties.

countintegeroptionalPage size.

list_idsarrayoptionalList IDs to filter.

object_type_idstringoptionalObject type ID.

offsetintegeroptionalPagination offset.

processing_typesarrayoptionalProcessing types.

querystringoptionalSearch query.

schema_versionstringoptionalSchema version

sortstringoptionalSort.

tool_versionstringoptionalTool version

hubspot_marketing_email_create#Create a new HubSpot marketing email.23 params▾

Create a new HubSpot marketing email.

NameTypeRequiredDescription

namestringrequiredInternal name for the email.

activeDomainstringoptionalThe active domain of the email.

archivedbooleanoptionalSet to true to archive the email.

businessUnitIdintegeroptionalID of the business unit to associate with the email.

campaignstringoptionalCampaign GUID to associate this email with.

contentobjectoptionalEmail body content including flexAreas, widgets, and styleSettings.

feedbackSurveyIdstringoptionalThe ID of the feedback survey linked to the email.

folderIdV2integeroptionalID of the folder where the email will be stored.

fromobjectoptionalSender details: fromName, replyTo, customReplyTo.

jitterSendTimebooleanoptionalRandomize send time slightly to avoid all sends at exactly the same moment.

languagestringoptionalLanguage code, e.g. en, fr, de, es.

publishDatestringoptionalScheduled send date in ISO 8601 format.

rssDataobjectoptionalRSS email configuration: hubspotBlogId, url, maxEntries, timing.

schema_versionstringoptionalOptional schema version

sendOnPublishbooleanoptionalSet to true to send immediately on publish.

statestringoptionalEmail state. Common values: DRAFT, SCHEDULED, PUBLISHED.

subcategorystringoptionalEmail subcategory. Common values: batch, automated, blog_email, rss_to_email, localtime.

subjectstringoptionalEmail subject line.

subscriptionDetailsobjectoptionalSubscription configuration: subscriptionId, officeLocationId, preferencesGroupId.

testingobjectoptionalAB testing configuration.

toobjectoptionalRecipient configuration: contactLists, contactIlsLists, contactIds, suppressGraymail.

tool_versionstringoptionalOptional tool version

webversionobjectoptionalWeb version settings: enabled, slug, title, metaDescription, redirectToUrl.

hubspot_marketing_email_delete#Permanently delete a HubSpot marketing email by its ID.4 params▾

Permanently delete a HubSpot marketing email by its ID.

NameTypeRequiredDescription

emailIdstringrequiredThe ID of the marketing email to delete.

archivedbooleanoptionalFilter for archived emails.

schema_versionstringoptionalOptional schema version

tool_versionstringoptionalOptional tool version

hubspot_marketing_email_get#Retrieve a single marketing email by its ID, including subject, body, send configuration, and metadata.7 params▾

Retrieve a single marketing email by its ID, including subject, body, send configuration, and metadata.

NameTypeRequiredDescription

emailIdstringrequiredThe ID of the marketing email to retrieve

archivedbooleanoptionalWhether to return the email even if it has been archived

includedPropertiesstringoptionalComma-separated list of property names to include in the response, limiting which fields are returned

includeStatsbooleanoptionalWhether to include send, open, click, and other statistics in the response

marketingCampaignNamesbooleanoptionalWhether to include the names of marketing campaigns associated with the email

variantStatsbooleanoptionalWhether to include statistics broken down by A/B test variant

workflowNamesbooleanoptionalWhether to include the names of workflows in which this email is used

hubspot_marketing_email_update#Update an existing HubSpot marketing email by its ID.24 params▾

Update an existing HubSpot marketing email by its ID.

NameTypeRequiredDescription

emailIdstringrequiredThe ID of the marketing email to update.

activeDomainstringoptionalThe active domain of the email.

archivedbooleanoptionalSet to true to archive the email.

businessUnitIdintegeroptionalID of the business unit to associate with the email.

campaignstringoptionalCampaign GUID to associate this email with.

contentobjectoptionalEmail body content including flexAreas, widgets, and styleSettings.

feedbackSurveyIdstringoptionalThe ID of the feedback survey linked to the email.

folderIdV2integeroptionalID of the folder where the email will be stored.

fromobjectoptionalSender details: fromName, replyTo, customReplyTo.

jitterSendTimebooleanoptionalRandomize send time slightly to avoid all sends at exactly the same moment.

languagestringoptionalLanguage code, e.g. en, fr, de, es.

namestringoptionalInternal name for the email.

publishDatestringoptionalScheduled send date in ISO 8601 format.

rssDataobjectoptionalRSS email configuration: hubspotBlogId, url, maxEntries, timing.

schema_versionstringoptionalOptional schema version

sendOnPublishbooleanoptionalSet to true to send immediately on publish.

statestringoptionalEmail state. Common values: DRAFT, SCHEDULED, PUBLISHED.

subcategorystringoptionalEmail subcategory. Common values: batch, automated, blog_email, rss_to_email, localtime.

subjectstringoptionalEmail subject line shown to recipients.

subscriptionDetailsobjectoptionalSubscription configuration: subscriptionId, officeLocationId, preferencesGroupId.

testingobjectoptionalAB testing configuration.

toobjectoptionalRecipient configuration: contactLists, contactIlsLists, contactIds, suppressGraymail.

tool_versionstringoptionalOptional tool version

webversionobjectoptionalWeb version settings: enabled, slug, title, metaDescription, redirectToUrl.

hubspot_marketing_event_attendance_record#Record attendance for contacts at a marketing event.6 params▾

Record attendance for contacts at a marketing event.

NameTypeRequiredDescription

external_account_idstringrequiredExternal account ID.

external_event_idstringrequiredExternal event ID.

inputsarrayrequiredContacts to record attendance for.

subscriber_statestringrequiredSubscriber state.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_marketing_event_complete#Mark a marketing event as completed.6 params▾

Mark a marketing event as completed.

NameTypeRequiredDescription

end_date_timestringrequiredEvent end date and time.

external_account_idstringrequiredExternal account ID.

external_event_idstringrequiredExternal event ID.

start_date_timestringrequiredEvent start date and time.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_marketing_event_create#Create a new marketing event in HubSpot.14 params▾

Create a new marketing event in HubSpot.

NameTypeRequiredDescription

custom_propertiesarrayrequiredCustom properties for the marketing event.

event_namestringrequiredEvent name.

event_organizerstringrequiredEvent organizer name.

external_account_idstringrequiredExternal account ID.

external_event_idstringrequiredExternal event ID.

end_date_timestringoptionalEnd date/time.

event_cancelledbooleanoptionalWhether the event is cancelled.

event_completedbooleanoptionalWhether the event is completed.

event_descriptionstringoptionalEvent description.

event_typestringoptionalEvent type.

event_urlstringoptionalEvent URL.

schema_versionstringoptionalSchema version

start_date_timestringoptionalStart date/time.

tool_versionstringoptionalTool version

hubspot_marketing_event_get#Retrieve a single HubSpot marketing event by its external event ID and account ID.2 params▾

Retrieve a single HubSpot marketing event by its external event ID and account ID.

NameTypeRequiredDescription

external_account_idstringrequiredThe external account ID of the app that created the event.

external_event_idstringrequiredThe external event ID in the app that created the event.

hubspot_marketing_event_upsert#Create or update multiple marketing events in a single batch request.3 params▾

Create or update multiple marketing events in a single batch request.

NameTypeRequiredDescription

inputsarrayrequiredArray of marketing event objects to upsert.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_marketing_events_list#List HubSpot marketing events (webinars, conferences, virtual events) with optional filters and pagination.5 params▾

List HubSpot marketing events (webinars, conferences, virtual events) with optional filters and pagination.

NameTypeRequiredDescription

afterstringoptionalPagination cursor from the previous response.

limitintegeroptionalNumber of results per page.

object_idstringoptionalCRM object ID to get associated marketing events for.

object_typestringoptionalCRM object type to get associated marketing events for.

qstringoptionalSearch query to filter events by name.

hubspot_meeting_get#Retrieve a single meeting engagement by its ID.8 params▾

Retrieve a single meeting engagement by its ID.

NameTypeRequiredDescription

meeting_idstringrequiredMeeting ID.

archivedbooleanoptionalReturn archived record.

associationsstringoptionalAssociations to return.

id_propertystringoptionalID property name.

propertiesstringoptionalProperties to return.

properties_with_historystringoptionalProperties with history.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_meeting_links_list#List all HubSpot meeting scheduler links (booking pages) for the connected account.5 params▾

List all HubSpot meeting scheduler links (booking pages) for the connected account.

NameTypeRequiredDescription

afterstringoptionalPagination cursor from the previous response.

limitintegeroptionalNumber of meeting links to return per page.

namestringoptionalFilter meeting links by name.

organizer_user_idstringoptionalFilter meeting links by the organizer's HubSpot user ID.

typestringoptionalFilter by meeting link type.

hubspot_meeting_log#Log a meeting engagement in HubSpot CRM. Records details of a meeting including title, start/end time, description, and outcome.6 params▾

Log a meeting engagement in HubSpot CRM. Records details of a meeting including title, start/end time, description, and outcome.

NameTypeRequiredDescription

hs_meeting_end_timestringrequiredEnd time of the meeting (ISO 8601 format)

hs_meeting_start_timestringrequiredStart time of the meeting (ISO 8601 format)

hs_meeting_titlestringrequiredTitle of the meeting

hs_timestampstringrequiredTimestamp for the meeting (ISO 8601 format)

hs_meeting_bodystringoptionalDescription or agenda for the meeting

hs_meeting_outcomestringoptionalOutcome of the meeting

hubspot_meeting_update#Update an existing meeting engagement in HubSpot CRM by meeting ID. Provide any fields to update — only the fields you include will be changed.10 params▾

Update an existing meeting engagement in HubSpot CRM by meeting ID. Provide any fields to update — only the fields you include will be changed.

NameTypeRequiredDescription

meeting_idstringrequiredID of the meeting to update

hs_internal_meeting_notesstringoptionalInternal notes not shared with attendees

hs_meeting_bodystringoptionalDescription or agenda for the meeting

hs_meeting_end_timestringoptionalEnd time of the meeting (ISO 8601 format)

hs_meeting_locationstringoptionalLocation of the meeting

hs_meeting_outcomestringoptionalOutcome of the meeting

hs_meeting_start_timestringoptionalStart time of the meeting (ISO 8601 format)

hs_meeting_titlestringoptionalTitle of the meeting

hs_timestampstringoptionalTimestamp for the meeting (ISO 8601 format)

hubspot_owner_idstringoptionalID of the HubSpot owner associated with the meeting

hubspot_meetings_search#Search HubSpot meeting engagements using filters and full-text search. Returns logged meetings with their properties.5 params▾

Search HubSpot meeting engagements using filters and full-text search. Returns logged meetings with their properties.

NameTypeRequiredDescription

afterstringoptionalPagination offset to get results starting from a specific position

filterGroupsstringoptionalJSON string containing filter groups for advanced filtering

limitnumberoptionalNumber of results to return per page (max 100)

propertiesstringoptionalComma-separated list of properties to include in the response

querystringoptionalFull-text search term across meeting properties

hubspot_note_create#Create a note in HubSpot CRM to log interactions, meeting summaries, or important information. Notes can be associated with contacts, companies, or deals.1 param▾

Create a note in HubSpot CRM to log interactions, meeting summaries, or important information. Notes can be associated with contacts, companies, or deals.

NameTypeRequiredDescription

propsobjectrequiredNote properties. hs_note_body (required) is the note content. hs_timestamp (required) is Unix ms timestamp e.g. 1700000000000.

hubspot_note_get#Retrieve a single note engagement by its ID.8 params▾

Retrieve a single note engagement by its ID.

NameTypeRequiredDescription

note_idstringrequiredNote ID.

archivedbooleanoptionalReturn archived record.

associationsstringoptionalAssociations to return.

id_propertystringoptionalID property name.

propertiesstringoptionalProperties to return.

properties_with_historystringoptionalProperties with history.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_note_log#Log a note engagement in HubSpot CRM. Creates a text note that can be associated with contacts, companies, or deals.2 params▾

Log a note engagement in HubSpot CRM. Creates a text note that can be associated with contacts, companies, or deals.

NameTypeRequiredDescription

hs_note_bodystringrequiredContent of the note

hs_timestampstringrequiredTimestamp for the note (ISO 8601 format)

hubspot_note_update#Update an existing note in HubSpot CRM by note ID. Provide any fields to update — only the fields you include will be changed.4 params▾

Update an existing note in HubSpot CRM by note ID. Provide any fields to update — only the fields you include will be changed.

NameTypeRequiredDescription

note_idstringrequiredID of the note to update

hs_note_bodystringoptionalText content of the note

hs_timestampstringoptionalDate and time of the note

hubspot_owner_idstringoptionalID of the HubSpot owner associated with the note

hubspot_notes_search#Search HubSpot note engagements using filters and full-text search. Returns logged notes with their content and timestamps.5 params▾

Search HubSpot note engagements using filters and full-text search. Returns logged notes with their content and timestamps.

NameTypeRequiredDescription

afterstringoptionalPagination offset to get results starting from a specific position

filterGroupsstringoptionalJSON string containing filter groups for advanced filtering

limitnumberoptionalNumber of results to return per page (max 100)

propertiesstringoptionalComma-separated list of properties to include in the response

querystringoptionalFull-text search term across note content

hubspot_object_properties_list#Retrieve all properties defined for a HubSpot CRM object type (contacts, companies, deals, tickets, etc.).2 params▾

Retrieve all properties defined for a HubSpot CRM object type (contacts, companies, deals, tickets, etc.).

NameTypeRequiredDescription

object_typestringrequiredThe CRM object type to list properties for

archivedstringoptionalInclude archived properties in the response

hubspot_owners_list#List all HubSpot owners (users). Use this to find owner IDs for assigning contacts, deals, tickets, and other CRM records.3 params▾

List all HubSpot owners (users). Use this to find owner IDs for assigning contacts, deals, tickets, and other CRM records.

NameTypeRequiredDescription

afterstringoptionalPagination cursor for the next page of results

emailstringoptionalFilter owners by email address

limitnumberoptionalNumber of owners to return per page (max 500)

hubspot_pipeline_audit_log_get#Retrieve the audit log for a specific pipeline showing all changes made over time.4 params▾

Retrieve the audit log for a specific pipeline showing all changes made over time.

NameTypeRequiredDescription

object_typestringrequiredObject type.

pipeline_idstringrequiredPipeline ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_pipeline_create#Create a new pipeline for the specified object type.7 params▾

Create a new pipeline for the specified object type.

NameTypeRequiredDescription

display_orderintegerrequiredDisplay order.

labelstringrequiredPipeline label.

object_typestringrequiredObject type.

stagesarrayrequiredPipeline stages.

pipeline_idstringoptionalOptional pipeline identifier.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_pipeline_delete#Permanently delete a pipeline for the specified object type.5 params▾

Permanently delete a pipeline for the specified object type.

NameTypeRequiredDescription

object_typestringrequiredObject type.

pipeline_idstringrequiredPipeline ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

validate_referencesbooleanoptionalValidate references.

hubspot_pipeline_stage_create#Create a new stage within an existing pipeline.8 params▾

Create a new stage within an existing pipeline.

NameTypeRequiredDescription

display_orderintegerrequiredDisplay order.

labelstringrequiredStage label.

metadataobjectrequiredStage metadata.

object_typestringrequiredObject type.

pipeline_idstringrequiredPipeline ID.

schema_versionstringoptionalSchema version

stage_idstringoptionalOptional custom stage identifier.

tool_versionstringoptionalTool version

hubspot_pipeline_stage_delete#Permanently delete a stage from a pipeline.5 params▾

Permanently delete a stage from a pipeline.

NameTypeRequiredDescription

object_typestringrequiredObject type.

pipeline_idstringrequiredPipeline ID.

stage_idstringrequiredStage ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_pipeline_stage_update#Update an existing stage within a pipeline.8 params▾

Update an existing stage within a pipeline.

NameTypeRequiredDescription

display_orderintegerrequiredDisplay order.

labelstringrequiredStage label.

metadataobjectrequiredStage metadata.

object_typestringrequiredObject type.

pipeline_idstringrequiredPipeline ID.

stage_idstringrequiredStage ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_pipeline_update#Update an existing pipeline for the specified object type.9 params▾

Update an existing pipeline for the specified object type.

NameTypeRequiredDescription

display_orderintegerrequiredDisplay order.

labelstringrequiredPipeline label.

object_typestringrequiredObject type.

pipeline_idstringrequiredPipeline ID.

stagesarrayrequiredPipeline stages to replace.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

validate_deal_stage_usagesbooleanoptionalValidate deal stage usages before delete.

validate_referencesbooleanoptionalValidate references before delete.

hubspot_product_create#Create a new product in the HubSpot product library.4 params▾

Create a new product in the HubSpot product library.

NameTypeRequiredDescription

namestringrequiredName of the product

descriptionstringoptionalDescription of the product

hs_skustringoptionalStock keeping unit (SKU) identifier for the product

pricestringoptionalPrice of the product

hubspot_product_get#Retrieve a single product by its ID.8 params▾

Retrieve a single product by its ID.

NameTypeRequiredDescription

product_idstringrequiredProduct ID.

archivedbooleanoptionalReturn archived.

associationsstringoptionalAssociations.

id_propertystringoptionalID property name.

propertiesstringoptionalProperties.

properties_with_historystringoptionalProperties with history.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_product_update#Update an existing product in the HubSpot product library by its product ID.9 params▾

Update an existing product in the HubSpot product library by its product ID.

NameTypeRequiredDescription

product_idstringrequiredThe ID of the product to update.

descriptionstringoptionalNew description of the product.

hs_cost_of_goods_soldstringoptionalCost of goods sold for the product.

hs_recurring_billing_periodstringoptionalBilling period for recurring products (e.g. P1M for monthly, P1Y for annual).

hs_skustringoptionalNew stock keeping unit (SKU) identifier for the product.

idPropertystringoptionalThe name of a unique property to use as the identifier instead of the default productId.

namestringoptionalNew name of the product.

pricestringoptionalNew unit price of the product.

propertiesstringoptionalArbitrary key-value pairs of any HubSpot product properties to update.

hubspot_products_batch_archive#Archive (soft delete) a product in HubSpot CRM using the batch archive API. Archived records are hidden from the UI but can be restored.1 param▾

Archive (soft delete) a product in HubSpot CRM using the batch archive API. Archived records are hidden from the UI but can be restored.

NameTypeRequiredDescription

inputsstringrequiredJSON array of record IDs to archive. Each item has an 'id' field.

hubspot_products_batch_read#Retrieve a product record from HubSpot CRM using the batch read API. Returns the specified properties for the record.2 params▾

Retrieve a product record from HubSpot CRM using the batch read API. Returns the specified properties for the record.

NameTypeRequiredDescription

inputsstringrequiredJSON array of record IDs to read. Each item has an 'id' field.

propertiesstringoptionalJSON array of property names to return. Omit to get default properties.

hubspot_products_list#Retrieve a list of products from the HubSpot product library.3 params▾

Retrieve a list of products from the HubSpot product library.

NameTypeRequiredDescription

afterstringoptionalPagination cursor for the next page of results

limitnumberoptionalNumber of products to return per page (max 100)

propertiesstringoptionalComma-separated list of product properties to include in response

hubspot_products_search#Search product records using filters, sorting, and pagination.8 params▾

Search product records using filters, sorting, and pagination.

NameTypeRequiredDescription

afterstringrequiredPagination cursor.

filter_groupsarrayrequiredFilter groups.

limitintegerrequiredPage size.

propertiesarrayrequiredProperties to return.

sortsarrayrequiredSort order.

querystringoptionalSearch query string.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_property_create#Create a custom property on any HubSpot CRM object type (contacts, companies, deals, tickets, etc.).20 params▾

Create a custom property on any HubSpot CRM object type (contacts, companies, deals, tickets, etc.).

NameTypeRequiredDescription

field_typestringrequiredUI field type for the property.

group_namestringrequiredProperty group this field belongs to. Get groups from HubSpot or use defaults like contactinformation.

labelstringrequiredDisplay label shown in HubSpot UI.

object_typestringrequiredCRM object type to create the property on.

property_namestringrequiredInternal name for the property (lowercase, underscores, no spaces).

property_typestringrequiredData type of the property.

calculation_formulastringoptionalFormula for calculated properties. Only applicable when fieldType=calculation_equation.

currency_property_namestringoptionalProperty name used to determine the currency for currency-type properties.

data_sensitivitystringoptionalSensitivity level of the property data.

descriptionstringoptionalOptional description of the property.

display_orderintegeroptionalDisplay order for the property. Lower positive integers appear first; -1 places after all positive values.

external_optionsbooleanoptionalSet to true for enumeration properties that pull options from HubSpot users. Use with referencedObjectType='OWNER'.

form_fieldbooleanoptionalWhether the property can be used in HubSpot forms.

hasUniqueValuebooleanoptionalSet to true to enforce unique values across all records.

hiddenbooleanoptionalSet to true to hide the property in HubSpot UI.

number_display_hintstringoptionalControls how number values are formatted in HubSpot.

optionsarrayoptionalOptions for enumeration/select fields.

referenced_object_typestringoptionalSet to 'OWNER' when externalOptions is true to pull option values from HubSpot users.

show_currency_symbolbooleanoptionalWhether to display the currency symbol alongside the property value.

text_display_hintstringoptionalControls the display format for text properties.

hubspot_property_delete#Permanently delete a custom property from a HubSpot CRM object. Built-in HubSpot properties cannot be deleted.2 params▾

Permanently delete a custom property from a HubSpot CRM object. Built-in HubSpot properties cannot be deleted.

NameTypeRequiredDescription

object_typestringrequiredCRM object type the property belongs to.

property_namestringrequiredInternal name of the custom property to delete.

hubspot_property_group_create#Create a new property group for the specified object type.6 params▾

Create a new property group for the specified object type.

NameTypeRequiredDescription

labelstringrequiredDisplay label.

namestringrequiredGroup name.

object_typestringrequiredObject type.

display_orderintegeroptionalDisplay order.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_property_group_delete#Permanently delete a property group for the specified object type.4 params▾

Permanently delete a property group for the specified object type.

NameTypeRequiredDescription

group_namestringrequiredGroup name.

object_typestringrequiredObject type.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_property_group_update#Update an existing property group for the specified object type.6 params▾

Update an existing property group for the specified object type.

NameTypeRequiredDescription

group_namestringrequiredGroup name.

object_typestringrequiredObject type.

display_orderintegeroptionalDisplay order.

labelstringoptionalDisplay label.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_property_groups_list#Retrieve all property groups for the specified object type.4 params▾

Retrieve all property groups for the specified object type.

NameTypeRequiredDescription

object_typestringrequiredObject type.

localestringoptionalLocale for the response.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_property_update#Update an existing custom property on a HubSpot CRM object. Only provided fields are modified.16 params▾

Update an existing custom property on a HubSpot CRM object. Only provided fields are modified.

NameTypeRequiredDescription

object_typestringrequiredCRM object type the property belongs to.

property_namestringrequiredInternal name of the property to update.

calculation_formulastringoptionalUpdated formula for calculated properties.

currency_property_namestringoptionalUpdated property name used to determine currency for currency-type properties.

descriptionstringoptionalNew description for the property.

display_orderintegeroptionalDisplay order for the property.

field_typestringoptionalUpdated UI field type.

form_fieldbooleanoptionalWhether the property can be used in HubSpot forms.

group_namestringoptionalThe property group to move this property to.

hiddenbooleanoptionalSet to true to hide the property in HubSpot UI.

labelstringoptionalNew display label for the property.

number_display_hintstringoptionalUpdated display format for number properties.

optionsarrayoptionalUpdated options for enumeration fields.

property_typestringoptionalUpdated data type of the property.

show_currency_symbolbooleanoptionalWhether to display the currency symbol alongside the value.

text_display_hintstringoptionalUpdated display format for text properties.

hubspot_property_validation_rule_get#Retrieve the validation rule for a specific property on a given object type.5 params▾

Retrieve the validation rule for a specific property on a given object type.

NameTypeRequiredDescription

object_type_idstringrequiredObject type ID.

property_namestringrequiredProperty name.

rule_typestringrequiredRule type.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_property_validation_rule_set#Create or update the validation rule for a specific property on a given object type.7 params▾

Create or update the validation rule for a specific property on a given object type.

NameTypeRequiredDescription

object_type_idstringrequiredObject type ID.

property_namestringrequiredProperty name.

rule_argumentsstringrequiredArguments defining the constraints for the validation rule.

rule_typestringrequiredRule type.

schema_versionstringoptionalSchema version

should_apply_normalizationbooleanoptionalWhether normalization should be applied to the value.

tool_versionstringoptionalTool version

hubspot_quote_create#Create a new quote in HubSpot. Requires a title and language. Optionally associate with a deal and set expiration date, currency, status, and additional properties. Returns the created quote ID.8 params▾

Create a new quote in HubSpot. Requires a title and language. Optionally associate with a deal and set expiration date, currency, status, and additional properties. Returns the created quote ID.

NameTypeRequiredDescription

hs_expiration_datestringrequiredExpiration date of the quote (YYYY-MM-DD format)

hs_languagestringrequiredLanguage of the quote (ISO 639-1 code, e.g. en, de, fr, es)

hs_titlestringrequiredTitle of the quote

deal_idstringoptionalID of the deal to associate this quote with

hs_currencystringoptionalCurrency code for the quote (e.g. USD, EUR).

hs_sender_company_namestringoptionalSender company name shown on the quote.

hs_statusstringoptionalStatus of the quote (DRAFT, PENDING_APPROVAL, APPROVED, REJECTED)

propertiesobjectoptionalAdditional HubSpot quote properties as a JSON object.

hubspot_quote_get#Retrieve a specific HubSpot quote by its ID.2 params▾

Retrieve a specific HubSpot quote by its ID.

NameTypeRequiredDescription

quote_idstringrequiredID of the quote to retrieve

propertiesstringoptionalComma-separated list of quote properties to include in response

hubspot_quote_update#Update an existing quote in HubSpot by its quote ID. Use this to change the title, status, expiration date, or currency of a quote.8 params▾

Update an existing quote in HubSpot by its quote ID. Use this to change the title, status, expiration date, or currency of a quote.

NameTypeRequiredDescription

quote_idstringrequiredThe ID of the quote to update.

hs_currencystringoptionalCurrency code for the quote (ISO 4217).

hs_expiration_datestringoptionalNew expiration date for the quote (YYYY-MM-DD).

hs_languagestringoptionalLanguage of the quote (ISO 639-1 code).

hs_statusstringoptionalNew status of the quote.

hs_titlestringoptionalNew title of the quote.

idPropertystringoptionalThe name of a unique property to use as the identifier instead of the default quoteId.

propertiesstringoptionalArbitrary key-value pairs of any HubSpot quote properties to update.

hubspot_quotes_list#Retrieve a paginated list of quote records.8 params▾

Retrieve a paginated list of quote records.

NameTypeRequiredDescription

afterstringoptionalPagination cursor.

archivedbooleanoptionalReturn archived.

associationsstringoptionalAssociations to return.

limitintegeroptionalPage size.

propertiesstringoptionalProperties.

properties_with_historystringoptionalProperties with history.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_quotes_search#Search quote records using filters, sorting, and pagination.8 params▾

Search quote records using filters, sorting, and pagination.

NameTypeRequiredDescription

afterstringrequiredPagination cursor.

filter_groupsarrayrequiredFilter groups.

limitintegerrequiredPage size.

propertiesarrayrequiredProperties to return.

sortsarrayrequiredSort order.

querystringoptionalSearch query string.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_record_associations_get#Retrieve all associations for a specific CRM record.7 params▾

Retrieve all associations for a specific CRM record.

NameTypeRequiredDescription

object_idstringrequiredObject ID.

object_typestringrequiredObject type.

to_object_typestringrequiredTo object type.

afterstringoptionalPagination cursor.

limitintegeroptionalPage size.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_record_list_memberships_get#Retrieve all lists that a given CRM record is a member of, identified by object type and record ID.4 params▾

Retrieve all lists that a given CRM record is a member of, identified by object type and record ID.

NameTypeRequiredDescription

object_type_idstringrequiredThe object type ID of the record.

record_idstringrequiredThe ID of the CRM record.

schema_versionstringoptionalOptional schema version to use for tool execution

tool_versionstringoptionalOptional tool version to use for execution

hubspot_record_with_history_get#Retrieve a CRM record including full property change history for specified properties.9 params▾

Retrieve a CRM record including full property change history for specified properties.

NameTypeRequiredDescription

object_idstringrequiredObject ID.

object_typestringrequiredObject type.

properties_with_historystringrequiredProperties with history.

archivedbooleanoptionalReturn archived.

associationsstringoptionalAssociations.

id_propertystringoptionalID property.

propertiesstringoptionalAdditional properties.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_schema_association_create#Create a new association definition between a custom object schema and another object type.6 params▾

Create a new association definition between a custom object schema and another object type.

NameTypeRequiredDescription

from_object_type_idstringrequiredFrom object type ID.

namestringrequiredAssociation name.

object_type_idstringrequiredObject type ID.

to_object_type_idstringrequiredTo object type ID.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_schema_create#Create a new custom CRM object schema (type definition) in HubSpot.11 params▾

Create a new custom CRM object schema (type definition) in HubSpot.

NameTypeRequiredDescription

associated_objectsarrayrequiredAssociated object types.

labelsobjectrequiredDisplay labels.

namestringrequiredSchema name.

propertiesarrayrequiredProperty definitions.

required_propertiesarrayrequiredRequired property names.

descriptionstringoptionalSchema description.

primary_display_propertystringoptionalPrimary display property.

schema_versionstringoptionalSchema version

searchable_propertiesarrayoptionalSearchable properties.

secondary_display_propertiesarrayoptionalSecondary display properties.

tool_versionstringoptionalTool version

hubspot_schema_delete#Delete a custom CRM object schema. Set purge=true to permanently delete including all records.4 params▾

Delete a custom CRM object schema. Set purge=true to permanently delete including all records.

NameTypeRequiredDescription

object_typestringrequiredObject type.

archivedbooleanoptionalPurge schema.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_schema_update#Update an existing custom CRM object schema definition.12 params▾

Update an existing custom CRM object schema definition.

NameTypeRequiredDescription

object_typestringrequiredObject type.

allows_sensitive_propertiesbooleanoptionalAllows sensitive properties.

clear_descriptionbooleanoptionalClear description.

descriptionstringoptionalDescription.

labelsobjectoptionalDisplay labels.

primary_display_propertystringoptionalPrimary display property.

required_propertiesarrayoptionalRequired properties.

restorablebooleanoptionalRestorable.

schema_versionstringoptionalSchema version

searchable_propertiesarrayoptionalSearchable properties.

secondary_display_propertiesarrayoptionalSecondary display properties.

tool_versionstringoptionalTool version

hubspot_schemas_list#List all custom object schemas defined in HubSpot. Returns object type IDs, labels, and property definitions needed to work with custom objects.1 param▾

List all custom object schemas defined in HubSpot. Returns object type IDs, labels, and property definitions needed to work with custom objects.

NameTypeRequiredDescription

archivedstringoptionalInclude archived schemas in the response

hubspot_sequence_enroll#Enroll a contact into a HubSpot sequence. Requires the sequence ID, contact ID, sender email, and the enrolling user's ID.5 params▾

Enroll a contact into a HubSpot sequence. Requires the sequence ID, contact ID, sender email, and the enrolling user's ID.

NameTypeRequiredDescription

contact_idstringrequiredThe ID of the contact to enroll in the sequence.

sender_emailstringrequiredThe email address of the sender enrolling the contact.

sequence_idstringrequiredThe ID of the sequence to enroll the contact in.

user_idstringrequiredThe ID of the HubSpot user enrolling the contact.

sender_alias_addressstringoptionalAn alias email address used by the sender when enrolling the contact.

hubspot_sequence_get#Retrieve details of a specific sequence by ID, including its steps, status, and settings.2 params▾

Retrieve details of a specific sequence by ID, including its steps, status, and settings.

NameTypeRequiredDescription

sequence_idstringrequiredThe ID of the sequence to retrieve.

user_idstringrequiredThe ID of the HubSpot user associated with the sequence.

hubspot_sequences_list#List all sequences in HubSpot. Returns a paginated list of sequences with their IDs, names, and status.4 params▾

List all sequences in HubSpot. Returns a paginated list of sequences with their IDs, names, and status.

NameTypeRequiredDescription

user_idstringrequiredThe ID of the HubSpot user whose sequences to list.

afterstringoptionalCursor token for the next page of results.

limitintegeroptionalMaximum number of sequences to return per page.

namestringoptionalFilter sequences by name.

hubspot_subscription_definitions_list#Retrieve all email subscription type definitions for the portal.2 params▾

Retrieve all email subscription type definitions for the portal.

NameTypeRequiredDescription

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_subscription_status_get#Get the email subscription status for a contact by their email address.3 params▾

Get the email subscription status for a contact by their email address.

NameTypeRequiredDescription

email_addressstringrequiredContact email address.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_task_complete#Mark a HubSpot task as completed or update its status. Use the task ID from hubspot_tasks_search or hubspot_task_create.3 params▾

Mark a HubSpot task as completed or update its status. Use the task ID from hubspot_tasks_search or hubspot_task_create.

NameTypeRequiredDescription

task_idstringrequiredID of the task to update

hs_task_bodystringoptionalUpdated notes for the task

hs_task_statusstringoptionalNew status to set for the task

hubspot_task_create#Create a new task in HubSpot CRM. Tasks can be assigned to owners and associated with contacts, companies, or deals.6 params▾

Create a new task in HubSpot CRM. Tasks can be assigned to owners and associated with contacts, companies, or deals.

NameTypeRequiredDescription

hs_task_subjectstringrequiredSubject or title of the task

hs_timestampstringrequiredDue date and time for the task (ISO 8601 format)

hs_task_bodystringoptionalNotes or description for the task

hs_task_prioritystringoptionalPriority level of the task

hs_task_statusstringoptionalStatus of the task

hs_task_typestringoptionalType of task

hubspot_task_get#Retrieve a single task by its ID.8 params▾

Retrieve a single task by its ID.

NameTypeRequiredDescription

task_idstringrequiredTask ID.

archivedbooleanoptionalReturn archived record.

associationsstringoptionalAssociations to return.

id_propertystringoptionalID property name.

propertiesstringoptionalProperties to return.

properties_with_historystringoptionalProperties with history.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_task_update#Update an existing task record in HubSpot CRM.10 params▾

Update an existing task record in HubSpot CRM.

NameTypeRequiredDescription

task_idstringrequiredTask ID.

hs_task_bodystringoptionalTask notes.

hs_task_prioritystringoptionalTask priority.

hs_task_statusstringoptionalTask status.

hs_task_subjectstringoptionalTask subject.

hs_task_typestringoptionalTask type.

hs_timestampstringoptionalDue date.

propertiesobjectoptionalAdditional properties.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_tasks_search#Search HubSpot tasks using filters and full-text search. Returns tasks with their subject, status, due date, and priority.5 params▾

Search HubSpot tasks using filters and full-text search. Returns tasks with their subject, status, due date, and priority.

NameTypeRequiredDescription

afterstringoptionalPagination offset to get results starting from a specific position

filterGroupsstringoptionalJSON string containing filter groups for advanced filtering

limitnumberoptionalNumber of results to return per page (max 100)

propertiesstringoptionalComma-separated list of properties to include in the response

querystringoptionalFull-text search term across task properties

hubspot_teams_list#Retrieve all teams in the HubSpot account.2 params▾

Retrieve all teams in the HubSpot account.

NameTypeRequiredDescription

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_thread_get#Retrieve a specific conversation thread by its ID.5 params▾

Retrieve a specific conversation thread by its ID.

NameTypeRequiredDescription

thread_idstringrequiredThread ID.

archivedbooleanoptionalReturn archived thread.

propertystringoptionalSpecific property to return.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_thread_message_send#Send a new message to a conversation thread. Option 1 (MESSAGE): requires senderActorId, channelId, channelAccountId, recipients. Option 2 (COMMENT): only requires type, text, and attachments.12 params▾

Send a new message to a conversation thread. Option 1 (MESSAGE): requires senderActorId, channelId, channelAccountId, recipients. Option 2 (COMMENT): only requires type, text, and attachments.

NameTypeRequiredDescription

textstringrequiredMessage text.

thread_idstringrequiredThread ID.

typestringrequiredMessage type.

attachmentsarrayoptionalMessage attachments.

channel_account_idstringoptionalChannel account ID.

channel_idstringoptionalChannel ID.

recipientsarrayoptionalMessage recipients.

rich_textstringoptionalRich text content.

schema_versionstringoptionalSchema version

sender_actor_idstringoptionalSender actor ID.

subjectstringoptionalMessage subject.

tool_versionstringoptionalTool version

hubspot_thread_messages_get#Retrieve all messages in a specific conversation thread.8 params▾

Retrieve all messages in a specific conversation thread.

NameTypeRequiredDescription

thread_idstringrequiredThread ID.

afterstringoptionalPagination cursor.

archivedbooleanoptionalReturn archived messages only.

limitintegeroptionalPage size.

propertystringoptionalSpecific property to return.

schema_versionstringoptionalSchema version

sortstringoptionalSort parameters.

tool_versionstringoptionalTool version

hubspot_thread_update#Update a conversation thread status, assignment, or inbox.6 params▾

Update a conversation thread status, assignment, or inbox.

NameTypeRequiredDescription

thread_idstringrequiredThread ID to update.

archivedbooleanoptionalArchive or restore thread.

archived_querybooleanoptionalFilter archived threads.

schema_versionstringoptionalSchema version

statusstringoptionalThread status.

tool_versionstringoptionalTool version

hubspot_threads_list#Retrieve a paginated list of conversation threads, optionally filtered by inbox or status.13 params▾

Retrieve a paginated list of conversation threads, optionally filtered by inbox or status.

NameTypeRequiredDescription

afterstringoptionalPagination cursor.

archivedbooleanoptionalReturn archived threads only.

associated_contact_idintegeroptionalFilter by associated contact ID.

associated_ticket_idintegeroptionalFilter by associated ticket ID.

inbox_idstringoptionalInbox ID.

latest_message_afterstringoptionalFilter by latest message timestamp.

limitintegeroptionalPage size.

propertystringoptionalProperty to return.

schema_versionstringoptionalSchema version

sortstringoptionalSort parameters.

statusstringoptionalThread status.

thread_statusstringoptionalFilter by thread status.

tool_versionstringoptionalTool version

hubspot_ticket_create#Create a new support ticket in HubSpot. Use hubspot_deal_pipelines_list with object type 'tickets' to find valid pipeline and stage IDs.5 params▾

Create a new support ticket in HubSpot. Use hubspot_deal_pipelines_list with object type 'tickets' to find valid pipeline and stage IDs.

NameTypeRequiredDescription

hs_pipeline_stagestringrequiredPipeline stage ID for the ticket

subjectstringrequiredSubject of the ticket

contentstringoptionalDetailed description of the support issue

hs_pipelinestringoptionalPipeline ID for the ticket (defaults to '0' for the default pipeline)

hs_ticket_prioritystringoptionalPriority level of the ticket

hubspot_ticket_get#Retrieve details of a specific HubSpot support ticket by ticket ID.2 params▾

Retrieve details of a specific HubSpot support ticket by ticket ID.

NameTypeRequiredDescription

ticket_idstringrequiredID of the ticket to retrieve

propertiesstringoptionalComma-separated list of properties to include in the response

hubspot_ticket_update#Update an existing HubSpot support ticket by ticket ID. Provide any fields to update.6 params▾

Update an existing HubSpot support ticket by ticket ID. Provide any fields to update.

NameTypeRequiredDescription

ticket_idstringrequiredID of the ticket to update

contentstringoptionalUpdated description of the support issue

hs_pipelinestringoptionalUpdated pipeline ID for the ticket

hs_pipeline_stagestringoptionalUpdated pipeline stage ID for the ticket

hs_ticket_prioritystringoptionalUpdated priority level of the ticket

subjectstringoptionalUpdated subject of the ticket

hubspot_tickets_batch_archive#Archive (soft delete) a ticket in HubSpot CRM using the batch archive API. Archived records are hidden from the UI but can be restored.1 param▾

Archive (soft delete) a ticket in HubSpot CRM using the batch archive API. Archived records are hidden from the UI but can be restored.

NameTypeRequiredDescription

inputsstringrequiredJSON array of record IDs to archive. Each item has an 'id' field.

hubspot_tickets_batch_create#Create one or more tickets in HubSpot using the batch API. Pass a list of records — up to 100 per call.1 param▾

Create one or more tickets in HubSpot using the batch API. Pass a list of records — up to 100 per call.

NameTypeRequiredDescription

inputsstringrequiredJSON array of objects to create in HubSpot batch format.

hubspot_tickets_batch_read#Retrieve a ticket record from HubSpot CRM using the batch read API. Returns the specified properties for the record.2 params▾

Retrieve a ticket record from HubSpot CRM using the batch read API. Returns the specified properties for the record.

NameTypeRequiredDescription

inputsstringrequiredJSON array of record IDs to read. Each item has an 'id' field.

propertiesstringoptionalJSON array of property names to return. Omit to get default properties.

hubspot_tickets_batch_update#Update one or more tickets in HubSpot using the batch API. Pass a list of records with IDs — up to 100 per call.1 param▾

Update one or more tickets in HubSpot using the batch API. Pass a list of records with IDs — up to 100 per call.

NameTypeRequiredDescription

inputsstringrequiredJSON array of objects to update in HubSpot batch format.

hubspot_tickets_batch_upsert#Upsert one or more tickets in HubSpot using the batch API. Pass a list of records — up to 100 per call.1 param▾

Upsert one or more tickets in HubSpot using the batch API. Pass a list of records — up to 100 per call.

NameTypeRequiredDescription

inputsstringrequiredJSON array of objects to upsert in HubSpot batch format.

hubspot_tickets_search#Search HubSpot support tickets using filters and full-text search. Returns matching tickets with their properties.5 params▾

Search HubSpot support tickets using filters and full-text search. Returns matching tickets with their properties.

NameTypeRequiredDescription

afterstringoptionalPagination offset to get results starting from a specific position

filterGroupsstringoptionalJSON string containing filter groups for advanced filtering

limitnumberoptionalNumber of results to return per page (max 100)

propertiesstringoptionalComma-separated list of properties to include in the response

querystringoptionalFull-text search term across ticket properties

hubspot_transactional_email_send#Send a transactional (single) email using a HubSpot email template.6 params▾

Send a transactional (single) email using a HubSpot email template.

NameTypeRequiredDescription

email_idintegerrequiredEmail template ID.

messageobjectrequiredEmail delivery details.

contact_propertiesobjectoptionalContact property values to set.

custom_propertiesobjectoptionalCustom property values for template.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_user_get#Retrieve details of a specific user by their user ID.4 params▾

Retrieve details of a specific user by their user ID.

NameTypeRequiredDescription

user_idstringrequiredUser ID.

id_propertystringoptionalHow to interpret the userId — as a user ID or email address.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_users_list#Retrieve a list of all users in the HubSpot account.4 params▾

Retrieve a list of all users in the HubSpot account.

NameTypeRequiredDescription

afterstringoptionalPagination cursor.

limitintegeroptionalPage size.

schema_versionstringoptionalSchema version

tool_versionstringoptionalTool version

hubspot_workflow_create#Create a new automation workflow in HubSpot. Use type CONTACT_FLOW for contact-based workflows. The workflow starts disabled by default unless isEnabled is set to true.21 params▾

Create a new automation workflow in HubSpot. Use type CONTACT_FLOW for contact-based workflows. The workflow starts disabled by default unless isEnabled is set to true.

NameTypeRequiredDescription

namestringrequiredDisplay name of the workflow.

objectTypeIdstringrequiredObject type the workflow operates on.

typestringrequiredWorkflow type. Use CONTACT_FLOW for contact-based workflows.

actionsstringoptionalArray of action steps in the workflow. Each action type can be STATIC_BRANCH, LIST_BRANCH, AB_TEST_BRANCH, CUSTOM_CODE, WEBHOOK, or SINGLE_CONNECTION.

blockedDatesstringoptionalDates on which workflow actions are suppressed.

canEnrollFromSalesforcebooleanoptionalWhether contacts can be enrolled from Salesforce. Only applicable for CONTACT_FLOW type.

customPropertiesstringoptionalCustom metadata key-value pairs attached to the workflow.

dataSourcesstringoptionalData sources the workflow can reference, such as associated objects.

descriptionstringoptionalOptional description of the workflow's purpose.

enrollmentCriteriastringoptionalCriteria for enrolling contacts into the workflow.

enrollmentSchedulestringoptionalSchedule for re-enrollment checks.

eventAnchorstringoptionalThe anchor point for date-based workflows, referencing a contact property or a static date.

flowTypestringoptionalFlow sub-type. Use WORKFLOW for standard automation or ACTION_SET for action-only flows.

goalFilterBranchstringoptionalFilter branch defining the goal criteria that unenrolls contacts when met. Only for CONTACT_FLOW.

isEnabledbooleanoptionalWhether the workflow is active immediately after creation. Defaults to false.

startActionIdstringoptionalThe ID of the first action to execute in the workflow.

suppressionFilterBranchstringoptionalFilter branch defining contacts to exclude from enrollment. Only for PLATFORM_FLOW type.

suppressionListIdsstringoptionalArray of list IDs whose members are excluded from workflow enrollment.

timeWindowsstringoptionalTime windows that restrict when workflow actions can execute.

unEnrollmentSettingstringoptionalControls when and how contacts are unenrolled. Only for CONTACT_FLOW.

uuidstringoptionalOptional stable identifier for the workflow, preserved across revisions.

hubspot_workflow_delete#Permanently delete a HubSpot workflow by its workflow ID. This action cannot be undone.1 param▾

Permanently delete a HubSpot workflow by its workflow ID. This action cannot be undone.

NameTypeRequiredDescription

flow_idstringrequiredThe ID of the workflow to delete.

hubspot_workflow_email_campaigns_get#Retrieve email campaigns associated with one or more HubSpot workflows. Filter by flow IDs to see which email campaigns a specific workflow sends.4 params▾

Retrieve email campaigns associated with one or more HubSpot workflows. Filter by flow IDs to see which email campaigns a specific workflow sends.

NameTypeRequiredDescription

flowIdstringrequiredComma-separated list of flow IDs to filter email campaigns by specific workflows.

afterstringoptionalPagination cursor from the previous response to fetch the next page.

beforestringoptionalPagination cursor from the previous response to fetch the previous page.

limitintegeroptionalMaximum number of results to return per page.

hubspot_workflow_enroll#Enroll a contact into a HubSpot workflow by workflow ID and the contact's email address.2 params▾

Enroll a contact into a HubSpot workflow by workflow ID and the contact's email address.

NameTypeRequiredDescription

emailstringrequiredThe email address of the contact to enroll in the workflow.

workflow_idstringrequiredThe ID of the workflow to enroll the contact into.

hubspot_workflow_get#Retrieve details of a specific automation workflow by flow ID, including its trigger, actions, and enrollment criteria.1 param▾

Retrieve details of a specific automation workflow by flow ID, including its trigger, actions, and enrollment criteria.

NameTypeRequiredDescription

flow_idstringrequiredThe ID of the workflow to retrieve.

hubspot_workflow_get_v3#Retrieve metadata for a specific v3 workflow by its v3 workflow ID, including name, type, enabled status, and optionally validation errors and statistics.3 params▾

Retrieve metadata for a specific v3 workflow by its v3 workflow ID, including name, type, enabled status, and optionally validation errors and statistics.

NameTypeRequiredDescription

workflow_idstringrequiredThe ID of the v3 workflow to retrieve.

errorsbooleanoptionalWhether to include validation errors and warnings in the response.

statsbooleanoptionalWhether to include workflow statistics in the response.

hubspot_workflow_unenroll#Remove a contact from a HubSpot workflow by workflow ID and the contact's email address.2 params▾

Remove a contact from a HubSpot workflow by workflow ID and the contact's email address.

NameTypeRequiredDescription

emailstringrequiredThe email address of the contact to unenroll from the workflow.

workflow_idstringrequiredThe ID of the workflow to unenroll the contact from.

hubspot_workflow_update#Replace a HubSpot workflow's full definition by flow ID. Requires the current revisionId for optimistic locking — fetch it first with Get Workflow. Provide all required fields (actions, blockedDates, customProperties, timeWindows, type, isEnabled) plus the revisionId.19 params▾

Replace a HubSpot workflow's full definition by flow ID. Requires the current revisionId for optimistic locking — fetch it first with Get Workflow. Provide all required fields (actions, blockedDates, customProperties, timeWindows, type, isEnabled) plus the revisionId.

NameTypeRequiredDescription

flow_idstringrequiredThe ID of the workflow to update.

isEnabledbooleanrequiredWhether the workflow should be active after the update.

revisionIdstringrequiredThe current revision ID of the workflow, used for optimistic locking to prevent concurrent overwrites.

typestringrequiredWorkflow type. Must match the existing workflow type.

actionsstringoptionalArray of action steps in the workflow. Replaces the existing actions. Each action type can be STATIC_BRANCH, LIST_BRANCH, AB_TEST_BRANCH, CUSTOM_CODE, WEBHOOK, or SINGLE_CONNECTION.

blockedDatesstringoptionalArray of date ranges during which the workflow will not send actions.

canEnrollFromSalesforcebooleanoptionalWhether contacts can be enrolled from Salesforce. Only applicable for CONTACT_FLOW type.

customPropertiesstringoptionalCustom metadata key-value pairs attached to the workflow.

descriptionstringoptionalUpdated description of the workflow's purpose.

enrollmentCriteriastringoptionalHow contacts are enrolled into the workflow.

enrollmentSchedulestringoptionalSchedule for re-enrollment checks.

goalFilterBranchstringoptionalFilter branch defining the goal criteria that unenrolls contacts when met. Only for CONTACT_FLOW workflows.

namestringoptionalNew display name for the workflow.

startActionIdstringoptionalThe ID of the first action to execute in the workflow.

suppressionFilterBranchstringoptionalFilter branch defining contacts to exclude from enrollment. Only for PLATFORM_FLOW workflows.

suppressionListIdsstringoptionalArray of list IDs whose members are excluded from workflow enrollment.

timeWindowsstringoptionalTime windows that restrict when workflow actions can execute.

unEnrollmentSettingstringoptionalControls when and how contacts are unenrolled from the workflow. Only for CONTACT_FLOW workflows.

uuidstringoptionalOptional stable identifier for the workflow, useful for tracking across revisions.

hubspot_workflows_list#List all automation workflows in HubSpot. Returns workflow IDs, names, types, and enabled status.2 params▾

List all automation workflows in HubSpot. Returns workflow IDs, names, types, and enabled status.

NameTypeRequiredDescription

afterstringoptionalCursor token for the next page of results.

limitintegeroptionalMaximum number of workflows to return per page.

hubspot_workflows_list_v3#List all v3 (v2) automation workflows in HubSpot. Returns the workflow IDs required by the Enroll in Workflow and Unenroll from Workflow tools. Use this instead of List Workflows when you need to enroll or unenroll a contact.0 params▾

List all v3 (v2) automation workflows in HubSpot. Returns the workflow IDs required by the Enroll in Workflow and Unenroll from Workflow tools. Use this instead of List Workflows when you need to enroll or unenroll a contact.