- Category: crm
- Auth: OAUTH2, API_KEY
- Composio-managed OAuth available? Yes
- Tools: 336
- Triggers: 2
- Slug:
HUBSPOT - Version: 20261103_00
Frequently Asked Questions
Why do users see a "Connecting an unverified app" warning?
Why do users see a "Connecting an unverified app" warning?
Should I use Composio-managed auth or my own HubSpot OAuth app?
Should I use Composio-managed auth or my own HubSpot OAuth app?
How do scopes work in HubSpot?
How do scopes work in HubSpot?
- Scopes in Composio
scopesmust be configured in HubSpot as Required or Conditionally required. - Scopes in Composio
optional_scopesmust be configured in HubSpot as Optional. - Do not request a scope from Composio unless that same scope is enabled in the HubSpot developer app.
credentials.scopes and credentials.optional_scopes. Together, they represent the HubSpot permissions Composio can request for that auth config.HubSpot’s docs may refer to the authorization URL parameter as optional_scope; in Composio, the editable auth config field is named optional_scopes.What is the recommended custom HubSpot OAuth scope setup?
What is the recommended custom HubSpot OAuth scope setup?
optional_scopes, and mark those same permissions as optional in your HubSpot developer app.The main reason is flexibility. HubSpot requires the scopes in the OAuth URL to match how those scopes are categorized in the HubSpot developer app. If you add a new permission as required in HubSpot, every Composio auth config that uses that app must also request it through scopes; otherwise new installs can fail. Keeping tool-specific permissions optional makes it easier to add permissions over time without forcing every auth config to move in lockstep.If a permission is mandatory for your product to work, keep it required. Just make sure it is required in HubSpot and sent through Composio scopes.Example A: all selected permissions are required in HubSpot:oauth is required in HubSpot and the selected tool permissions are optional:What are common HubSpot troubleshooting checks?
What are common HubSpot troubleshooting checks?
- Scope mismatch or callback errors: confirm every requested scope is enabled in HubSpot and is in the same category in both HubSpot and Composio.
- Missing-scope tool errors: add the missing scope to the auth config and HubSpot developer app, then reconnect the account.
- Contact list/search limit errors:
HUBSPOT_SEARCH_CONTACTS_BY_CRITERIAandHUBSPOT_LIST_CONTACTS_PAGEsupport a maximumlimitof 100 results per request. - Webhook setup errors: HubSpot webhooks require a public app with an App ID and Developer API Key. Private or internal apps cannot receive webhooks.
- Refresh or expiry errors: Common causes include the user revoking the app in HubSpot, HubSpot app credentials changing, the refresh token being invalidated, or the connected account being reauthorized with a different app configuration. After rotating custom OAuth credentials or changing the HubSpot developer app, reconnect affected HubSpot accounts.
HubSpot auth loops can be caused by HubSpot-side workspace/login state
HubSpot auth loops can be caused by HubSpot-side workspace/login state
HubSpot triggers require each user’s own app ID and developer API key
HubSpot triggers require each user’s own app ID and developer API key
app_id and developer API key are required because each user needs their own HubSpot app for webhook delivery.Tools
Add asset association
Add asset association
HUBSPOT_ADD_ASSET_ASSOCIATIONAssociates an existing asset (‘FORM’, ‘OBJECT_LIST’, or ‘EXTERNAL_WEB_URL’) with a specified HubSpot marketing campaign.Input Parameters
Output
Add token to event template
Add token to event template
HUBSPOT_ADD_TOKEN_TO_EVENT_TEMPLATEAdds a new custom data token to an existing event template for a specified HubSpot application, optionally populating a CRM object property if objectPropertyName is provided.Input Parameters
type is ‘enumeration’. Each option must have a ‘label’ and a ‘value’.Output
Archive batch of feedback submissions by id
Archive batch of feedback submissions by id
HUBSPOT_ARCHIVE_BATCH_OF_FEEDBACK_SUBMISSIONSAsynchronously archives a batch of HubSpot feedback submissions using their unique IDs, which must correspond to valid and existing submissions; the operation is queued, and submissions are moved from active views without being deleted.Input Parameters
Output
Archive batch of line items by id
Archive batch of line items by id
Archive batch of objects by id
Archive batch of objects by id
HUBSPOT_ARCHIVE_BATCH_OF_OBJECTSArchives a batch of existing, non-archived CRM objects of a specified objectType by their IDs, effectively hiding them from active use.Input Parameters
Output
Archive batch of properties
Archive batch of properties
Archive a batch of quotes by id
Archive a batch of quotes by id
HUBSPOT_ARCHIVE_BATCH_OF_QUOTESArchives a batch of existing quotes by their IDs, removing them from active views while keeping them accessible in your HubSpot account for viewing, downloading, cloning, or deletion; note that archived quotes cannot be restored to active status.Input Parameters
Output
Archive companies
Archive companies
Archive company
Archive company
HUBSPOT_ARCHIVE_COMPANYArchives an existing company in HubSpot CRM by its companyId, moving it to a recycling bin from which it can be restored, rather than permanently deleting it.Input Parameters
Output
Archive contact
Archive contact
Archive contacts
Archive contacts
Archive a CRM object by ID
Archive a CRM object by ID
HUBSPOT_ARCHIVE_CRM_OBJECT_BY_IDArchives a specific HubSpot CRM object by its type and ID, moving it to the recycling bin; this action is irreversible via the API but objects can often be restored via the HubSpot UI.Input Parameters
objectType. The format is typically a string of numbers or a UUID. Ensure the correct ID is provided as this operation is irreversible via the API.Output
Archive deals
Archive deals
ArchiveEmail email
ArchiveEmail email
HUBSPOT_ARCHIVE_EMAILArchives a HubSpot CRM email engagement by its numeric object ID, moving it to the recycling bin.Input Parameters
Output
Archive emails
Archive emails
Archive feedback submission
Archive feedback submission
Archive line item by id
Archive line item by id
Archive product
Archive product
Archive products
Archive products
Archive property by object type and name
Archive property by object type and name
HUBSPOT_ARCHIVE_PROPERTY_BY_OBJECT_TYPE_AND_NAMEArchives a specified CRM property by its object type and name, moving it to the recycling bin; note that some default HubSpot properties cannot be archived.Input Parameters
Output
Archive property group
Archive property group
HUBSPOT_ARCHIVE_PROPERTY_GROUPArchives a HubSpot property group, making it inactive and hidden (not permanently deleted, allowing potential restoration) with immediate effect on its CRM visibility and usability.Input Parameters
objectType.Output
Archive quote object by id
Archive quote object by id
Archive ticket
Archive ticket
Archive tickets
Archive tickets
Audit pipeline changes by id
Audit pipeline changes by id
HUBSPOT_AUDIT_PIPELINE_CHANGESRetrieves a reverse chronological audit log of all changes for a specific, existing HubSpot CRM pipeline, which is identified by its pipelineId and a valid objectType that supports pipelines (e.g., ‘deals’, ‘tickets’).Input Parameters
objectType for which to retrieve the audit history.Output
Batch archive association labels
Batch archive association labels
Batch create contact-company associations
Batch create contact-company associations
Batch create deal-company associations
Batch create deal-company associations
Batch create default associations
Batch create default associations
Batch read companies by properties
Batch read companies by properties
HUBSPOT_BATCH_READ_COMPANIES_BY_PROPERTIESBatch-retrieves up to 100 HubSpot company records by their IDs in a single request. Supports custom ID properties (e.g., domain), selective property retrieval, and historical property values.Input Parameters
id within an input object corresponds to the value of the property specified in idProperty.inputs. Defaults to hs_object_id (the HubSpot record ID) if not specified. Can be set to any unique company property configured in your HubSpot account.Output
Batch read list memberships
Batch read list memberships
Batch read workflow ID mappings
Batch read workflow ID mappings
Batch read workflows
Batch read workflows
Batch update quotes
Batch update quotes
HUBSPOT_BATCH_UPDATE_QUOTESUpdates multiple existing HubSpot quotes in a batch; each quote is identified by its object ID or a custom unique property (via idProperty), and only writable properties are modified.Input Parameters
InputsRequest objects, each specifying a quote to update and its new property values.Output
Cancel active import
Cancel active import
HUBSPOT_CANCEL_IMPORTCancels an active HubSpot data import job using its importId; this action is irreversible, and any data already processed will remain.Input Parameters
Output
Clone marketing email
Clone marketing email
HUBSPOT_CLONE_MARKETING_EMAILDuplicates an existing HubSpot marketing email, identified by its id, into a new draft; an optional cloneName can be assigned to this new email copy.Input Parameters
Output
Configure calling extension settings
Configure calling extension settings
HUBSPOT_CONFIGURE_CALLING_EXTENSION_SETTINGSConfigures or updates settings for a HubSpot app’s calling extension, including its name, UI URL, iframe dimensions, isReady status, and supportsCustomObjects flag, for the specified appId.Input Parameters
true, the calling service appears as an option under the ‘Call’ action in contact records; false hides it.Output
Create A/B test variation
Create A/B test variation
HUBSPOT_CREATE_AB_TEST_VARIATIONCreates a new A/B test variation for an existing HubSpot marketing email, using its contentId; the new variation is created as a draft that can be edited before publishing. This action only creates the variation—it does not start the A/B test or send emails. Note: If an active variation already exists for the email, a new one will not be created. Requires Marketing Hub Professional or Enterprise subscription.Input Parameters
Output
Create a new property group
Create a new property group
HUBSPOT_CREATE_AND_RETURN_A_NEW_PROPERTY_GROUPCreates a new, empty property group for a specified CRM object type in HubSpot, requiring a unique group name for that object type; properties must be added separately.Input Parameters
objectType, used for API referencing.displayOrder. If unspecified, the group is added at the end.Output
Create a new marketing email
Create a new marketing email
HUBSPOT_CREATE_A_NEW_MARKETING_EMAILCreates a new marketing email in HubSpot, allowing comprehensive configuration of content, recipients, sender details, A/B testing, scheduling, web version, and other settings; the internal name for the email is required.Input Parameters
Output
Create association for object type
Create association for object type
HUBSPOT_CREATE_ASSOCIATIONCreates a new custom association definition (schema) for a custom object in HubSpot, specifying how this object type can relate to another object type; this defines the association type itself, not actual record-to-record links. Note: This endpoint requires crm.schemas.custom.write scope and only works with custom objects (not standard HubSpot objects like contacts or companies).Input Parameters
Output
Create association label
Create association label
Create batch of feedback submissions
Create batch of feedback submissions
HUBSPOT_CREATE_BATCH_OF_FEEDBACK_SUBMISSIONSCreates a batch of feedback submissions in HubSpot, ideal for bulk imports; all property names, associationTypeIds, and association to_ids must reference existing entities in HubSpot.Input Parameters
Output
Create batch of objects
Create batch of objects
HUBSPOT_CREATE_BATCH_OF_OBJECTSCreates multiple CRM objects of a specified objectType (e.g., contacts, companies, deals) in a single batch operation, where each object can have its own set of properties and associations.Input Parameters
Output
Create batch of properties
Create batch of properties
HUBSPOT_CREATE_BATCH_OF_PROPERTIESEfficiently creates multiple CRM properties in a single batch for a specified HubSpot object type (e.g., ‘contacts’, ‘companies’, custom object ID), ideal for schema setup or updates.Input Parameters
Output
Create batch of quotes
Create batch of quotes
HUBSPOT_CREATE_BATCH_OF_QUOTESCreates multiple HubSpot CRM quotes in a batch, ideal for bulk operations; provide meaningful quote details in inputs as property requirements can vary, and inspect response for individual quote statuses as partial success is possible.Input Parameters
Output
Create blog post
Create blog post
HUBSPOT_CREATE_BLOG_POSTCreate a HubSpot CMS blog post, defaulting to a draft.Input Parameters
Output
Create campaigns
Create campaigns
HUBSPOT_CREATE_CAMPAIGNSCreates multiple HubSpot campaigns by calling the single campaign creation endpoint for each campaign. Note: HubSpot does not provide a native batch create endpoint for campaigns. This action creates multiple campaigns by making individual API calls for each campaign in the batch.Input Parameters
Output
Create campaign spend item
Create campaign spend item
Create companies
Create companies
Create company
Create company
HUBSPOT_CREATE_COMPANYCreates a new HubSpot company.Input Parameters
Output
Create contact
Create contact
HUBSPOT_CREATE_CONTACTCreates a new HubSpot contact.Input Parameters
associatedcompanyid is set, this field might be auto-populated.email if that’s a personal address.{'custom_property_internal_name': 'value_for_custom_property'}. Note: For common properties with enum values like hs_legal_basis, use the dedicated field instead of custom_properties to ensure proper validation.Output
Create Contact From Natural Language
Create Contact From Natural Language
HUBSPOT_CREATE_CONTACT_FROM_NLCreates a HubSpot contact from a natural language description, using the contact property schema and an LLM-generated property payload. Requires an OpenAI API key and can include supplied associations.Input Parameters
Output
Create contacts
Create contacts
HUBSPOT_CREATE_CONTACTSCreates multiple HubSpot contacts in a batch, with contact properties and optional associations to existing CRM records. Custom properties should use the internal names of properties already defined in the account.Input Parameters
Output
Create content template
Create content template
Create CRM Object From Natural Language
Create CRM Object From Natural Language
HUBSPOT_CREATE_CRM_OBJECT_FROM_NLCreates a HubSpot CRM record from a natural-language description, including contacts, deals, companies, tickets, and custom objects. Optional associations can link the new record to other CRM objects.Input Parameters
Output
Create CRM object with properties
Create CRM object with properties
HUBSPOT_CREATE_CRM_OBJECT_WITH_PROPERTIESCreates a new HubSpot CRM object (e.g., contact, company, custom object) with specified properties (using valid internal names) and associations (to existing objects via valid type IDs).Input Parameters
objectType. IMPORTANT: Some properties are enumeration types that only accept specific values. For CONTACTS: ‘email’ (string), ‘firstname’ (string), ‘lastname’ (string), ‘phone’ (string), ‘lifecyclestage’ (enum: subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer, evangelist, other). For COMPANIES: ‘name’ (string, required), ‘domain’ (string), ‘phone’ (string), ‘city’ (string), ‘state’ (string), ‘country’ (string), ‘industry’ (enum - must use UPPERCASE values like: ACCOUNTING, AIRLINES_AVIATION, BANKING, BIOTECHNOLOGY, COMPUTER_SOFTWARE, CONSTRUCTION, CONSUMER_GOODS, EDUCATION_MANAGEMENT, ENTERTAINMENT, FINANCIAL_SERVICES, FOOD_BEVERAGES, GOVERNMENT_ADMINISTRATION, HEALTH_WELLNESS_AND_FITNESS, HOSPITAL_HEALTH_CARE, HOSPITALITY, INFORMATION_TECHNOLOGY_AND_SERVICES, INSURANCE, INTERNET, LEGAL_SERVICES, MANAGEMENT_CONSULTING, MANUFACTURING, MARKETING_AND_ADVERTISING, MEDIA_PRODUCTION, NON_PROFIT_ORGANIZATION_MANAGEMENT, OIL_ENERGY, PHARMACEUTICALS, REAL_ESTATE, RETAIL, TELECOMMUNICATIONS, TRANSPORTATION_TRUCKING_RAILROAD, VENTURE_CAPITAL_PRIVATE_EQUITY, WHOLESALE, and ~115 more). For DEALS: ‘dealname’ (string, required), ‘amount’ (string/number), ‘dealstage’ (enum: pipeline-specific stage IDs), ‘closedate’ (ISO 8601 date), ‘pipeline’ (pipeline ID). For TICKETS: ‘subject’ (string), ‘content’ (string), ‘hs_pipeline’ (pipeline ID), ‘hs_pipeline_stage’ (stage ID), ‘hs_ticket_priority’ (enum: LOW, MEDIUM, HIGH). Use GET /crm/v3/properties/{objectType} to retrieve all valid properties and their enum options for any object type.to_id and types.Output
Create deal
Create deal
HUBSPOT_CREATE_DEALCreates a new HubSpot deal.Input Parameters
{'project_type': 'migration', 'priority_level': 'high'}.Output
Create Deal From Natural Language
Create Deal From Natural Language
HUBSPOT_CREATE_DEAL_FROM_NLCreates a HubSpot deal from a natural language description using an LLM and the deal property schema. It attempts to fetch pipeline stages for context and accepts an optional pipeline override and associations.Input Parameters
Output
Create deals
Create deals
HUBSPOT_CREATE_DEALSCreates multiple deals in HubSpot CRM; ensure any associated object IDs, deal stages, and pipeline IDs specified are valid and exist within the HubSpot account.Input Parameters
Output
Create default association
Create default association
Create email
Create email
HUBSPOT_CREATE_EMAILCreates a new HubSpot email engagement record. REQUIRED FIELDS in properties dict: - hs_email_subject: Subject line - hs_email_html: HTML content - hs_timestamp: Unix timestamp in milliseconds - hs_email_direction: One of ‘EMAIL’, ‘INCOMING_EMAIL’, ‘FORWARDED_EMAIL’, ‘DRAFT_EMAIL’ This creates an email engagement/activity record in HubSpot CRM, not a marketing email.Input Parameters
Output
Create emails
Create emails
Create engagement
Create engagement
HUBSPOT_CREATE_ENGAGEMENTCreate a legacy EMAIL, CALL, MEETING, TASK, or NOTE engagement with optional CRM associations, attachments, and type-specific metadata.Input Parameters
Output
Create event template for app
Create event template for app
HUBSPOT_CREATE_EVENT_TEMPLATE_FOR_APPCreates a new event template for a HubSpot app, defining structure, custom properties (tokens), and appearance (Markdown with Handlebars) of custom timeline events for CRM objects; this template must exist before logging corresponding events.Input Parameters
objectPropertyName is set.Output
Create feedback submission
Create feedback submission
HUBSPOT_CREATE_FEEDBACK_SUBMISSIONCreates a HubSpot feedback submission with properties and an associations list, which may be empty.Input Parameters
Output
Create landing page
Create landing page
HUBSPOT_CREATE_LANDING_PAGECreate a HubSpot landing page, as a draft unless state is explicitly set.Input Parameters
password.Output
Create line item
Create line item
Create line items
Create line items
Create list
Create list
HUBSPOT_CREATE_LISTCreate a HubSpot CRM list with manual, snapshot, or dynamic membership rules.Input Parameters
Output
Create meeting
Create meeting
HUBSPOT_CREATE_MEETINGCreates a new meeting engagement in HubSpot CRM. Use this action when you need to log a meeting that occurred or schedule a future meeting with contacts, companies, or other CRM records. The meeting will appear on the timeline of associated records and can include details like title, time, location, notes, and outcome.Input Parameters
Output
Create note
Create note
HUBSPOT_CREATE_NOTECreates a new HubSpot CRM note. Use when you need to add a timestamped note with optional attachments and associations to contacts, companies, deals, or tickets.Input Parameters
Output
Create object association
Create object association
HUBSPOT_CREATE_OBJECT_ASSOCIATIONTool to create or label an association between two CRM records using HubSpot Associations v4 API. Use when you need to link records (e.g., contact to company, deal to contact) with explicit association labels.Input Parameters
Output
Create new object schema with custom properties
Create new object schema with custom properties
HUBSPOT_CREATE_OBJECT_SCHEMACreates a new custom object schema in HubSpot CRM with unique naming for schema and properties, defined display/required/searchable properties within the ‘properties’ list, provided immutable labels, and correctly configured ‘enumeration’ type properties (options/referencedObjectType).Input Parameters
Output
Create or update draft version
Create or update draft version
HUBSPOT_CREATE_OR_UPDATE_DRAFT_VERSIONCreates or updates the draft version of a marketing email identified by emailId; if no draft exists, a new one is created from the current live version to prepare changes or A/B tests before publishing.Input Parameters
rssData is configured and blog is HubSpot-hosted.rssData is configured.Output
Create pipeline for object type
Create pipeline for object type
HUBSPOT_CREATE_PIPELINECreates a new HubSpot pipeline for a specified CRM objectType (e.g., ‘deals’, ‘tickets’), requiring the pipeline label be unique for that objectType and each stage label be unique within the pipeline.Input Parameters
label must be unique within this pipeline.displayOrder are sorted alphabetically by label.Output
Create pipeline stage
Create pipeline stage
HUBSPOT_CREATE_PIPELINE_STAGECreates a new stage in a specified HubSpot CRM pipeline for a given object type, such as ‘deals’ or ‘tickets’.Input Parameters
deals pipelines, metadata must include a probability key (value 0.0-1.0 in 0.1 increments). For tickets pipelines, an optional ticketState key can specify OPEN or CLOSED status.objectType) where the new stage will be added.displayOrder are sorted alphabetically by label.Output
Create product
Create product
HUBSPOT_CREATE_PRODUCTCreates a new HubSpot product. Note: Products are catalog items and cannot be directly associated with deals, contacts, or companies. To connect product information to a deal or quote, create a line item using HUBSPOT_CREATE_LINE_ITEM that references this product’s ID via hs_product_id.Input Parameters
true if active, false otherwise.true to archive.{"material": "Titanium", "warranty_years": "5"}.Output
Create products
Create products
Create property for specified object type
Create property for specified object type
HUBSPOT_CREATE_PROPERTY_FOR_SPECIFIED_OBJECT_TYPECreates a new custom property for a specified HubSpot CRM object type; ensure groupName refers to an existing property group for the objectType.Input Parameters
objectType, used for API referencing.type is ‘enumeration’. For fieldType of ‘booleancheckbox’, must include exactly two options with values ‘true’ and ‘false’. Each option defines a possible value.objectType. Cannot be changed to false after being set to true.referencedObjectType (e.g., ‘OWNER’ for HubSpot users). Defaults to false. Only for ‘enumeration’ type.fieldType is ‘calculation_equation’. Can reference other properties by their internal names.externalOptions is true and type is “enumeration” to populate options with users). Applicable for specific property types.Output
Create quote object
Create quote object
HUBSPOT_CREATE_QUOTE_OBJECTCreates a new quote object in HubSpot CRM with specified properties and associations.Input Parameters
Output
Create site page
Create site page
Create task
Create task
HUBSPOT_CREATE_TASKCreates a new CRM task record. Use when adding a task with properties and optional associations.Input Parameters
Output
Create ticket
Create ticket
HUBSPOT_CREATE_TICKETCreates a new HubSpot ticket.Input Parameters
to) and the type of association (types).my_custom_field_name), values are the data.hs_pipeline.Output
Create tickets
Create tickets
HUBSPOT_CREATE_TICKETSCreates multiple HubSpot tickets in a batch, each with its own properties and associations; inputs list must not be empty, each item needs properties, and associations/custom properties must be validly defined using internal names for custom fields and ISO 8601 for dates.Input Parameters
Output
Create timeline event based on template
Create timeline event based on template
HUBSPOT_CREATE_TIMELINE_EVENTCreates an immutable custom timeline event on a CRM object’s record using a specified, existing event template (identified by eventTemplateId), optionally updating CRM object properties if defined in the template; requires email, utk, or objectId for association.Input Parameters
{{uuid}} for uniqueness if providing an ID.hubspotutk cookie) to associate event with a contact; use if contact’s email is unknown.objectId provided).Output
Create multiple timeline events batch
Create multiple timeline events batch
HUBSPOT_CREATE_TIMELINE_EVENTS_BATCHCreates multiple immutable timeline events in a batch, ideal for bulk data imports or real-time synchronizations, using a valid event template; may update CRM properties if the template is so configured.Input Parameters
Output
Create workflow
Create workflow
HUBSPOT_CREATE_WORKFLOWCreates a new HubSpot workflow to automate processes; ensure enrollmentCriteria and actions use properties relevant to the specified objectTypeId.Input Parameters
Output
Delete association label
Delete association label
Delete call
Delete call
HUBSPOT_DELETE_CALLDeletes a HubSpot call record by its ID. The action returns error details in its response when the delete request fails.Input Parameters
Output
Delete calling extension settings
Delete calling extension settings
HUBSPOT_DELETE_CALLING_EXTENSION_SETTINGSDeletes the settings for a calling extension app identified by its app ID. The action returns error details in its response when the delete request fails.Input Parameters
Output
Delete campaign
Delete campaign
Archive a batch of campaigns
Archive a batch of campaigns
Permanently delete company for GDPR compliance
Permanently delete company for GDPR compliance
HUBSPOT_DELETE_COMPANY_GDPRPermanently deletes a company (identified by objectId) and its associated data from HubSpot for GDPR compliance; this action is irreversible and requires the company to exist.Input Parameters
idProperty is specified, this is the value of that custom unique property. Otherwise, this is the company’s HubSpot Company ID.Output
Permanently delete contact for GDPR compliance
Permanently delete contact for GDPR compliance
HUBSPOT_DELETE_CONTACT_GDPRIrreversibly erases a HubSpot contact and associated data per a GDPR request; if an email is given for a non-existent contact, it’s blocklisted.Input Parameters
idProperty) for permanent deletion.objectId should be interpreted: ‘email’ for email address, or null/omitted for HubSpot contact ID (default).Output
Delete CRM list
Delete CRM list
Archive deal (GDPR permanent delete not supported for deals)
Archive deal (GDPR permanent delete not supported for deals)
HUBSPOT_DELETE_DEAL_GDPRArchives a HubSpot deal by its ID. Note: HubSpot’s GDPR permanent deletion API only supports contacts, not deals. This action archives the deal (moves to recycling bin for 90 days) as the closest available functionality.Input Parameters
Output
Permanently delete line items for gdpr
Permanently delete line items for gdpr
HUBSPOT_DELETE_LINE_ITEMS_GDPRPermanently deletes a specified line item and its associated content for GDPR compliance; this action is irreversible and cannot be undone.Input Parameters
idProperty, or the line item’s primary HubSpot ID if idProperty is not provided.objectId is not its primary HubSpot ID. For example, ‘external_id’. If omitted, objectId is assumed to be the line item’s primary HubSpot ID.Output
Delete a marketing email
Delete a marketing email
Delete meeting
Delete meeting
HUBSPOT_DELETE_MEETINGPermanently deletes (archives) a HubSpot meeting by its ID, moving it to the recycling bin where it can be restored within 90 days. Use this action when you need to remove a meeting engagement from HubSpot’s CRM. This action is irreversible via the API — the meeting cannot be recovered programmatically once deleted.Input Parameters
Output
Delete note
Delete note
HUBSPOT_DELETE_NOTEArchives a HubSpot note by its ID, removing it from active view. The note is archived rather than permanently deleted and can be restored within 90 days. Use this action when you need to remove a note from the CRM without permanently deleting it. This action is irreversible through the API - archived notes cannot be restored programmatically.Input Parameters
Output
Delete pipeline by id
Delete pipeline by id
HUBSPOT_DELETE_PIPELINEPermanently deletes a HubSpot pipeline and all its stages by pipelineId and objectType; this is irreversible, so use validation flags to avoid errors if the pipeline is not empty.Input Parameters
Output
Delete pipeline stage by id
Delete pipeline stage by id
HUBSPOT_DELETE_PIPELINE_STAGEPermanently deletes a specific pipeline stage for an objectType (e.g., ‘deals’, ‘tickets’) that supports pipelines; this operation is irreversible, so ensure no active CRM records are associated with the stage to prevent data issues.Input Parameters
objectType) from which the stage will be deleted.Output
Delete schema by object type
Delete schema by object type
HUBSPOT_DELETE_SCHEMADeletes a HubSpot custom object schema by objectType. With archived=false (default), it archives the schema (soft delete). With archived=true, it permanently deletes an already-archived schema (hard delete). Prerequisites: All object instances, associations, and properties must be deleted first.Input Parameters
false (default) archives the schema (soft delete), true permanently deletes an already-archived schema (hard delete). To fully remove a schema, first call with false to archive it, then call again with true to purge it.Output
Delete task
Delete task
HUBSPOT_DELETE_TASKArchives a HubSpot task by its ID, removing it from active task lists. Use this action when you need to delete or remove a task from HubSpot CRM. The task is archived rather than permanently deleted and may be recoverable. This action is irreversible from the API perspective — the task cannot be directly unarchived via this action.Input Parameters
Output
Delete timeline event template
Delete timeline event template
HUBSPOT_DELETE_TIMELINE_EVENT_TEMPLATEPermanently and irreversibly deletes a specific timeline event template, identified by its eventTemplateId, from the application appId.Input Parameters
eventTemplateId must be part of this application.Output
Delete video conferencing app settings
Delete video conferencing app settings
HUBSPOT_DELETE_VIDEO_CONFERENCING_APP_SETTINGSDeletes the settings for a specified HubSpot video conferencing application.Input Parameters
Output
Delete workflow
Delete workflow
Download CMS source file
Download CMS source file
Enroll contact in workflow
Enroll contact in workflow
Fetch import error details
Fetch import error details
HUBSPOT_FETCH_IMPORT_ERROR_DETAILSFetches a paginated list of read-only error details for a specific HubSpot CRM import, requiring a valid importId for a processed import.Input Parameters
paging.next.after property to fetch the next page of error details.Output
Fetch recording settings by app ID
Fetch recording settings by app ID
Fetch revenue
Fetch revenue
HUBSPOT_FETCH_REVENUEFetches a revenue attribution report for a specified, existing marketing campaign, optionally using a specific attribution model and date range; if both start and end dates are given, endDate must not be earlier than startDate.Input Parameters
Output
Get the variation of an A/B marketing email
Get the variation of an A/B marketing email
HUBSPOT_GET_AB_EMAIL_VARIATIONRetrieves the alternate variation of a specified A/B marketing email; the emailId must identify an email currently in an A/B test. Requires Marketing Hub Professional or Enterprise subscription.Input Parameters
Output
Get Account Information
Get Account Information
Get active imports list
Get active imports list
Get aggregated statistic intervals
Get aggregated statistic intervals
HUBSPOT_GET_AGGREGATED_STATISTIC_INTERVALSRetrieves aggregated statistics for marketing emails (e.g., send counts), grouped by specified time intervals within a defined time range.Input Parameters
Output
Get aggregated statistics
Get aggregated statistics
HUBSPOT_GET_AGGREGATED_STATISTICSRetrieves aggregated marketing email statistics for a time range, with optional email ID and property parameters. Missing start and end timestamps default to 30 days ago and the current time, respectively.Input Parameters
Output
Get all marketing emails for a HubSpot account
Get all marketing emails for a HubSpot account
HUBSPOT_GET_ALL_MARKETING_EMAILS_FOR_A_HUBSPOT_ACCOUNTFetches a list of marketing emails from a HubSpot account, with options for filtering, sorting, pagination, and including performance statistics.Input Parameters
name, createdAt, updatedAt, createdBy, updatedBy. Prefix with ’-’ for descending order (e.g., ‘-createdAt’). createdAt is the default sort order if unspecified.paging.next.after property of a previous paged response.false (archived emails are not returned). Set to true to retrieve archived emails.true for published emails, false for draft emails. If omitted, both published and draft emails are returned.true, includes statistics (e.g., open rates, click rates) with each email. Defaults to false.Output
Get blog post
Get blog post
Get blog tag
Get blog tag
Get campaign metrics
Get campaign metrics
HUBSPOT_GET_CAMPAIGN_METRICSRetrieves key attribution metrics for an existing marketing campaign, identified by its campaignGuid, within an optional date range.Input Parameters
Output
Get CMS source metadata
Get CMS source metadata
Get communication status
Get communication status
Get company
Get company
HUBSPOT_GET_COMPANYRetrieves a HubSpot company by its ID.Input Parameters
Output
Get contact IDs
Get contact IDs
HUBSPOT_GET_CONTACT_IDSFetches a list of contact IDs for a specific HubSpot campaign based on interaction type.Input Parameters
Output
Get contact workflow enrollments
Get contact workflow enrollments
Get CRM export status
Get CRM export status
Get CRM list
Get CRM list
Get CRM list by name
Get CRM list by name
Get CRM lists by IDs
Get CRM lists by IDs
Get deal
Get deal
Get deals
Get deals
HUBSPOT_GET_DEALSRetrieves multiple HubSpot deals by their IDs in a single batch request.Input Parameters
Output
Get emails
Get emails
Get email subscription status
Get email subscription status
Get engagement
Get engagement
Get specific event template for app
Get specific event template for app
HUBSPOT_GET_EVENT_TEMPLATERetrieves detailed information about a specific event template for a given application in HubSpot’s CRM timeline.Input Parameters
Output
Get exchange rate
Get exchange rate
Get file
Get file
Get file import status
Get file import status
Get file signed URL
Get file signed URL
Get form
Get form
Get import record information
Get import record information
HUBSPOT_GET_IMPORT_RECORD_INFORMATIONRetrieves a HubSpot CRM import record by ID, including its status, metadata, and import configuration when available.Input Parameters
Output
Get landing page
Get landing page
Get landing page draft
Get landing page draft
Get draft version of a marketing email
Get draft version of a marketing email
Get a revision of a marketing email
Get a revision of a marketing email
Get revisions of a marketing email
Get revisions of a marketing email
HUBSPOT_GET_MARKETING_EMAIL_REVISIONSRetrieves a paginated list of all historical versions (including full state like content, settings, metadata) for a specified, existing marketing email; revision ID -1 identifies the current version.Input Parameters
paging.prev.before in a previous response.Output
Get marketing event participation breakdown
Get marketing event participation breakdown
Return pipeline by id
Return pipeline by id
HUBSPOT_GET_PIPELINE_BY_IDRetrieves a specific pipeline by its ID and CRM object type, detailing its stages and properties.Input Parameters
Output
Get pipeline stage audit
Get pipeline stage audit
Get private app daily API usage
Get private app daily API usage
Get products
Get products
HUBSPOT_GET_PRODUCTSRetrieves multiple HubSpot products in a batch by their IDs or by values of a specified alternate unique identifier property.Input Parameters
Output
Get quote by id
Get quote by id
HUBSPOT_GET_QUOTERetrieves a specific HubSpot quote by its unique identifier.Input Parameters
idProperty is specified.Output
Get record list memberships
Get record list memberships
Get segment members
Get segment members
Get settings user
Get settings user
Get site page
Get site page
Get site page draft
Get site page draft
Get the details of a specified marketing email
Get the details of a specified marketing email
HUBSPOT_GET_THE_DETAILS_OF_A_SPECIFIED_MARKETING_EMAILRetrieves detailed information for a specific marketing email in HubSpot using its unique email ID, optionally including performance statistics and specific properties.Input Parameters
true for archived, false for not archived. Omit to retrieve regardless of archived status.Output
Get tickets
Get tickets
HUBSPOT_GET_TICKETSRetrieves multiple HubSpot tickets in a batch by ticket IDs or values of an alternate unique identifier property.Input Parameters
Output
Get workflow by ID
Get workflow by ID
HUBSPOT_GET_WORKFLOW_BY_IDRetrieves a HubSpot workflow by ID. Uses v4 normally and recovers legacy workflows through v3 only for the known v4 HTML 404 or number-comparative conversion failure; legacy details retain their v3 field names.Input Parameters
Output
Get workflow performance
Get workflow performance
Get workflow revision
Get workflow revision
Get all workflows
Get all workflows
List all engagements
List all engagements
List assets
List assets
HUBSPOT_LIST_ASSETSLists assets of a specified type associated with a HubSpot marketing campaign, with pagination and optional date-range parameters. Responses are validated against a file-asset schema and do not expose performance metrics.Input Parameters
startDate or endDate is missing/invalid.startDate or endDate is missing/invalid.Output
List associated engagements
List associated engagements
List association labels
List association labels
List association types
List association types
List audit logs
List audit logs
HUBSPOT_LIST_AUDIT_LOGSLists Enterprise-only HubSpot account audit logs with optional filters and pagination.Input Parameters
actingUserId query parameter.fillFinalTimestamp query parameter. HubSpot does not document its behavior.Output
List automation flows
List automation flows
List blog posts
List blog posts
List call dispositions
List call dispositions
List companies
List companies
HUBSPOT_LIST_COMPANIESRetrieves a paginated list of HubSpot companies.Input Parameters
paging.next.after of a previous response, used to fetch the subsequent page. Omit for the first page.true returns only archived companies; false (default) returns only active companies.Output
List company activities
List company activities
HUBSPOT_LIST_COMPANY_ACTIVITIESLists a page of activity associations for a HubSpot company and a specified activity type, such as calls, emails, meetings, notes, or tasks. Returns associated record IDs and association metadata, with a cursor for further pages when available.Input Parameters
Output
List company calls
List company calls
HUBSPOT_LIST_COMPANY_CALLSLists a page of call associations for a HubSpot company, returning call IDs and association types. A cursor can be used to retrieve further pages.Input Parameters
Output
List company meetings
List company meetings
HUBSPOT_LIST_COMPANY_MEETINGSLists a page of meetings associated with a HubSpot company, returning meeting IDs and association metadata. A cursor can be used to retrieve further pages.Input Parameters
Output
List contact notes
List contact notes
HUBSPOT_LIST_CONTACT_NOTESLists a page of notes associated with a HubSpot contact, returning note IDs and association metadata. A cursor can be used to retrieve further pages.Input Parameters
Output
List contact properties
List contact properties
HUBSPOT_LIST_CONTACT_PROPERTIESLists all contact properties in your HubSpot account, including custom properties you’ve created. Use this action to discover: - Available property names for updating contacts - Custom properties specific to your HubSpot account - Property types and valid options for enumeration fields - Which properties are read-only vs writableInput Parameters
Output
List contacts
List contacts
HUBSPOT_LIST_CONTACTSRetrieves a paginated list of HubSpot contacts.Input Parameters
paging.next.after of a previous response, used to fetch the subsequent page. Omit for the first page. Empty strings will be treated as None.true returns only archived contacts; false (default) returns only active (non-archived) contacts.Output
List contact tasks
List contact tasks
HUBSPOT_LIST_CONTACT_TASKSLists a page of tasks associated with a HubSpot contact, returning task IDs and association metadata. A cursor can be used to retrieve further pages.Input Parameters
Output
List content templates
List content templates
List conversation channels
List conversation channels
List conversation inboxes
List conversation inboxes
List conversation threads
List conversation threads
HUBSPOT_LIST_CONVERSATION_THREADSLists HubSpot conversation threads with filtering and forward pagination.Input Parameters
Output
List deal activities
List deal activities
List deal meetings
List deal meetings
HUBSPOT_LIST_DEAL_MEETINGSLists a page of meetings associated with a HubSpot deal, returning meeting IDs and association metadata. Use the returned cursor to request another page.Input Parameters
Output
List deals
List deals
List domains
List domains
List email campaign IDs
List email campaign IDs
List email campaigns
List email campaigns
List email events
List email events
List Emails
List Emails
HUBSPOT_LIST_EMAILSRetrieves a paginated list of HubSpot emails, allowing selection of specific properties (with or without history), associated object IDs, and filtering by archive status.Input Parameters
Output
List event occurrences
List event occurrences
List all event templates for app
List all event templates for app
List feedback submissions page
List feedback submissions page
HUBSPOT_LIST_FEEDBACK_SUBMISSIONSRetrieves a paginated list of HubSpot feedback submissions, with property selection and archive-status filtering. Returned properties are limited to the response model; requested property histories and associated object IDs are not represented in it.Input Parameters
paging.next.after field of a previous response. If omitted, the first page is returned. Use with limit for iterating through large sets of feedback submissions.True to retrieve only archived submissions. False (default) retrieves only active (non-archived) submissions. Useful for accessing historical or managing archived feedback.hs_sentiment, hs_survey_name, hs_content). If specified, only these properties are returned. If a property doesn’t exist for a submission, it’s ignored. If omitted, a default set of properties is returned.contact, survey, ticket) for which to retrieve associated IDs. This allows fetching IDs of related objects. If an association doesn’t exist for a submission, it’s ignored.Output
List forms
List forms
List form submissions
List form submissions
List granted OAuth scopes
List granted OAuth scopes
HUBSPOT_LIST_GRANTED_SCOPESTool to introspect the current OAuth access token and return its granted scopes and metadata. Use when you need to check which permissions are available before calling an endpoint (e.g., workflows, automation) to proactively detect missing scopes and provide clear remediation guidance.Input Parameters
Output
List landing page revisions
List landing page revisions
List landing pages
List landing pages
List login activity
List login activity
List object associations
List object associations
HUBSPOT_LIST_OBJECT_ASSOCIATIONSLists a page of associations from a single CRM record to a specified target object type without fetching the full CRM object. Use the returned paging cursor to request further pages.Input Parameters
Output
List products
List products
List quotes page
List quotes page
HUBSPOT_LIST_QUOTESRetrieves a paginated list of quotes, allowing selection of specific properties, property history, associated object IDs, and filtering by archived status.Input Parameters
paging.next.after property to fetch the subsequent page. Use the exact token provided by the API; do not modify it.hs_title, hs_quote_amount). Non-existent properties for a quote are ignored. If omitted, a default set of properties is returned.contacts, companies, deals) for which to retrieve IDs of associated records. Non-existent association types or associations for a specific quote are ignored.hs_quote_amount, hs_expiration_date). Using this may reduce the maximum number of quotes returnable per request due to increased data volume.Output
List recently modified engagements
List recently modified engagements
List sequences
List sequences
List settings users
List settings users
List site pages
List site pages
List teams
List teams
List tickets
List tickets
List user roles
List user roles
Map legacy list ID
Map legacy list ID
Merge two companies of same type
Merge two companies of same type
HUBSPOT_MERGE_COMPANIESMerges two existing company records of the same type in HubSpot CRM, where objectIdToMerge is absorbed into primaryObjectId; this operation is irreversible.Input Parameters
Output
Merge contacts
Merge contacts
HUBSPOT_MERGE_CONTACTSMerges two HubSpot contacts into one.Input Parameters
objectIdToMerge. The merged contact will retain this ID.Output
Merge two feedback submissions
Merge two feedback submissions
HUBSPOT_MERGE_FEEDBACK_SUBMISSIONSMerges two existing feedback submissions by ID, primarily for consolidating duplicates or related feedback; this operation is irreversible, and primaryObjectId values take precedence in conflicts.Input Parameters
Output
Merge two line items of same type
Merge two line items of same type
HUBSPOT_MERGE_LINE_ITEMSMerges two line items, objectIdToMerge into primaryObjectId, which must be of the same type; objectIdToMerge is absorbed and the operation is irreversible.Input Parameters
objectIdToMerge.Output
Merge two objects of same type
Merge two objects of same type
HUBSPOT_MERGE_OBJECTSMerges two distinct HubSpot CRM objects of the same objectType, consolidating data into primaryObjectId (which is preserved) and deleting objectIdToMerge; this operation is permanent and irreversible.Input Parameters
objectIdToMerge is consolidated.Output
Merge products
Merge products
Merge two quotes of same type
Merge two quotes of same type
HUBSPOT_MERGE_QUOTESMerges two distinct quotes of the same type by consolidating objectIdToMerge into primaryObjectId (e.g., for combining information or updating terms); this operation is irreversible.Input Parameters
Output
Move list to folder
Move list to folder
Partially update CRM object by ID
Partially update CRM object by ID
HUBSPOT_PARTIALLY_UPDATE_CRM_OBJECT_BY_IDPartially updates specified properties of a CRM object (e.g., contact, company, deal) identified by its type and ID, or optionally by a unique property value if idProperty is specified.Input Parameters
idProperty is specified, this is the value of that unique property; otherwise, it’s the internal object ID.objectId should be the value of this property.Output
Permanently delete contact via GDPR
Permanently delete contact via GDPR
HUBSPOT_PERMANENTLY_DELETE_CONTACT_VIA_GDPRPermanently deletes a HubSpot contact and all its associated data for GDPR compliance, identifying the contact by its ID or another unique property.Input Parameters
idProperty is specified.objectId. For example, if objectId is an email address, set this to ‘email’. If objectId is the HubSpot contact ID, this field can be omitted (or set to None).Output
Publish landing page draft
Publish landing page draft
Publish or send a marketing email
Publish or send a marketing email
Publish site page draft
Publish site page draft
Purge schema by object type
Purge schema by object type
HUBSPOT_PURGE_SCHEMAPermanently and irreversibly deletes the schema for an existing objectType in HubSpot CRM; this deprecated endpoint should be used with extreme caution.Input Parameters
Output
Read a CRM property by name
Read a CRM property by name
HUBSPOT_READ_A_CRM_PROPERTY_BY_NAMEReads a specific CRM property definition for a given HubSpot object type by its internal name.Input Parameters
Output
Read all properties for object type
Read all properties for object type
HUBSPOT_READ_ALL_PROPERTIES_FOR_OBJECT_TYPERetrieves definitions and metadata (not actual values) for properties of a specified HubSpot CRM object type (e.g., ‘contacts’, ‘companies’, ‘deals’, or custom objects).Input Parameters
true for archived, false for active (non-archived).Output
Read a page of objects by type
Read a page of objects by type
HUBSPOT_READ_APAGE_OF_OBJECTS_BY_TYPERetrieves a paginated list of objects for a specified and valid HubSpot CRM object type (e.g., ‘contacts’, ‘companies’, ‘deals’, or custom ID).Input Parameters
paging.next.after property, used to fetch the next page of results.Output
Batch read associations
Batch read associations
HUBSPOT_READ_ASSOCIATIONS_BATCHTool to batch-read CRM associations (e.g., deals→contacts, deals→companies) for up to 1,000 source record IDs in one request. Use when you need to retrieve associated target IDs and association type metadata for multiple records efficiently, avoiding rate-limit issues from per-record GET calls.Input Parameters
Output
Read a batch of CRM object properties
Read a batch of CRM object properties
HUBSPOT_READ_BATCH_CRM_OBJECT_PROPERTIESRetrieves property definitions (metadata) for a batch of CRM object properties for a specified object type. Returns detailed information about property structure, data types, options, and configuration—not the actual property values of CRM records.Input Parameters
objectType.Output
Read batch feedback submissions by id or property
Read batch feedback submissions by id or property
HUBSPOT_READ_BATCH_FEEDBACK_SUBMISSIONS_BY_ID_OR_PROPERTYRetrieves up to 100 feedback submissions in a batch using their IDs or a specified unique idProperty, optionally including specified properties and their history.Input Parameters
inputs should contain values for this property if provided.Output
Read batch of crm objects by id or property values
Read batch of crm objects by id or property values
HUBSPOT_READ_BATCH_OF_CRM_OBJECTS_BY_ID_OR_PROPERTY_VALUESReads a batch of CRM objects of a specified objectType using their HubSpot IDs or unique property values from the inputs list, allowing retrieval of specific properties, their historical values (propertiesWithHistory), and filtering by archived status.Input Parameters
idProperty.Output
Read batch of line items by id or property values
Read batch of line items by id or property values
HUBSPOT_READ_BATCH_OF_LINE_ITEMS_BY_ID_OR_PROPERTY_VALUESRetrieves a batch of HubSpot CRM line items by their IDs, or optionally by values of a custom unique property defined in idProperty.Input Parameters
idProperty.Output
Read batch of quotes by property values
Read batch of quotes by property values
HUBSPOT_READ_BATCH_OF_QUOTES_BY_PROPERTY_VALUESEfficiently retrieves a batch of HubSpot CRM quotes by their IDs (or a specified unique property), optionally including archived quotes, specific properties, and property history.Input Parameters
id field that holds the identifier of the quote, corresponding to idProperty or the primary object ID.true, only archived quotes are returned. If false (default) or omitted, only active (non-archived) quotes are returned.inputs list. If omitted, the quote’s primary object ID (e.g., hs_object_id) is used. This property must be a unique identifier for quotes.Output
Read budget
Read budget
Read contact
Read contact
Read contacts
Read contacts
HUBSPOT_READ_CONTACTSBatch read multiple HubSpot contacts by their IDs or custom identifier property. This action retrieves up to 100 contacts per request using the HubSpot CRM batch read API. You can specify which contact properties to return and optionally include historical values for properties.Input Parameters
id (or the idProperty if specified) of a contact.true), or only non-archived contacts (false).inputs objects should provide values for this property instead of the default id.Output
Read crm object by id
Read crm object by id
HUBSPOT_READ_CRM_OBJECT_BY_IDRetrieves a specific CRM object (e.g., contact, company, deal, ticket) by its ID or a unique property, optionally including specific properties, history, and associations.Input Parameters
idProperty is specified. Accepts both string and numeric values (numeric IDs are converted to strings automatically).Output
ReadEmail Email
ReadEmail Email
HUBSPOT_READ_EMAILRetrieves an existing HubSpot CRM email object by its email ID or by the value of an alternative unique property, with the property name specified separately.Input Parameters
idProperty if specified.Output
Read feedback submission by id
Read feedback submission by id
HUBSPOT_READ_FEEDBACK_SUBMISSION_BY_IDReads a HubSpot feedback submission by ID or a custom unique property, with selected properties and property history. The returned properties are limited to the fields represented in the response model.Input Parameters
Output
Read legacy contact profile
Read legacy contact profile
HUBSPOT_READ_LEGACY_CONTACT_PROFILERetrieve one legacy HubSpot contact profile by VID when form submissions, identity profiles, merge audits, or legacy-shaped property history are needed.Input Parameters
Output
Read legacy contact profiles by email
Read legacy contact profiles by email
HUBSPOT_READ_LEGACY_CONTACT_PROFILES_BY_EMAILBatch-read up to 100 legacy HubSpot contact profiles by email when form submissions, identity profiles, merge audits, or legacy-shaped property history are needed.Input Parameters
Output
Read legacy contact profiles by VID
Read legacy contact profiles by VID
HUBSPOT_READ_LEGACY_CONTACT_PROFILES_BY_VIDBatch-read up to 100 legacy HubSpot contact profiles by VID when legacy-shaped profile data is needed.Input Parameters
Output
Read a property group
Read a property group
HUBSPOT_READ_PROPERTY_GROUPRetrieves metadata for a specific property group of a given CRM object type, detailing its structure and attributes, but not the actual property values of CRM objects.Input Parameters
Output
Read property groups for object type
Read property groups for object type
Remove asset association
Remove asset association
HUBSPOT_REMOVE_ASSET_ASSOCIATIONDisassociates an asset from a HubSpot marketing campaign. Supports a wide range of asset types including forms, landing pages, emails, blog posts, workflows, static lists, and more.Input Parameters
Output
Remove association between CRM records
Remove association between CRM records
Remove association from schema
Remove association from schema
HUBSPOT_REMOVE_ASSOCIATION_FROM_SCHEMAPermanently removes a specified association definition (type) from a HubSpot object’s schema, preventing future creations of this association type without affecting existing instances.Input Parameters
Output
Remove contact secondary email
Remove contact secondary email
Remove settings user
Remove settings user
Remove token from event template
Remove token from event template
HUBSPOT_REMOVE_TOKEN_FROM_EVENT_TEMPLATERemoves a token from a HubSpot event template, preventing its inclusion in new events created from that template.Input Parameters
Output
Rename CRM list
Rename CRM list
Render event detail template
Render event detail template
Render event header or detail as html
Render event header or detail as html
HUBSPOT_RENDER_EVENT_HEADER_OR_DETAIL_AS_HTMLRenders an event’s header or detail template as HTML for a specified event on the HubSpot CRM timeline, using a given event template ID and event ID.Input Parameters
Output
Replace all properties of pipeline
Replace all properties of pipeline
HUBSPOT_REPLACE_ALL_PROPERTIES_OF_PIPELINEOverwrites an entire CRM pipeline (specified by objectType and pipelineId) and all its stages with a new definition, returning the updated pipeline.Input Parameters
label.objectType is ‘deals’, checks deal stage usage before modification/deletion to prevent data issues.Output
Replace pipeline stage properties
Replace pipeline stage properties
HUBSPOT_REPLACE_PIPELINE_STAGE_PROPERTIESReplaces all properties of a specified pipeline stage; the new label must be unique within the pipeline, and if objectType is ‘deals’, the metadata must include a ‘probability’ key.Input Parameters
objectType, ‘probability’ (string: number from 0.0-1.0 in 0.1 increments, e.g., ‘0.5’) is required. For ‘tickets’ objectType, ‘ticketState’ (string: ‘OPEN’ or ‘CLOSED’) is optional.displayOrder value are sorted alphabetically by their label. Use -1 to place the stage at the end.Output
Reset draft
Reset draft
HUBSPOT_RESET_DRAFTResets a marketing email’s draft to its currently published (live) version, discarding all unpublished changes; the email must have a live version to revert to.Input Parameters
Output
Restore a revision of a marketing email to draft state
Restore a revision of a marketing email to draft state
Restore a revision of a marketing email
Restore a revision of a marketing email
Retrieve all object schemas
Retrieve all object schemas
HUBSPOT_RETRIEVE_ALL_OBJECT_SCHEMASRetrieves all object schema definitions (not data records) for a HubSpot account, supporting retrieval of either active or archived schemas.Input Parameters
Output
Retrieve all pipelines for specified object type
Retrieve all pipelines for specified object type
Retrieve calling settings for app
Retrieve calling settings for app
Retrieve line item by id
Retrieve line item by id
HUBSPOT_RETRIEVE_LINE_ITEM_BY_IDRetrieves a HubSpot CRM line item by its ID or a specified unique property (idProperty).Input Parameters
idProperty. Use HUBSPOT_RETRIEVE_LINE_ITEMS_LIST or HUBSPOT_SEARCH_LINE_ITEMS_BY_CRITERIA to find valid IDs.Output
Retrieve line items list
Retrieve line items list
HUBSPOT_RETRIEVE_LINE_ITEMSFetches a paginated list of HubSpot CRM line items, with archive filtering and optional associated object IDs. Returned properties are limited to the fields supported by the response model; requested property history is not retained.Input Parameters
true for archived only, false (default) for active only. Manages historical or current items.["name", "price"]); customizes returned data. Non-existent properties are ignored. If omitted, a default set is returned.["deal", "product"]) for which to retrieve associated IDs. Invalid types are ignored. Valid types depend on HubSpot data model.["status", "amount"]); tracks changes. May reduce items returned per request due to increased payload.Output
Retrieve existing object schema
Retrieve existing object schema
HUBSPOT_RETRIEVE_OBJECT_SCHEMAFetches the detailed schema definition for a specified, existing standard or custom HubSpot CRM object type; this action is read-only and does not create or modify schemas.Input Parameters
Output
Retrieve owner by ID or user ID
Retrieve owner by ID or user ID
HUBSPOT_RETRIEVE_OWNER_BY_ID_OR_USER_IDRetrieves a specific HubSpot CRM owner by their ID, with options to specify ID type (owner or user) and to include archived records.Input Parameters
idProperty.true to retrieve only archived owners; otherwise, active (non-archived) owners are returned.ownerId refers to the HubSpot owner ID (id) or the user ID (userId).Output
Retrieve owners
Retrieve owners
Retrieve page of crm owners
Retrieve page of crm owners
Retrieve pipeline stage by id
Retrieve pipeline stage by id
HUBSPOT_RETRIEVE_PIPELINE_STAGE_BY_IDRetrieves details and metadata for a specific HubSpot CRM pipeline stage identified by object type, pipeline ID, and stage ID.Input Parameters
objectType.Output
Retrieve pipeline stages
Retrieve pipeline stages
HUBSPOT_RETRIEVE_PIPELINE_STAGESFetches all stages for a specified HubSpot CRM object type and pipeline ID.Input Parameters
Output
Retrieve timeline event by ids
Retrieve timeline event by ids
HUBSPOT_RETRIEVE_TIMELINE_EVENT_BY_IDSRetrieves a specific HubSpot CRM timeline event by its application ID, event template ID, and event ID, returning event details including timestamp, tokens, and associated object information.Input Parameters
Output
Retrieve video conference settings by id
Retrieve video conference settings by id
HUBSPOT_RETRIEVE_VIDEO_CONFERENCE_SETTINGS_BY_IDRetrieves video conference application settings for a specified app, including meeting webhook URLs and a user verification URL.Input Parameters
Output
Schedule blog post
Schedule blog post
Schedule landing page
Schedule landing page
Search CMS content
Search CMS content
HUBSPOT_SEARCH_CMS_CONTENTSearch HubSpot’s indexed CMS content.Input Parameters
Output
Search companies
Search companies
Search contacts by criteria
Search contacts by criteria
HUBSPOT_SEARCH_CONTACTS_BY_CRITERIASearches for HubSpot contacts using a text query, specific filter criteria (filters in a group are ANDed, groups are ORed), sorting, and pagination to retrieve selected properties.Input Parameters
after value from the paging.next object of a previous response to fetch the next set of results. If None or an empty string, it fetches the first page.propertyName and a sort direction. Example: [{'propertyName': 'lastname', 'direction': 'ASCENDING'}] sorts contacts by last name.[{'filters': [{'propertyName': 'icp_segment', 'operator': 'EQ', 'value': 'Construction'}]}]. If you need more filter groups or filters, split your search into multiple requests.custom_lead_score). This is a convenience alias that gets merged into properties before the API call - you can also include custom properties directly in the properties field instead.Output
Search CRM lists
Search CRM lists
Search crm objects by criteria
Search crm objects by criteria
HUBSPOT_SEARCH_CRM_OBJECTS_BY_CRITERIASearches HubSpot CRM objects by object type using a text query or filter groups, with sorting and pagination. At least one query or filter group is required; property names must be valid for the specified object type.Input Parameters
Output
Search deals
Search deals
HUBSPOT_SEARCH_DEALSSearches for HubSpot deals using flexible criteria and filters.Input Parameters
paging.next.after to fetch the next page; omit for the first page. Note: HubSpot’s search API has a hard limit of 10,000 total results - the ‘after’ value must be less than 10000.Output
Search emails
Search emails
Search feedback submissions
Search feedback submissions
HUBSPOT_SEARCH_FEEDBACK_SUBMISSIONSSearches HubSpot CRM feedback submissions using a text query, filter groups, sorting, and pagination. Returned properties are limited to the fields represented in the response model.Input Parameters
-) for descending order. Defaults to creation order (oldest first) if omitted.Output
Search files
Search files
Search line items by criteria
Search line items by criteria
HUBSPOT_SEARCH_LINE_ITEMS_BY_CRITERIASearches HubSpot line items using criteria including filters, sorting, and pagination; after must be a valid cursor from a previous response, and sorts/properties must refer to valid line item property names.Input Parameters
Output
Search products
Search products
HUBSPOT_SEARCH_PRODUCTSSearches for HubSpot products using flexible criteria and filters.Input Parameters
after value from the paging.next.after property of a previous response.propertyName and a direction. For example, [{'propertyName': 'name', 'direction': 'ASCENDING'}] sorts products by name alphabetically.[{'filters': [{'propertyName': 'price', 'operator': 'GT', 'value': '100'}]}].['custom_field_api_name_1', 'custom_field_api_name_2'].Output
Search quotes by criteria
Search quotes by criteria
HUBSPOT_SEARCH_QUOTES_BY_CRITERIASearches HubSpot CRM quotes using a text query, complex filter criteria, sorting, and pagination.Input Parameters
Output
Search tickets
Search tickets
Set call recording settings
Set call recording settings
HUBSPOT_SET_CALL_RECORDING_SETTINGSConfigures the URL (urlToRetrieveAuthedRecording) that HubSpot uses to retrieve call recordings for a specified third-party calling app (appId). The URL must contain a %s placeholder which HubSpot replaces with the engagement’s externalId. The calling app must be an existing calling extension app integrated with the HubSpot account.Input Parameters
Output
Initiate data import process
Initiate data import process
HUBSPOT_START_IMPORTStarts an asynchronous HubSpot CRM import using one uploaded file and an import configuration JSON mapping its columns to HubSpot properties.Input Parameters
importRequest.name (a descriptive name for the import, e.g., “Q3 Contact Import”), dateFormat (e.g., ‘MONTH_DAY_YEAR’, ‘DAY_MONTH_YEAR’), importOperations (defines if the import should create and update, only create, or only update records, e.g., ‘CREATE_AND_UPDATE’), and files (an array detailing each file, its format, and columnMappings). The columnMappings are crucial as they map spreadsheet columns to HubSpot CRM object properties (e.g., map ‘Email Address’ column to ‘CONTACT’ object’s ‘email’ property).Output
Update a marketing email
Update a marketing email
HUBSPOT_UPDATE_A_MARKETING_EMAILUpdates properties of an existing marketing email identified by its emailId; unspecified fields retain their current values.Input Parameters
true and the email state is set to ‘PUBLISHED’, the email will be sent immediately. If false for a ‘PUBLISHED’ state, it implies it was already sent or is a template.blogEmailType.replyTo address for replies.true, HubSpot will attempt to avoid sending this email to contacts classified as ‘graymail’ (low engagement).true, respects HubSpot’s send frequency limits for contacts. If false, may override these limits.redirectToPageId is not set.true, the headline of the latest blog post will be used as the email’s subject line for RSS emails.Output
Update batch feedback submissions
Update batch feedback submissions
HUBSPOT_UPDATE_BATCH_FEEDBACK_SUBMISSIONSUpdates a batch of HubSpot feedback submissions; property keys must be existing internal HubSpot names and values must be correctly formatted strings.Input Parameters
Output
Update a batch of objects by id or property values
Update a batch of objects by id or property values
HUBSPOT_UPDATE_BATCH_OF_OBJECTS_BY_IDOR_PROPERTY_VALUESPerforms a batch update on a valid objectType where properties are writeable and any idProperty used is designated unique; updates can be partial.Input Parameters
Output
Update calling app recording settings
Update calling app recording settings
Modify calling extension settings
Modify calling extension settings
HUBSPOT_UPDATE_CALLING_EXTENSION_SETTINGSUpdates settings (e.g., display name, UI URL/dimensions, feature flags) for an existing calling extension app, identified by appId.Input Parameters
true, the calling service appears as an option under the ‘Call’ action in contact records.Output
Update campaign
Update campaign
HUBSPOT_UPDATE_CAMPAIGNPartially updates specific, writable properties of an existing HubSpot marketing campaign identified by campaignGuid; an empty string value in properties clears a property.Input Parameters
Output
Update a batch of campaigns
Update a batch of campaigns
Update companies
Update companies
Update company
Update company
HUBSPOT_UPDATE_COMPANYUpdates properties for an existing HubSpot company.Input Parameters
Output
Update contact
Update contact
HUBSPOT_UPDATE_CONTACTUpdates properties for an existing HubSpot contact. Known read-only properties are filtered out; if no properties remain, the current contact is returned without an update.Input Parameters
Output
Update contacts
Update contacts
Update specific CRM property
Update specific CRM property
HUBSPOT_UPDATE_CRM_PROPERTYUpdates attributes of an existing HubSpot CRM property, identified by its objectType and propertyName; only provided fields are modified, and changing a property’s type can cause data loss if incompatible with existing data.Input Parameters
type of an existing property with data can cause data loss; use with caution.type is ‘enumeration’; supplying a new list overwrites existing options.objectType.fieldType is ‘calculation_equation’; defines how its value is auto-computed. Ensure valid HubSpot calculation syntax.Output
Update deal
Update deal
HUBSPOT_UPDATE_DEALUpdates properties for an existing HubSpot deal.Input Parameters
Output
Update deals
Update deals
UpdateEmail Email
UpdateEmail Email
HUBSPOT_UPDATE_EMAILPartially updates properties of an existing HubSpot email object, identified by emailId (as internal ID or custom unique property value if idProperty is given); the object must exist.Input Parameters
idProperty is also provided.emailId must be the value of this unique property, not the internal HubSpot ID.Output
Update emails
Update emails
Update email subscriptions
Update email subscriptions
HUBSPOT_UPDATE_EMAIL_SUBSCRIPTIONSIRREVERSIBLY opt out or update email subscription preferences in HubSpot.Input Parameters
Output
Update existing event template
Update existing event template
HUBSPOT_UPDATE_EVENT_TEMPLATEUpdates an existing HubSpot event template’s name, display templates, and tokens; providing tokens replaces the entire existing list, and the id in the request body must match eventTemplateId in the path.Input Parameters
{{token_name}}).{{token_name}}).Output
Update feedback submission by id
Update feedback submission by id
HUBSPOT_UPDATE_FEEDBACK_SUBMISSIONPartially updates writable properties of an existing HubSpot Feedback Submission, identified by its feedbackSubmissionId (which can be an internal object ID, or a unique property value if idProperty is specified).Input Parameters
feedbackSubmissionId must contain the value of this property, instead of the internal object ID. This property must be a unique identifier for Feedback Submission objects.idProperty is specified. Must be a non-empty string.Output
Update landing page
Update landing page
Update landing page draft
Update landing page draft
HUBSPOT_UPDATE_LANDING_PAGE_DRAFTPartially update a HubSpot landing page draft without publishing it.Input Parameters
Output
Update line item object partially
Update line item object partially
HUBSPOT_UPDATE_LINE_ITEMPartially updates specified properties of an existing HubSpot Line Item, identified by lineItemId (as HubSpot object ID or value of idProperty if used); new values overwrite existing ones, and an empty string clears a property.Input Parameters
lineItemId must contain this property’s value. Must be a valid, unique-value property for Line Items.idProperty is specified. Must be non-empty.{'quantity': '5', 'name': 'New Product Name'}.Output
Update a batch of line items
Update a batch of line items
HUBSPOT_UPDATE_LINE_ITEMSUpdates a batch of existing HubSpot CRM line items in a single operation, identifying each by its primary ID or a unique idProperty (which must be a unique identifier property in HubSpot), and modifies their specified properties.Input Parameters
Output
Update list filters
Update list filters
Update list memberships
Update list memberships
Update existing object schema
Update existing object schema
HUBSPOT_UPDATE_OBJECT_SCHEMAUpdates an existing custom object schema’s metadata in HubSpot, such as its description, labels, display properties, required properties, searchable properties, and restorability, for a specified objectType that must already exist.Input Parameters
true to enable restoration, false otherwise.Output
Partially update pipeline by id
Partially update pipeline by id
HUBSPOT_UPDATE_PIPELINEPartially updates a CRM pipeline’s label, display order, or restores an archived pipeline by setting archived to false.Input Parameters
false. Other uses (e.g., archiving an active pipeline or setting false for an already active one) will result in a 400 Bad Request.true, verify existing references to pipeline stages before updates that could delete or alter them.Output
Update pipeline stage by ids
Update pipeline stage by ids
HUBSPOT_UPDATE_PIPELINE_STAGEPartially updates a HubSpot CRM pipeline stage identified by object type, pipeline ID, and stage ID. Metadata can be supplied along with other stage fields.Input Parameters
pipelineId.true to archive the pipeline stage, false to unarchive. If omitted, its archival status remains unchanged.objectType. Omit to leave unchanged. - For ‘deals’: If provided, MUST include ‘probability’ (string ‘0.0’-‘1.0’, e.g., ‘0.7’, in ‘0.1’ increments). - For ‘tickets’: Optional ‘ticketState’ (‘OPEN’ or ‘CLOSED’). - For other object types, an empty {} may be used.objectType) containing the stage to update; must refer to an existing pipeline.displayOrder, they are sorted alphabetically by label. Lower numbers appear first. Omit to leave unchanged.Output
Update product
Update product
Update products
Update products
Partially update property group
Partially update property group
HUBSPOT_UPDATE_PROPERTY_GROUPPartially updates a property group’s displayOrder or label for a specified CRM objectType in HubSpot.Input Parameters
objectType.Output
Partial update quote by quote id
Partial update quote by quote id
HUBSPOT_UPDATE_QUOTEPerforms a partial update on an existing HubSpot quote’s specified properties, identifying the quote by quoteId (either its internal ID or a custom unique property value if idProperty is provided).Input Parameters
idProperty is specified.quoteId is interpreted as this property’s value, not the internal object ID.Output
Update site page
Update site page
Update site page draft
Update site page draft
HUBSPOT_UPDATE_SITE_PAGE_DRAFTPartially update a site-page draft; supplied nested objects replace in full.Input Parameters
Output
Update ticket
Update ticket
Update tickets
Update tickets
Update token on event template
Update token on event template
HUBSPOT_UPDATE_TOKEN_ON_EVENT_TEMPLATEUpdates an existing token in a HubSpot CRM event template, including its label, options, or CRM object property mapping. The token name and data type remain unchanged.Input Parameters
Output
Update video conference app settings
Update video conference app settings
HUBSPOT_UPDATE_VIDEO_CONFERENCE_APP_SETTINGSUpdates webhook URLs for a specified HubSpot video conference application, including URLs for creating, updating and deleting meetings, fetching accounts, and verifying users.Input Parameters
Output
Update workflow
Update workflow
HUBSPOT_UPDATE_WORKFLOWFully replace an existing Automation v4 workflow at its current revision.Input Parameters
Output
Upsert companies
Upsert companies
Upsert contacts
Upsert contacts
Triggers
Contact Created Trigger
Contact Created Trigger