> ## Documentation Index
> Fetch the complete documentation index at: https://squad.so/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# HubSpot
> What agents can do in HubSpot at each access level, and how to connect, limit, and disconnect HubSpot.
Connect HubSpot so your agents can work in your HubSpot account. You choose an access level for each account, and Squad refuses any agent action outside that level.
## Access levels
Each HubSpot account has an access level: **Read-only**, **Read + write CRM**, and **Full access**. Squad refuses any agent action outside that level. You can also narrow or block single agents under **Per-agent access**.
| Level | The connect window describes this level as | Actions agents can use |
| ---------------------------------- | --------------------------------------------------- | ---------------------- |
| **Read-only** | "Read contacts, companies, deals, tickets." | 72 of 260 |
| **Read + write CRM** (recommended) | "Read/write contacts, companies, deals, tickets." | 230 of 260 |
| **Full access** | "Everything plus workflows, content, forms, leads." | 260 of 260 |
**Read + write CRM** is the recommended level. The connect window selects it for you, and you can choose another level.
The HubSpot sign-in page asks you to approve full access to your account. This is expected. Squad does not narrow the sign-in. It checks every agent action against the level you chose, and it refuses actions outside that level.
## What agents can do at each level
Each level opens with a short summary in plain tasks, then lists every action it adds, grouped by what the action works on. You do not need to name actions. Ask in plain words, and the agent searches for the matching action.
**Find an action.** Open a level and use your browser's find (Ctrl+F, or Cmd+F on a Mac) with a word from the task or part of a slug. Or ask your agent in plain words, for example "What can you do in my HubSpot account?" The agent can search the HubSpot actions for you.
Each action shows its name, a one-line description where the HubSpot action catalog has one, and its slug. The slug is the ID that agents use when they call the action.
Agents can use 72 of the 260 HubSpot actions at this level:
* View and search emails
* View properties
* View and search responses
* View and search companies
* View and search line items
* View and search quotes
* View settings
* View and run templates
* View and search campaigns
* View contacts
* View events
* View groups
All 72 actions at this level:
| Action | What it does | Slug |
| ---------------- | ----------------------------------------------------------------------------------------- | -------------------------- |
| Get account info | Gets current HubSpot account info (email, hubId, user details) using access-token lookup. | `HUBSPOT_GET_ACCOUNT_INFO` |
| Action | What it does | Slug |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| List assets | Lists assets of a specific assetType for a given HubSpot marketing campaignGuid, optionally including performance metrics for a date range. | `HUBSPOT_LIST_ASSETS` |
| Action | What it does | Slug |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| Get pipeline stage audit | Retrieves a reverse chronological list of all mutations (changes) for a specific pipeline stage, including CREATE and UPDATE events with timestamps and details. | `HUBSPOT_GET_PIPELINE_STAGE_AUDIT` |
| Action | What it does | Slug |
| ---------------- | ------------------------------------- | -------------------------- |
| Get campaigns | Retrieves multiple HubSpot campaigns. | `HUBSPOT_GET_CAMPAIGNS` |
| Search campaigns | Searches for HubSpot campaigns. | `HUBSPOT_SEARCH_CAMPAIGNS` |
| Action | What it does | Slug |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| Audit pipeline changes | Retrieves 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'). | `HUBSPOT_AUDIT_PIPELINE_CHANGES` |
| Action | What it does | Slug |
| ---------------------------------- | ----------------------------------------------------------------------------------- | -------------------------------------------- |
| Batch read companies by properties | Batch-retrieves up to 100 HubSpot company records by their IDs in a single request. | `HUBSPOT_BATCH_READ_COMPANIES_BY_PROPERTIES` |
| List companies | Retrieves a paginated list of HubSpot companies. | `HUBSPOT_LIST_COMPANIES` |
| Search companies | Searches for HubSpot companies using flexible criteria and filters. | `HUBSPOT_SEARCH_COMPANIES` |
| Action | What it does | Slug |
| --------------- | ---------------------------------------------------------------------------------------- | ------------------------- |
| Get contact IDs | Fetches a list of contact IDs for a specific HubSpot campaign based on interaction type. | `HUBSPOT_GET_CONTACT_IDS` |
| List contacts | Retrieves a paginated list of HubSpot contacts. | `HUBSPOT_LIST_CONTACTS` |
| Action | What it does | Slug |
| ---------- | -------------------------------------------- | -------------------- |
| List deals | Retrieves a paginated list of HubSpot deals. | `HUBSPOT_LIST_DEALS` |
| Action | What it does | Slug |
| ------------------------- | ---------------------------------------------------------------- | ----------------------------------- |
| Get marketing email draft | Retrieves the draft version of a marketing email by its emailId. | `HUBSPOT_GET_MARKETING_EMAIL_DRAFT` |
| Action | What it does | Slug |
| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| Get ab email variation | Retrieves the alternate variation of a specified A/B marketing email. | `HUBSPOT_GET_AB_EMAIL_VARIATION` |
| Get all marketing emails for a HubSpot account | | `HUBSPOT_GET_ALL_MARKETING_EMAILS_FOR_A_HUBSPOT_ACCOUNT` |
| Get the details of a specified marketing email | Retrieves detailed information for a specific marketing email in HubSpot using its unique email ID, optionally including performance statistics and specific properties. | `HUBSPOT_GET_THE_DETAILS_OF_A_SPECIFIED_MARKETING_EMAIL` |
| List emails | Retrieves a paginated list of HubSpot emails, allowing selection of specific properties (with or without history), associated object IDs, and filtering by archive status. | `HUBSPOT_LIST_EMAILS` |
| Read email | Retrieve an existing HubSpot email by its emailId or an alternative unique idProperty. | `HUBSPOT_READ_EMAIL` |
| Search emails | Searches for HubSpot emails using flexible criteria and filters. | `HUBSPOT_SEARCH_EMAILS` |
| Action | What it does | Slug |
| ---------------------------------- | ------------ | -------------------------------------------- |
| List recently modified engagements | | `HUBSPOT_LIST_RECENTLY_MODIFIED_ENGAGEMENTS` |
| Action | What it does | Slug |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| Fetch import error details | Fetches a paginated list of read-only error details for a specific HubSpot CRM import, requiring a valid importId for a processed import. | `HUBSPOT_FETCH_IMPORT_ERROR_DETAILS` |
| Action | What it does | Slug |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| List email events | | `HUBSPOT_LIST_EMAIL_EVENTS` |
| Render event header or detail as HTML | Renders 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. | `HUBSPOT_RENDER_EVENT_HEADER_OR_DETAIL_AS_HTML` |
| Retrieve timeline event by IDs | Retrieves 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. | `HUBSPOT_RETRIEVE_TIMELINE_EVENT_BY_IDS` |
| Action | What it does | Slug |
| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
| Read property group | Retrieves 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. | `HUBSPOT_READ_PROPERTY_GROUP` |
| Read property groups for object type | Retrieves all property groups in a single call for a specified HubSpot CRM object type (e.g., 'contacts', 'companies'), returning only the groups themselves, not the individual properties within them. | `HUBSPOT_READ_PROPERTY_GROUPS_FOR_OBJECT_TYPE` |
| Action | What it does | Slug |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| Retrieve line item by ID | Retrieves a HubSpot CRM line item by its ID or a specified unique property (idProperty). | `HUBSPOT_RETRIEVE_LINE_ITEM_BY_ID` |
| Retrieve line items | Fetches a paginated list of HubSpot CRM line items, allowing selection of specific properties (including history), associated object IDs, and filtering by archive status. | `HUBSPOT_RETRIEVE_LINE_ITEMS` |
| Search line items by criteria | Searches HubSpot line items using criteria including filters, sorting, and pagination. | `HUBSPOT_SEARCH_LINE_ITEMS_BY_CRITERIA` |
| Action | What it does | Slug |
| ----------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------- |
| Get active imports list | Retrieves a list of currently active import jobs in HubSpot for monitoring ongoing data operations. | `HUBSPOT_GET_ACTIVE_IMPORTS_LIST` |
| Action | What it does | Slug |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
| Read CRM object by ID | Retrieves a specific CRM object (e.g., contact, company, deal, ticket) by its ID or a unique property, optionally including specific properties, history, and associations. | `HUBSPOT_READ_CRM_OBJECT_BY_ID` |
| Action | What it does | Slug |
| --------------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| Retrieve page of CRM owners | Retrieves a paginated list of CRM owners from HubSpot, optionally filtering by email or archived status. | `HUBSPOT_RETRIEVE_PAGE_OF_CRM_OWNERS` |
| Action | What it does | Slug |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| Retrieve pipeline stage by ID | Fetches detailed properties and metadata (e.g., label, display order, custom properties) for a specific stage within a HubSpot CRM pipeline, identified by its objectType, pipelineId, and stageId. | `HUBSPOT_RETRIEVE_PIPELINE_STAGE_BY_ID` |
| Retrieve pipeline stages | Fetches all stages for a specified HubSpot CRM object type and pipeline ID. | `HUBSPOT_RETRIEVE_PIPELINE_STAGES` |
| Action | What it does | Slug |
| ------------------------------------------------ | ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| Get pipeline by ID | Retrieves a specific pipeline by its ID and CRM object type, detailing its stages and properties. | `HUBSPOT_GET_PIPELINE_BY_ID` |
| Retrieve all pipelines for specified object type | Retrieves all pipelines in HubSpot for a specified CRM object type, such as deals or tickets. | `HUBSPOT_RETRIEVE_ALL_PIPELINES_FOR_SPECIFIED_OBJECT_TYPE` |
| Action | What it does | Slug |
| ------------- | ----------------------------------------------- | ----------------------- |
| List products | Retrieves a paginated list of HubSpot products. | `HUBSPOT_LIST_PRODUCTS` |
| Action | What it does | Slug |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------ |
| List contact properties | Lists all contact properties in your HubSpot account, including custom properties you've created. | `HUBSPOT_LIST_CONTACT_PROPERTIES` |
| Read a CRM property by name | Reads a specific CRM property definition for a given HubSpot object type by its internal name. | `HUBSPOT_READ_A_CRM_PROPERTY_BY_NAME` |
| Read all properties for object type | Retrieves definitions and metadata (not actual values) for properties of a specified HubSpot CRM object type (e.g., 'contacts', 'companies', 'deals', or custom objects). | `HUBSPOT_READ_ALL_PROPERTIES_FOR_OBJECT_TYPE` |
| Read batch CRM object properties | Retrieves property definitions (metadata) for a batch of CRM object properties for a specified object type. | `HUBSPOT_READ_BATCH_CRM_OBJECT_PROPERTIES` |
| Read batch of CRM objects by ID or property values | Reads 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. | `HUBSPOT_READ_BATCH_OF_CRM_OBJECTS_BY_ID_OR_PROPERTY_VALUES` |
| Read batch of line items by ID or property values | Retrieves a batch of HubSpot CRM line items by their IDs, or optionally by values of a custom unique property defined in idProperty. | `HUBSPOT_READ_BATCH_OF_LINE_ITEMS_BY_ID_OR_PROPERTY_VALUES` |
| Read batch of quotes by property values | Efficiently retrieves a batch of HubSpot CRM quotes by their IDs (or a specified unique property), optionally including archived quotes, specific properties, and property history. | `HUBSPOT_READ_BATCH_OF_QUOTES_BY_PROPERTY_VALUES` |
| Action | What it does | Slug |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| Get quote | Retrieves a specific HubSpot quote by its unique identifier. | `HUBSPOT_GET_QUOTE` |
| List quotes | Retrieves a paginated list of quotes, allowing selection of specific properties, property history, associated object IDs, and filtering by archived status. | `HUBSPOT_LIST_QUOTES` |
| Search quotes by criteria | Searches HubSpot CRM quotes using a text query, complex filter criteria, sorting, and pagination. | `HUBSPOT_SEARCH_QUOTES_BY_CRITERIA` |
| Action | What it does | Slug |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| Get import record information | Retrieves a comprehensive summary of a specific HubSpot CRM import record by its importId, including status, progress, updates, results, and errors. | `HUBSPOT_GET_IMPORT_RECORD_INFORMATION` |
| Action | What it does | Slug |
| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| Get aggregated statistic intervals | Retrieves aggregated statistics for marketing emails (e.g., send counts), grouped by specified time intervals within a defined time range. | `HUBSPOT_GET_AGGREGATED_STATISTIC_INTERVALS` |
| Get aggregated statistics | Retrieves aggregated statistics for marketing emails, optionally within an ISO8601 formatted time range, by email IDs, or specific email properties. | `HUBSPOT_GET_AGGREGATED_STATISTICS` |
| Get campaign metrics | Retrieves key attribution metrics for an existing marketing campaign, identified by its campaignGuid, within an optional date range. | `HUBSPOT_GET_CAMPAIGN_METRICS` |
| Action | What it does | Slug |
| ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
| List feedback submissions | Retrieves a paginated list of feedback submissions from HubSpot, allowing specification of properties (including history), associated object IDs, and filtering by archive status. | `HUBSPOT_LIST_FEEDBACK_SUBMISSIONS` |
| Read batch feedback submissions by ID or property | Retrieves up to 100 feedback submissions in a batch using their IDs or a specified unique idProperty, optionally including specified properties and their history. | `HUBSPOT_READ_BATCH_FEEDBACK_SUBMISSIONS_BY_ID_OR_PROPERTY` |
| Read feedback submission by ID | Reads a HubSpot feedback submission by its ID, optionally using a custom unique 'idProperty', and allows specifying properties to return including history and associations. | `HUBSPOT_READ_FEEDBACK_SUBMISSION_BY_ID` |
| Search feedback submissions | Searches for feedback submissions in HubSpot CRM using text query, filter groups, sorting, and pagination, returning specified properties. | `HUBSPOT_SEARCH_FEEDBACK_SUBMISSIONS` |
| Action | What it does | Slug |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| Retrieve all object schemas | Retrieves all object schema definitions (not data records) for a HubSpot account, supporting retrieval of either active or archived schemas. | `HUBSPOT_RETRIEVE_ALL_OBJECT_SCHEMAS` |
| Retrieve object schema | Fetches the detailed schema definition for a specified, existing standard or custom HubSpot CRM object type. | `HUBSPOT_RETRIEVE_OBJECT_SCHEMA` |
| Action | What it does | Slug |
| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| Fetch recording settings | Fetches call recording settings for a specified, existing HubSpot calling extension app. | `HUBSPOT_FETCH_RECORDING_SETTINGS` |
| Retrieve calling settings for app | Retrieves the read-only calling extension settings for a specific HubSpot app. | `HUBSPOT_RETRIEVE_CALLING_SETTINGS_FOR_APP` |
| Retrieve video conference settings by ID | Retrieves video conference application settings, such as webhook URLs and user/account management configurations, for a specified appId. | `HUBSPOT_RETRIEVE_VIDEO_CONFERENCE_SETTINGS_BY_ID` |
| Action | What it does | Slug |
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
| Get event template | Retrieves detailed information about a specific event template for a given application in HubSpot's CRM timeline. | `HUBSPOT_GET_EVENT_TEMPLATE` |
| List event templates | Retrieves all event templates associated with a valid appId for an existing application in HubSpot's CRM Timeline. | `HUBSPOT_LIST_EVENT_TEMPLATES` |
| Render event detail template | Renders detailed information for a specific HubSpot CRM timeline event using a predefined event template, ignoring extraData references in the template not present in event data. | `HUBSPOT_RENDER_EVENT_DETAIL_TEMPLATE` |
| Action | What it does | Slug |
| -------------- | ----------------------------------------------------------------- | ------------------------ |
| List tickets | Retrieves a paginated list of HubSpot tickets. | `HUBSPOT_LIST_TICKETS` |
| Search tickets | Searches for HubSpot tickets using flexible criteria and filters. | `HUBSPOT_SEARCH_TICKETS` |
| Action | What it does | Slug |
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| List association types | Lists all valid association types between two specified HubSpot CRM object types. | `HUBSPOT_LIST_ASSOCIATION_TYPES` |
| Read apage of objects by type | Retrieves a paginated list of objects for a specified and valid HubSpot CRM object type (e.g., 'contacts', 'companies', 'deals', or custom ID). | `HUBSPOT_READ_APAGE_OF_OBJECTS_BY_TYPE` |
| Action | What it does | Slug |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| Get marketing email revision | Retrieves a specific, previously saved revision of a marketing email using its unique email ID and revision ID. | `HUBSPOT_GET_MARKETING_EMAIL_REVISION` |
| Get marketing email revisions | Retrieves a paginated list of all historical versions (including full state like content, settings, metadata) for a specified, existing marketing email. | `HUBSPOT_GET_MARKETING_EMAIL_REVISIONS` |
| Action | What it does | Slug |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| Fetch revenue | Fetches a revenue attribution report for a specified, existing marketing campaign, optionally using a specific attribution model and date range. | `HUBSPOT_FETCH_REVENUE` |
| List granted scopes | Introspect the current OAuth access token and return its granted scopes and metadata. | `HUBSPOT_LIST_GRANTED_SCOPES` |
| Read budget | Fetches detailed budget (total, spent, remaining) and spend information for a marketing campaign, including an 'order' field for sequencing budget/spend items (0 is oldest). | `HUBSPOT_READ_BUDGET` |
Agents can use 230 of the 260 HubSpot actions at this level: everything in **Read-only**, plus:
* Create, update, archive, send, and publish emails
* Search, create, update, and archive contacts
* Search, create, update, and archive deals
* Search, create, update, and archive products
* Create, update, and archive companies
* Search, create, update, and archive objects
* Create, update, and archive tickets
* Create, update, and archive line items
* View and create associations
* Create, update, and archive responses
* Update settings
* Create and update campaigns
The 158 actions that this level adds to **Read-only**:
| Action | What it does | Slug |
| -------- | ------------ | ------------------ |
| Who am I | | `HUBSPOT_WHO_AM_I` |
| Action | What it does | Slug |
| ----------------------- | ------------ | --------------------------------- |
| List company activities | | `HUBSPOT_LIST_COMPANY_ACTIVITIES` |
| List deal activities | | `HUBSPOT_LIST_DEAL_ACTIVITIES` |
| Action | What it does | Slug |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- |
| Add asset association | Associates an existing asset ('FORM', 'OBJECT\_LIST', or 'EXTERNAL\_WEB\_URL') with a specified HubSpot marketing campaign. | `HUBSPOT_ADD_ASSET_ASSOCIATION` |
| Create association | Creates a new custom association definition (schema) for a custom object in HubSpot, specifying how this object type can relate to another object type. | `HUBSPOT_CREATE_ASSOCIATION` |
| Create object association | Create or label an association between two CRM records using HubSpot Associations v4 API. | `HUBSPOT_CREATE_OBJECT_ASSOCIATION` |
| List object associations | List all associations from a single CRM record to a specified target object type. | `HUBSPOT_LIST_OBJECT_ASSOCIATIONS` |
| Read associations batch | Batch-read CRM associations (e.g., deals→contacts, deals→companies) for up to 1,000 source record IDs in one request. | `HUBSPOT_READ_ASSOCIATIONS_BATCH` |
| Action | What it does | Slug |
| ---------------------- | ------------ | -------------------------------- |
| List call dispositions | | `HUBSPOT_LIST_CALL_DISPOSITIONS` |
| List company calls | | `HUBSPOT_LIST_COMPANY_CALLS` |
| Action | What it does | Slug |
| ---------------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------- |
| Create campaign | Creates a new HubSpot campaign. | `HUBSPOT_CREATE_CAMPAIGN` |
| Create campaigns | Creates multiple HubSpot campaigns by calling the single campaign creation endpoint for each campaign. | `HUBSPOT_CREATE_CAMPAIGNS` |
| Get campaign | Retrieves a HubSpot campaign by its ID. | `HUBSPOT_GET_CAMPAIGN` |
| Update campaign | Partially updates specific, writable properties of an existing HubSpot marketing campaign identified by campaignGuid. | `HUBSPOT_UPDATE_CAMPAIGN` |
| Update campaigns | Updates properties for up to 50 existing HubSpot marketing campaigns in a single batch operation. | `HUBSPOT_UPDATE_CAMPAIGNS` |
| Action | What it does | Slug |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
| Archive companies | Archives multiple HubSpot companies by their IDs. | `HUBSPOT_ARCHIVE_COMPANIES` |
| Archive company | Archives 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. | `HUBSPOT_ARCHIVE_COMPANY` |
| Create companies | Creates multiple new HubSpot companies in a single batch operation. | `HUBSPOT_CREATE_COMPANIES` |
| Create company | Creates a new HubSpot company. | `HUBSPOT_CREATE_COMPANY` |
| Get company | Retrieves a HubSpot company by its ID. | `HUBSPOT_GET_COMPANY` |
| Merge companies | Merges two existing company records of the same type in HubSpot CRM, where objectIdToMerge is absorbed into primaryObjectId. | `HUBSPOT_MERGE_COMPANIES` |
| Update companies | Updates multiple HubSpot companies in a single batch operation. | `HUBSPOT_UPDATE_COMPANIES` |
| Update company | Updates properties for an existing HubSpot company. | `HUBSPOT_UPDATE_COMPANY` |
| Action | What it does | Slug |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------- |
| Archive contact | Archives a HubSpot contact by its ID. | `HUBSPOT_ARCHIVE_CONTACT` |
| Archive contacts | Archives multiple HubSpot contacts by their IDs. | `HUBSPOT_ARCHIVE_CONTACTS` |
| Create contact | Creates a new HubSpot contact. | `HUBSPOT_CREATE_CONTACT` |
| Create contact from nl | Creates a new contact in HubSpot from a natural language description. | `HUBSPOT_CREATE_CONTACT_FROM_NL` |
| Create contacts | Creates multiple new HubSpot contacts in a single batch operation. | `HUBSPOT_CREATE_CONTACTS` |
| Merge contacts | Merges two HubSpot contacts into one. | `HUBSPOT_MERGE_CONTACTS` |
| Read contact | Retrieves a HubSpot contact by its ID. | `HUBSPOT_READ_CONTACT` |
| Read contacts | Batch read multiple HubSpot contacts by their IDs or custom identifier property. | `HUBSPOT_READ_CONTACTS` |
| Search contacts by criteria | Searches 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. | `HUBSPOT_SEARCH_CONTACTS_BY_CRITERIA` |
| Update contact | Updates properties for an existing HubSpot contact. | `HUBSPOT_UPDATE_CONTACT` |
| Update contacts | Updates multiple HubSpot contacts in a single batch operation. | `HUBSPOT_UPDATE_CONTACTS` |
| Upsert contacts | | `HUBSPOT_UPSERT_CONTACTS` |
| Action | What it does | Slug |
| ------------------- | ------------------------------------------------------------------------ | ----------------------------- |
| Archive deals | Archives multiple HubSpot deals by their IDs. | `HUBSPOT_ARCHIVE_DEALS` |
| Create deal | Creates a new HubSpot deal. | `HUBSPOT_CREATE_DEAL` |
| Create deal from nl | Creates a new deal in HubSpot from a natural language description. | `HUBSPOT_CREATE_DEAL_FROM_NL` |
| Create deals | Creates multiple deals in HubSpot CRM. | `HUBSPOT_CREATE_DEALS` |
| Get deal | Retrieves a HubSpot deal by its ID. | `HUBSPOT_GET_DEAL` |
| Get deals | Retrieves multiple HubSpot deals by their IDs in a single batch request. | `HUBSPOT_GET_DEALS` |
| Merge deals | Merges two HubSpot deals into one. | `HUBSPOT_MERGE_DEALS` |
| Search deals | Searches for HubSpot deals using flexible criteria and filters. | `HUBSPOT_SEARCH_DEALS` |
| Update deal | Updates properties for an existing HubSpot deal. | `HUBSPOT_UPDATE_DEAL` |
| Update deals | Updates multiple HubSpot deals in a single batch operation. | `HUBSPOT_UPDATE_DEALS` |
| Action | What it does | Slug |
| ----------- | --------------------------------------------------------------------------------------------------------------- | --------------------- |
| Reset draft | Resets a marketing email's draft to its currently published (live) version, discarding all unpublished changes. | `HUBSPOT_RESET_DRAFT` |
| Action | What it does | Slug |
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
| Archive email | Archives the HubSpot email specified by emailId by moving it to the recycling bin, making it inaccessible unless restored. | `HUBSPOT_ARCHIVE_EMAIL` |
| Archive emails | Archives multiple HubSpot emails by their IDs. | `HUBSPOT_ARCHIVE_EMAILS` |
| Clone marketing email | Duplicates an existing HubSpot marketing email, identified by its id, into a new draft. | `HUBSPOT_CLONE_MARKETING_EMAIL` |
| Create a new marketing email | Creates a new marketing email in HubSpot, allowing comprehensive configuration of content, recipients, sender details, A/B testing, scheduling, web version, and other settings. | `HUBSPOT_CREATE_A_NEW_MARKETING_EMAIL` |
| Create email | Creates a new HubSpot email engagement record. | `HUBSPOT_CREATE_EMAIL` |
| Create emails | Creates multiple HubSpot emails in a single batch operation. | `HUBSPOT_CREATE_EMAILS` |
| Get emails | Retrieves multiple HubSpot email engagement records by their IDs in a single batch request. | `HUBSPOT_GET_EMAILS` |
| Merge emails | Merges two HubSpot emails into one. | `HUBSPOT_MERGE_EMAILS` |
| Publish marketing email | Publishes or sends a specified HubSpot marketing email that is valid and ready for sending. | `HUBSPOT_PUBLISH_MARKETING_EMAIL` |
| Update a marketing email | Updates properties of an existing marketing email identified by its emailId. | `HUBSPOT_UPDATE_A_MARKETING_EMAIL` |
| Update email | Partially updates properties of an existing HubSpot email object, identified by emailId (as internal ID or custom unique property value if idProperty is given). | `HUBSPOT_UPDATE_EMAIL` |
| Update emails | Updates multiple HubSpot emails in a single batch operation. | `HUBSPOT_UPDATE_EMAILS` |
| Action | What it does | Slug |
| ----------------- | ------------ | --------------------------- |
| Create engagement | | `HUBSPOT_CREATE_ENGAGEMENT` |
| Get engagement | | `HUBSPOT_GET_ENGAGEMENT` |
| Action | What it does | Slug |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- |
| Create timeline event | Creates 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. | `HUBSPOT_CREATE_TIMELINE_EVENT` |
| Create timeline events batch | Creates multiple immutable timeline events in a batch, ideal for bulk data imports or real-time synchronizations, using a valid event template. | `HUBSPOT_CREATE_TIMELINE_EVENTS_BATCH` |
| Action | What it does | Slug |
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| Create and return a new property group | Creates a new, empty property group for a specified CRM object type in HubSpot, requiring a unique group name for that object type. | `HUBSPOT_CREATE_AND_RETURN_A_NEW_PROPERTY_GROUP` |
| Update property group | Partially updates a property group's displayOrder or label for a specified CRM objectType in HubSpot. | `HUBSPOT_UPDATE_PROPERTY_GROUP` |
| Action | What it does | Slug |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| Archive batch of line items | Archives a batch of existing line items by their unique IDs in HubSpot CRM. | `HUBSPOT_ARCHIVE_BATCH_OF_LINE_ITEMS` |
| Archive line item | Archives a specific HubSpot line item by its ID, moving it to a recoverable state. | `HUBSPOT_ARCHIVE_LINE_ITEM` |
| Create line item | Creates a new HubSpot line item. | `HUBSPOT_CREATE_LINE_ITEM` |
| Create line items | Creates multiple HubSpot line items in a single batch operation. | `HUBSPOT_CREATE_LINE_ITEMS` |
| Merge line items | Merges two line items, objectIdToMerge into primaryObjectId, which must be of the same type. | `HUBSPOT_MERGE_LINE_ITEMS` |
| Update line item | Partially updates specified properties of an existing HubSpot Line Item, identified by lineItemId (as HubSpot object ID or value of idProperty if used). | `HUBSPOT_UPDATE_LINE_ITEM` |
| Update line items | Updates 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. | `HUBSPOT_UPDATE_LINE_ITEMS` |
| Action | What it does | Slug |
| ------------ | ------------ | ---------------------- |
| Create list | | `HUBSPOT_CREATE_LIST` |
| Get CRM list | | `HUBSPOT_GET_CRM_LIST` |
| Action | What it does | Slug |
| --------------------- | ------------ | ------------------------------- |
| Create meeting | | `HUBSPOT_CREATE_MEETING` |
| List company meetings | | `HUBSPOT_LIST_COMPANY_MEETINGS` |
| List deal meetings | | `HUBSPOT_LIST_DEAL_MEETINGS` |
| Action | What it does | Slug |
| --------------------------- | ---------------------------------------------------------- | ------------------------------------- |
| Get record list memberships | | `HUBSPOT_GET_RECORD_LIST_MEMBERSHIPS` |
| Get segment members | Retrieve segment (list) members ordered by join timestamp. | `HUBSPOT_GET_SEGMENT_MEMBERS` |
| Action | What it does | Slug |
| ------------------ | ------------------------------- | ---------------------------- |
| Create note | Creates a new HubSpot CRM note. | `HUBSPOT_CREATE_NOTE` |
| List contact notes | | `HUBSPOT_LIST_CONTACT_NOTES` |
| Action | What it does | Slug |
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| Archive batch of objects | Archives a batch of existing, non-archived CRM objects of a specified objectType by their IDs, effectively hiding them from active use. | `HUBSPOT_ARCHIVE_BATCH_OF_OBJECTS` |
| Archive CRM object by ID | Archives a specific HubSpot CRM object by its type and ID, moving it to the recycling bin. | `HUBSPOT_ARCHIVE_CRM_OBJECT_BY_ID` |
| Create batch of objects | Creates 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. | `HUBSPOT_CREATE_BATCH_OF_OBJECTS` |
| Create CRM object from nl | Creates a new CRM object (contact, deal, company, ticket, or custom object) in HubSpot from a natural language description. | `HUBSPOT_CREATE_CRM_OBJECT_FROM_NL` |
| Create CRM object with properties | Creates 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). | `HUBSPOT_CREATE_CRM_OBJECT_WITH_PROPERTIES` |
| Create quote object | Creates a new quote object in HubSpot CRM with specified properties and associations. | `HUBSPOT_CREATE_QUOTE_OBJECT` |
| Merge objects | Merges two distinct HubSpot CRM objects of the same objectType, consolidating data into primaryObjectId (which is preserved) and deleting objectIdToMerge. | `HUBSPOT_MERGE_OBJECTS` |
| Partially update CRM object by ID | Partially 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. | `HUBSPOT_PARTIALLY_UPDATE_CRM_OBJECT_BY_ID` |
| Search CRM objects by criteria | Searches HubSpot CRM objects (e.g., 'contacts', 'companies') by objectType using complex criteria including filters, sorting, and pagination. | `HUBSPOT_SEARCH_CRM_OBJECTS_BY_CRITERIA` |
| Action | What it does | Slug |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------- |
| Retrieve owner by ID or user ID | Retrieves a specific HubSpot CRM owner by their ID, with options to specify ID type (owner or user) and to include archived records. | `HUBSPOT_RETRIEVE_OWNER_BY_ID_OR_USER_ID` |
| Retrieve owners | Retrieves a list of all owners in the HubSpot CRM, including their ID, first name, last name, email, and user ID. | `HUBSPOT_RETRIEVE_OWNERS` |
| Action | What it does | Slug |
| --------------- | ------------ | ------------------------- |
| List site pages | | `HUBSPOT_LIST_SITE_PAGES` |
| Action | What it does | Slug |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- |
| Create pipeline stage | Creates a new stage in a specified HubSpot CRM pipeline for a given object type, such as 'deals' or 'tickets'. | `HUBSPOT_CREATE_PIPELINE_STAGE` |
| Update pipeline stage | Partially updates a HubSpot CRM pipeline stage identified by objectType, pipelineId, and stageId, requiring metadata in the request. | `HUBSPOT_UPDATE_PIPELINE_STAGE` |
| Action | What it does | Slug |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- |
| Create pipeline | Creates 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. | `HUBSPOT_CREATE_PIPELINE` |
| Update pipeline | Partially updates a CRM pipeline's label, display order, or restores an archived pipeline by setting archived to false. | `HUBSPOT_UPDATE_PIPELINE` |
| Action | What it does | Slug |
| ------------- | ------------ | ----------------------- |
| Get blog post | | `HUBSPOT_GET_BLOG_POST` |
| Action | What it does | Slug |
| ---------------- | ------------------------------------------------------------------ | -------------------------- |
| Archive product | Archives a HubSpot product by its ID. | `HUBSPOT_ARCHIVE_PRODUCT` |
| Archive products | Archives multiple HubSpot products by their IDs. | `HUBSPOT_ARCHIVE_PRODUCTS` |
| Create product | Creates a new HubSpot product. | `HUBSPOT_CREATE_PRODUCT` |
| Create products | Creates multiple HubSpot products in a single batch operation. | `HUBSPOT_CREATE_PRODUCTS` |
| Get product | Retrieves a HubSpot product by its ID. | `HUBSPOT_GET_PRODUCT` |
| Get products | Retrieves multiple HubSpot products by their IDs. | `HUBSPOT_GET_PRODUCTS` |
| Merge products | Merges two HubSpot products into one. | `HUBSPOT_MERGE_PRODUCTS` |
| Search products | Searches for HubSpot products using flexible criteria and filters. | `HUBSPOT_SEARCH_PRODUCTS` |
| Update product | Updates properties for an existing HubSpot product. | `HUBSPOT_UPDATE_PRODUCT` |
| Update products | Updates multiple HubSpot products in a single batch operation. | `HUBSPOT_UPDATE_PRODUCTS` |
| Action | What it does | Slug |
| ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| Create batch of properties | Efficiently 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. | `HUBSPOT_CREATE_BATCH_OF_PROPERTIES` |
| Create property for specified object type | Creates a new custom property for a specified HubSpot CRM object type. | `HUBSPOT_CREATE_PROPERTY_FOR_SPECIFIED_OBJECT_TYPE` |
| Replace all properties of pipeline | Overwrites an entire CRM pipeline (specified by objectType and pipelineId) and all its stages with a new definition, returning the updated pipeline. | `HUBSPOT_REPLACE_ALL_PROPERTIES_OF_PIPELINE` |
| Replace pipeline stage properties | Replaces all properties of a specified pipeline stage. | `HUBSPOT_REPLACE_PIPELINE_STAGE_PROPERTIES` |
| Update batch of objects by idor property values | Performs a batch update on a valid objectType where properties are writeable and any idProperty used is designated unique. | `HUBSPOT_UPDATE_BATCH_OF_OBJECTS_BY_IDOR_PROPERTY_VALUES` |
| Update CRM property | Updates attributes of an existing HubSpot CRM property, identified by its objectType and propertyName. | `HUBSPOT_UPDATE_CRM_PROPERTY` |
| Action | What it does | Slug |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| Archive batch of quotes | Archives 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. | `HUBSPOT_ARCHIVE_BATCH_OF_QUOTES` |
| Archive quote | Archives a HubSpot Quote object by ID, moving it to the recycling bin where it can be restored within 90 days. | `HUBSPOT_ARCHIVE_QUOTE` |
| Batch update quotes | Updates multiple existing HubSpot quotes in a batch. | `HUBSPOT_BATCH_UPDATE_QUOTES` |
| Create batch of quotes | Creates multiple HubSpot CRM quotes in a batch, ideal for bulk operations. | `HUBSPOT_CREATE_BATCH_OF_QUOTES` |
| Merge quotes | Merges two distinct quotes of the same type by consolidating objectIdToMerge into primaryObjectId (e.g., for combining information or updating terms). | `HUBSPOT_MERGE_QUOTES` |
| Update quote | Performs 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). | `HUBSPOT_UPDATE_QUOTE` |
| Action | What it does | Slug |
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| Archive batch of feedback submissions | Asynchronously archives a batch of HubSpot feedback submissions using their unique IDs, which must correspond to valid and existing submissions. | `HUBSPOT_ARCHIVE_BATCH_OF_FEEDBACK_SUBMISSIONS` |
| Archive feedback submission | Archives an existing, non-archived Feedback Submission in HubSpot CRM by its ID, moving it to the recycling bin (not permanently deleting it). | `HUBSPOT_ARCHIVE_FEEDBACK_SUBMISSION` |
| Create batch of feedback submissions | Creates a batch of feedback submissions in HubSpot, ideal for bulk imports. | `HUBSPOT_CREATE_BATCH_OF_FEEDBACK_SUBMISSIONS` |
| Create feedback submission | Creates a new HubSpot feedback submission to record customer feedback (e.g., survey responses, support interactions), optionally associating it with CRM objects. | `HUBSPOT_CREATE_FEEDBACK_SUBMISSION` |
| Merge feedback submissions | Merges two existing feedback submissions by ID, primarily for consolidating duplicates or related feedback. | `HUBSPOT_MERGE_FEEDBACK_SUBMISSIONS` |
| Update batch feedback submissions | Updates a batch of HubSpot feedback submissions. | `HUBSPOT_UPDATE_BATCH_FEEDBACK_SUBMISSIONS` |
| Update feedback submission | Partially 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). | `HUBSPOT_UPDATE_FEEDBACK_SUBMISSION` |
| Action | What it does | Slug |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
| Create object schema | Creates 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). | `HUBSPOT_CREATE_OBJECT_SCHEMA` |
| Update object schema | Updates 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. | `HUBSPOT_UPDATE_OBJECT_SCHEMA` |
| Action | What it does | Slug |
| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| Configure calling extension settings | Configures 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. | `HUBSPOT_CONFIGURE_CALLING_EXTENSION_SETTINGS` |
| Set call recording settings | Configures the URL (urlToRetrieveAuthedRecording) that HubSpot uses to retrieve call recordings for a specified third-party calling app (appId). | `HUBSPOT_SET_CALL_RECORDING_SETTINGS` |
| Update calling app recording settings | Updates the recording settings, such as the URL for retrieving authenticated recordings, for a specific calling extension app identified by its appId. | `HUBSPOT_UPDATE_CALLING_APP_RECORDING_SETTINGS` |
| Update calling extension settings | Updates settings (e.g., display name, UI URL/dimensions, feature flags) for an existing calling extension app, identified by appId. | `HUBSPOT_UPDATE_CALLING_EXTENSION_SETTINGS` |
| Update video conference app settings | Updates webhook URLs (for creating/updating/deleting meetings, fetching accounts, verifying users) for a video conference application specified by appId. | `HUBSPOT_UPDATE_VIDEO_CONFERENCE_APP_SETTINGS` |
| Action | What it does | Slug |
| ------------------ | ------------------------------ | ---------------------------- |
| Create task | Creates a new CRM task record. | `HUBSPOT_CREATE_TASK` |
| List contact tasks | | `HUBSPOT_LIST_CONTACT_TASKS` |
| Action | What it does | Slug |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------- |
| Create event template for app | Creates 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. | `HUBSPOT_CREATE_EVENT_TEMPLATE_FOR_APP` |
| Update event template | Updates an existing HubSpot event template's name, display templates, and tokens. | `HUBSPOT_UPDATE_EVENT_TEMPLATE` |
| Action | What it does | Slug |
| ------------------------- | ------------ | ----------------------------------- |
| List conversation threads | | `HUBSPOT_LIST_CONVERSATION_THREADS` |
| Action | What it does | Slug |
| --------------- | ------------------------------------------------------------------------------------------- | ------------------------- |
| Archive ticket | Archives a HubSpot ticket by its ID. | `HUBSPOT_ARCHIVE_TICKET` |
| Archive tickets | Archives multiple HubSpot tickets by their IDs. | `HUBSPOT_ARCHIVE_TICKETS` |
| Create ticket | Creates a new HubSpot ticket. | `HUBSPOT_CREATE_TICKET` |
| Create tickets | Creates multiple HubSpot tickets in a batch, each with its own properties and associations. | `HUBSPOT_CREATE_TICKETS` |
| Get ticket | Retrieves a HubSpot ticket by its ID. | `HUBSPOT_GET_TICKET` |
| Get tickets | Retrieves multiple HubSpot tickets by their IDs. | `HUBSPOT_GET_TICKETS` |
| Merge tickets | Merges two HubSpot tickets into one. | `HUBSPOT_MERGE_TICKETS` |
| Update ticket | Updates properties for an existing HubSpot ticket. | `HUBSPOT_UPDATE_TICKET` |
| Update tickets | Updates multiple HubSpot tickets in a single batch operation. | `HUBSPOT_UPDATE_TICKETS` |
| Action | What it does | Slug |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------- |
| Add token to event template | Adds 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. | `HUBSPOT_ADD_TOKEN_TO_EVENT_TEMPLATE` |
| Update token on event template | Updates the label or options of an existing token within a specified HubSpot CRM event template. | `HUBSPOT_UPDATE_TOKEN_ON_EVENT_TEMPLATE` |
| Action | What it does | Slug |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| Create or update draft version | Creates or updates the draft version of a marketing email identified by emailId. | `HUBSPOT_CREATE_OR_UPDATE_DRAFT_VERSION` |
| Restore email revision | Restores a specific revision of a marketing email to a DRAFT state, overwriting any existing draft. | `HUBSPOT_RESTORE_EMAIL_REVISION` |
| Restore marketing email revision | Restores a specific, existing, non-active revision of a marketing email to become the new live version for that email. | `HUBSPOT_RESTORE_MARKETING_EMAIL_REVISION` |
| Action | What it does | Slug |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| Get workflow by ID | Retrieves comprehensive details for an existing HubSpot workflow by its unique ID. | `HUBSPOT_GET_WORKFLOW_BY_ID` |
| Get workflows | Retrieves a list of workflow summaries (ID, name, type, status) from HubSpot, using the 'limit' parameter for pagination. | `HUBSPOT_GET_WORKFLOWS` |
| Action | What it does | Slug |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| Cancel import | Cancels an active HubSpot data import job using its importId. | `HUBSPOT_CANCEL_IMPORT` |
| Create ab test variation | Creates a new A/B test variation for an existing HubSpot marketing email, using its contentId. | `HUBSPOT_CREATE_AB_TEST_VARIATION` |
| List sequences | | `HUBSPOT_LIST_SEQUENCES` |
| Start import | Start an asynchronous data import into HubSpot CRM using uploaded files and a detailed importRequest JSON configuration, ensuring this JSON correctly maps file columns to HubSpot properties and files align with these mappings. | `HUBSPOT_START_IMPORT` |
Agents can use 260 of the 260 HubSpot actions at this level: everything in **Read + write CRM**, plus:
* Delete associations
* Delete campaigns
* Delete schemas
* Delete settings
* Create and delete workflows
* Delete calls
* Delete contacts
* Delete deals
* Delete emails
* Archive groups
* Delete meetings
* Delete notes
The 30 actions that this level adds to **Read + write CRM**:
| Works on | Action | What it does | Slug |
| ------------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| **Associations** | Remove asset association | Disassociates an asset from a HubSpot marketing campaign. | `HUBSPOT_REMOVE_ASSET_ASSOCIATION` |
| | Remove association | Remove all associations between two CRM records using the v4 associations endpoint. | `HUBSPOT_REMOVE_ASSOCIATION` |
| | Remove association from schema | Permanently removes a specified association definition (type) from a HubSpot object's schema, preventing future creations of this association type without affecting existing instances. | `HUBSPOT_REMOVE_ASSOCIATION_FROM_SCHEMA` |
| **Calls** | Delete call | | `HUBSPOT_DELETE_CALL` |
| **Campaigns** | Delete campaign | Permanently deletes a marketing campaign from HubSpot using its campaignGuid. | `HUBSPOT_DELETE_CAMPAIGN` |
| | Delete campaigns batch | Archives a batch of up to 50 marketing campaigns, hiding them from active views rather than permanently deleting them. | `HUBSPOT_DELETE_CAMPAIGNS_BATCH` |
| **Companies** | Delete company gdpr | Permanently deletes a company (identified by objectId) and its associated data from HubSpot for GDPR compliance. | `HUBSPOT_DELETE_COMPANY_GDPR` |
| **Contacts** | Delete contact gdpr | Irreversibly erases a HubSpot contact and associated data per a GDPR request. | `HUBSPOT_DELETE_CONTACT_GDPR` |
| | Permanently delete contact via gdpr | Permanently deletes a HubSpot contact and all its associated data for GDPR compliance, identifying the contact by its ID or another unique property. | `HUBSPOT_PERMANENTLY_DELETE_CONTACT_VIA_GDPR` |
| **Deals** | Delete deal gdpr | Archives a HubSpot deal by its ID. | `HUBSPOT_DELETE_DEAL_GDPR` |
| | Remove deal | Removes a HubSpot deal by its ID. | `HUBSPOT_REMOVE_DEAL` |
| **Emails** | Delete marketing email | Permanently deletes a marketing email from your HubSpot account. | `HUBSPOT_DELETE_MARKETING_EMAIL` |
| | Get all marketing emails for a hub spot account | Fetches a list of marketing emails from a HubSpot account, with options for filtering, sorting, pagination, and including performance statistics. | `HUBSPOT_GET_ALL_MARKETING_EMAILS_FOR_A_HUB_SPOT_ACCOUNT` |
| **Groups** | Archive property group | Archives a HubSpot property group, making it inactive and hidden (not permanently deleted, allowing potential restoration) with immediate effect on its CRM visibility and usability. | `HUBSPOT_ARCHIVE_PROPERTY_GROUP` |
| **Line items** | Delete line items gdpr | Permanently deletes a specified line item and its associated content for GDPR compliance. | `HUBSPOT_DELETE_LINE_ITEMS_GDPR` |
| **Meetings** | Delete meeting | | `HUBSPOT_DELETE_MEETING` |
| **Notes** | Delete note | | `HUBSPOT_DELETE_NOTE` |
| **Pipeline stages** | Delete pipeline stage | Permanently deletes a specific pipeline stage for an objectType (e.g., 'deals', 'tickets') that supports pipelines. | `HUBSPOT_DELETE_PIPELINE_STAGE` |
| **Pipelines** | Delete pipeline | Permanently deletes a HubSpot pipeline and all its stages by pipelineId and objectType. | `HUBSPOT_DELETE_PIPELINE` |
| **Properties** | Archive batch of properties | Archives a batch of properties by their internal names for a specified HubSpot CRM object type. | `HUBSPOT_ARCHIVE_BATCH_OF_PROPERTIES` |
| | Archive property by object type and name | Archives a specified CRM property by its object type and name, moving it to the recycling bin. | `HUBSPOT_ARCHIVE_PROPERTY_BY_OBJECT_TYPE_AND_NAME` |
| **Schemas** | Delete schema | Deletes a HubSpot custom object schema by objectType. | `HUBSPOT_DELETE_SCHEMA` |
| | Purge schema | Permanently and irreversibly deletes the schema for an existing objectType in HubSpot CRM. | `HUBSPOT_PURGE_SCHEMA` |
| **Settings** | Delete calling extension settings | Permanently deletes the settings for a calling extension app, specified by its appId, rendering it unusable for all connected HubSpot accounts. | `HUBSPOT_DELETE_CALLING_EXTENSION_SETTINGS` |
| | Delete video conferencing app settings | Irreversibly deletes all settings for a video conferencing application identified by its appId in HubSpot, removing its configuration and preventing it from functioning until reconfigured. | `HUBSPOT_DELETE_VIDEO_CONFERENCING_APP_SETTINGS` |
| **Tasks** | Delete task | | `HUBSPOT_DELETE_TASK` |
| **Templates** | Delete timeline event template | Permanently and irreversibly deletes a specific timeline event template, identified by its eventTemplateId, from the application appId. | `HUBSPOT_DELETE_TIMELINE_EVENT_TEMPLATE` |
| **Tokens** | Remove token from event template | Removes a token from a HubSpot event template, preventing its inclusion in new events created from that template. | `HUBSPOT_REMOVE_TOKEN_FROM_EVENT_TEMPLATE` |
| **Workflows** | Create workflow | Creates a new HubSpot workflow to automate processes. | `HUBSPOT_CREATE_WORKFLOW` |
| | Delete workflow | Permanently deletes a HubSpot workflow by its ID. | `HUBSPOT_DELETE_WORKFLOW` |
## Connect HubSpot
Before you start:
* You need a HubSpot account that you can sign in to.
* Your Squad subscription must be active. Squad does not connect apps while the subscription is not active.
Open **Settings** > **Integrations**.
On the **Connected apps** tab, click **+ Add integration**.
Find **HubSpot** in the catalog and click it. You can type the name in **Search the catalog…**.
Under **Default scope**, choose an access level. This level applies to every agent.
Click **Connect HubSpot**. The HubSpot sign-in page opens in a new tab.
Sign in to HubSpot and approve the request.
Check that it works: HubSpot shows under **YOUR CONNECTIONS**, with a row for the account and its access level.
## Change the access level
1. Under **YOUR CONNECTIONS**, find the HubSpot account.
2. Open the account menu (⋯) and click **Manage scope**.
3. Under **Default scope**, choose the new level.
4. Click **Save access**.
The change does not need a new sign-in. Agents get the new level from their next call.
## Set access for one agent
Every agent uses the account's level unless you set something else for it. You can narrow one agent to a lower level, or block it.
1. Under **YOUR CONNECTIONS**, open the account menu (⋯) on the HubSpot account.
2. Click **Manage scope**.
3. Under **Per-agent access**, find the agent.
4. Choose the **Default** option to follow the account's level, choose a lower level, or choose **No access**.
5. Click **Save access**.
An agent never gets more than the account's level, even if you choose a higher level for it. Changes apply from the agent's next call. An agent with **No access** does not see the account.
## Use more than one HubSpot account
Click **+ Account** on the HubSpot card to connect another account. Agents use the primary account unless they are asked to use a specific one.
* After you click **+ Account**, follow the connect steps above.
* Each account has its own access level.
* The first account you connect becomes the primary account. It shows **★ PRIMARY**.
* To change the primary account, open the account menu (⋯) and click **Make primary**.
* To tell accounts apart, open the account menu (⋯) and click **Rename**.
## Reconnect or disconnect
Reconnect when the connection has expired, or when you need to change what the account can reach on the HubSpot side:
1. Open the account menu (⋯) and click **Reconnect**.
2. Click **Reauthorize on HubSpot**.
3. Sign in to HubSpot and approve the request.
Reconnect signs in to the same account again. It does not add a second connection.
Open the account menu (⋯) on the HubSpot account and click **Disconnect**. Agents lose access to that account at once.
**Disconnect** acts at once, with no confirmation step. If it was the primary account, another connected HubSpot account becomes primary.
## Costs
HubSpot actions do not use Squad credits. Connected apps never use credits. For what does use credits, see [What Squad costs](/docs/costs).
## Troubleshooting
An agent reports that an action is not allowed on this account.
* Cause: the action is outside the account's access level, or outside the level you set for that agent.
* Fix: choose a higher level in **Manage scope**, or change the agent's row under **Per-agent access**.
An agent says it has no access to HubSpot, or it does not see the account.
* Cause: the agent is set to **No access** under **Per-agent access**, or the account is not connected.
* Fix: open **Manage scope** and change the agent's row. If the account is missing, connect it again.
Connecting or saving fails with "Your subscription isn't active."
* Cause: your Squad subscription is not active.
* Fix: resubscribe. See [Manage your subscription](/docs/billing).
An agent says the HubSpot connection has expired.
* Cause: the sign-in for that account is no longer valid.
* Fix: use **Reconnect** on the account.
## Common questions
Each HubSpot account has an access level: **Read-only**, **Read + write CRM**, and **Full access**. Squad refuses any agent action outside that level. You can also narrow or block single agents under **Per-agent access**.
Click **+ Account** on the HubSpot card to connect another account. Agents use the primary account unless they are asked to use a specific one.
Open the account menu (⋯) on the HubSpot account and click **Disconnect**. Agents lose access to that account at once.
## Related pages
Use this when an action you need is not in this app.