# Hubspot Your Toolhouse AI Worker can connect to Hubspot using 233 specialized tools. ## Auth Connection This service requires an auth connection to use its tools. You can set this up in your Toolhouse dashboard under [Auth Connections](https://toolhouse.app/auth-connections?authkit_slugs=hubspot). ## Tools (233) ### `Hubspot Add Asset Association` Integration name: **HUBSPOT\_ADD\_ASSET\_ASSOCIATION** Associates an existing asset (`FORM`, `OBJECT_LIST`, or `EXTERNAL_WEB_URL`) with a specified HubSpot marketing campaign. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------- | ------ | :------: | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `assetId` | string | ✅ | `"12345"` | The unique identifier of the asset to be associated with the campaign. This ID is specific to the assetType. For FORMs, use the form's numeric ID. For OBJECT\_LIST, use the list ID (ILS ID). For EMAIL, use the email's content ID. For LANDING\_PAGE or BLOG\_POST, use the page/post ID. These IDs can be obtained from HubSpot's UI (in the asset's URL or details panel) or by using the corresponding list/search actions for that asset type. | | `assetType` | string | ✅ | `"FORM"` | Type of asset to associate with the campaign. Commonly supported types include: `'FORM'`, `'OBJECT_LIST'` (Static/Contact List), `'EXTERNAL_WEB_URL'`, `'EMAIL'`, `'LANDING_PAGE'`, `'BLOG_POST'`, `'CTA'`, `'WORKFLOW'`, `'SOCIAL_POST'`, `'WEBSITE_PAGE'`, `'SEQUENCE'`, `'MEETING_EVENT'`, `'PLAYBOOK'`, `'FEEDBACK_SURVEY'`, `'SALES_DOCUMENT'`. HubSpot continues to expand asset type support over time. | | `campaignGuid` | string | ✅ | `"00000000-0000-0000-0000-000000000000"` | The unique identifier (UUID) of the HubSpot campaign to which the asset will be associated. | *** ### `Hubspot Add Token To Event Template` Integration name: **HUBSPOT\_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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------------- | ------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | ✅ | `"deal_stage_id"` | The internal name of the token, used for referencing it within templates. Must be unique for this event template. Allowed characters: alphanumeric, periods (`.`), dashes (`-`), or underscores (`_`). | | `type` | string | ✅ | `"string"` | The data type of the token. Determines how the token's value is stored and validated. | | `appId` | integer | ✅ | `12345` | Numeric identifier of the target application associated with the event template. Provided in the URL path. | | `label` | string | ✅ | `"Deal Stage"` | The user-facing label for the token. This label is used for list segmentation and in reporting. | | `options` | array | | `"[{\"label\": \"High Priority\", \"value\": \"high_priority\"}, {\"label\": \"Medium Priority\", \"value\": \"medium_priority\"}]"` | A list of options for the token, required and applicable only if the token `type` is `'enumeration'`. Each option must have a `'label'` and a `'value'`. | | `eventTemplateId` | string | ✅ | `"template_marketing_001"` | Unique identifier of the event template. Provided in the URL path. | | `objectPropertyName` | string | | `"last_feedback_score"` | The name of an existing CRM object property (e.g., `'dealstage'`, `'lifecyclestage'`). If provided, this token will populate the specified CRM object property associated with the event. This allows for building or updating CRM objects through the Timeline API. | *** ### `Hubspot Archive Batch Of Feedback Submissions` Integration name: **HUBSPOT\_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; the operation is queued, and submissions are moved from active views without being deleted. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | ----------------------------------------------------------------------------------------------- | | `inputs` | array | ✅ | — | A list of objects, where each object contains the `id` of a feedback submission to be archived. | *** ### `Hubspot Archive Batch Of Line Items` Integration name: **HUBSPOT\_ARCHIVE\_BATCH\_OF\_LINE\_ITEMS** Archives a batch of existing line items by their unique IDs in HubSpot CRM; this operation is irreversible via the API. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | ------------------------------------------------------------------------------------- | | `inputs` | array | ✅ | — | A list of objects, where each object contains the `id` of a line item to be archived. | *** ### `Hubspot Archive Batch Of Objects` Integration name: **HUBSPOT\_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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------ | :------: | ------------ | ---------------------------------------------------------------------------------------------- | | `inputs` | array | ✅ | — | A list of input objects, where each object contains the `id` of a CRM record to be archived. | | `objectType` | string | ✅ | `"contacts"` | The type of CRM object to archive (e.g., `'contacts'`, `'companies'`, `'deals'`, `'tickets'`). | *** ### `Hubspot Archive Batch Of Properties` Integration name: **HUBSPOT\_ARCHIVE\_BATCH\_OF\_PROPERTIES** Archives a batch of properties by their internal names for a specified HubSpot CRM object type; this operation is idempotent and safe to retry. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------ | :------: | ------------ | ------------------------------------------------------------------------- | | `inputs` | array | ✅ | — | A list of properties to archive, each specified by their internal `name`. | | `objectType` | string | ✅ | `"contacts"` | The HubSpot CRM object type for which properties are being archived. | *** ### `Hubspot Archive Batch Of Quotes` Integration name: **HUBSPOT\_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; note that archived quotes cannot be restored to active status. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | ------------------------------------------------------------------------------- | | `inputs` | array | ✅ | — | A list of objects, where each object contains the ID of a quote to be archived. | *** ### `Hubspot Archive Companies` Integration name: **HUBSPOT\_ARCHIVE\_COMPANIES** Archives multiple HubSpot companies by their IDs. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | -------------------------------------------------------------------------------- | | `inputs` | array | ✅ | — | A list of company objects, each specifying the ID of the company to be archived. | *** ### `Hubspot Archive Company` Integration name: **HUBSPOT\_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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------- | ------ | :------: | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `companyId` | string | ✅ | `"1234567890"` | The numeric identifier for the company to archive. Must contain only digits (e.g., `'1234567890'`). Do not use email addresses or other non-numeric identifiers. | *** ### `Hubspot Archive Contact` Integration name: **HUBSPOT\_ARCHIVE\_CONTACT** Archives a HubSpot contact by its ID. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------- | ------ | :------: | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `contactId` | string | ✅ | `"386009987808"` | Numeric HubSpot contact ID (e.g., `'386009987808'`). Note: The archive endpoint does NOT support email addresses or `idProperty` - use `HUBSPOT_GET_CONTACTS` or `HUBSPOT_SEARCH_CONTACTS` to find the numeric ID first. | *** ### `Hubspot Archive Contacts` Integration name: **HUBSPOT\_ARCHIVE\_CONTACTS** Archives multiple HubSpot contacts by their IDs. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | -------------------------------------------------------------------------------- | | `inputs` | array | ✅ | — | A list of contact objects, each specifying the ID of the contact to be archived. | *** ### `Hubspot Archive Crm Object By Id` Integration name: **HUBSPOT\_ARCHIVE\_CRM\_OBJECT\_BY\_ID** Archives 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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------ | :------: | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `objectId` | string | ✅ | `"1234567"` | The unique identifier for the CRM object to be archived. This ID must correspond to an existing object of the specified `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. | | `objectType` | string | ✅ | `"contacts"` | The type of CRM object to be archived. This value is case-sensitive, must be a valid HubSpot CRM object type (e.g., contacts, companies, deals, quotes), and should be provided in lowercase plural form (e.g., `'contacts'`, not `'Contact'`). | *** ### `Hubspot Archive Deals` Integration name: **HUBSPOT\_ARCHIVE\_DEALS** Archives multiple HubSpot deals by their IDs. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | ------------------------------------ | | `inputs` | array | ✅ | — | List of deal objects to be archived. | *** ### `Hubspot Archive Email` Integration name: **HUBSPOT\_ARCHIVE\_EMAIL** Archives the HubSpot email specified by `emailId` by moving it to the recycling bin, making it inaccessible unless restored. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `emailId` | string | ✅ | `"1234567890"` | Numeric object ID of the email engagement record in HubSpot. This is NOT an email address - it must be a numeric ID (e.g., `'1234567890'`). The ID can be retrieved from the HubSpot CRM email activity list or from previous API responses. | *** ### `Hubspot Archive Emails` Integration name: **HUBSPOT\_ARCHIVE\_EMAILS** Archives multiple HubSpot emails by their IDs. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | ------------------------------------- | | `inputs` | array | ✅ | — | List of email objects to be archived. | *** ### `Hubspot Archive Feedback Submission` Integration name: **HUBSPOT\_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). #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ---------------------- | ------ | :------: | ------------------------------------ | --------------------------------------------------------------------------------------- | | `feedbackSubmissionId` | string | ✅ | `"1234567890abcdef1234567890abcdef"` | The unique identifier of an existing Feedback Submission in HubSpot CRM to be archived. | *** ### `Hubspot Archive Line Item` Integration name: **HUBSPOT\_ARCHIVE\_LINE\_ITEM** Archives a specific HubSpot line item by its ID, moving it to a recoverable state. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------ | :------: | ---------------------------------------- | ------------------------------------------------------------------------------ | | `lineItemId` | string | ✅ | `"5fbde764-f5ce-46b0-8031-21c94fe0f40a"` | The unique identifier of the existing line item in HubSpot CRM to be archived. | *** ### `Hubspot Archive Product` Integration name: **HUBSPOT\_ARCHIVE\_PRODUCT** Archives a HubSpot product by its ID. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------- | ------ | :------: | --------- | --------------------------------------------------------- | | `productId` | string | ✅ | `"12345"` | Unique HubSpot identifier for the product to be archived. | *** ### `Hubspot Archive Products` Integration name: **HUBSPOT\_ARCHIVE\_PRODUCTS** Archives multiple HubSpot products by their IDs. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | --------------------------------------- | | `inputs` | array | ✅ | — | List of product objects to be archived. | *** ### `Hubspot Archive Property By Object Type And Name` Integration name: **HUBSPOT\_ARCHIVE\_PROPERTY\_BY\_OBJECT\_TYPE\_AND\_NAME** Archives 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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------- | ------ | :------: | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `objectType` | string | ✅ | `"contacts"` | The case-sensitive type of CRM object (e.g., `'contacts'`, `'companies'`) for which the property is being archived; must match an existing object type. | | `propertyName` | string | ✅ | `"my_custom_property_alpha"` | The case-sensitive internal name of the property to archive (e.g., `'custom_field_1'`, `'annual_revenue'`). | *** ### `Hubspot Archive Property Group` Integration name: **HUBSPOT\_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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------ | :------: | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `groupName` | string | ✅ | `"contact_information"` | The unique internal name of the property group you want to archive. This name is case-sensitive and must exactly match an existing property group's name within the specified `objectType`. | | `objectType` | string | ✅ | `"contacts"` | The specific CRM object type (e.g., `'contacts'`, `'companies'`, `'deals'`, or custom object types) that the property group belongs to. This value must be in lowercase and match an existing object type definition in your HubSpot account. | *** ### `Hubspot Archive Quote` Integration name: **HUBSPOT\_ARCHIVE\_QUOTE** Archives a HubSpot Quote object by ID, moving it to the recycling bin where it can be restored within 90 days. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ---------------------------------------- | ------------------------------------------------------------------------------------- | | `quoteId` | string | ✅ | `"550e8400-e29b-41d4-a716-446655440000"` | The unique identifier (ID) of an existing Quote object in HubSpot CRM to be archived. | *** ### `Hubspot Archive Ticket` Integration name: **HUBSPOT\_ARCHIVE\_TICKET** Archives a HubSpot ticket by its ID. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ---------- | ------ | :------: | --------- | -------------------------------------------------------- | | `ticketId` | string | ✅ | `"12345"` | Unique HubSpot identifier for the ticket to be archived. | *** ### `Hubspot Archive Tickets` Integration name: **HUBSPOT\_ARCHIVE\_TICKETS** Archives multiple HubSpot tickets by their IDs. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | -------------------------------------- | | `inputs` | array | ✅ | — | List of ticket objects to be archived. | *** ### `Hubspot Audit Pipeline Changes` Integration name: **HUBSPOT\_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'`). #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------ | :------: | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `objectType` | string | ✅ | `"deals"` | The HubSpot CRM object type that has pipelines (e.g., `'deals'`, `'tickets'`); determines the pipeline's context. Must be a valid, case-sensitive object type. | | `pipelineId` | string | ✅ | `"default_pipeline_123"` | The unique identifier of an existing pipeline within the specified `objectType` for which to retrieve the audit history. | *** ### `Hubspot Batch Read Companies By Properties` Integration name: **HUBSPOT\_BATCH\_READ\_COMPANIES\_BY\_PROPERTIES** Batch-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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------------- | ------- | :------: | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `inputs` | array | ✅ | — | List of company identifiers to retrieve. Each `id` within an input object corresponds to the value of the property specified in `idProperty`. | | `archived` | boolean | | `true` | If true, returns only archived company records; otherwise (default), returns active, non-archived companies. | | `idProperty` | string | | `"hs_object_id"` | Property name to use as the unique identifier for companies in `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. | | `properties` | array | | `["name","domain","industry"]` | Optional list of company property names to retrieve. If omitted, a default set of properties (name, domain, hs\_object\_id, createdate, hs\_lastmodifieddate, etc.) is returned. | | `propertiesWithHistory` | array | | `["name","domain"]` | Optional list of company property names for which to retrieve historical values. If not provided, no historical data is returned. | *** ### `Hubspot Batch Update Quotes` Integration name: **HUBSPOT\_BATCH\_UPDATE\_QUOTES** Updates 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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | ----------------------------------------------------------------------------------------------- | | `inputs` | array | ✅ | — | List of `InputsRequest` objects, each specifying a quote to update and its new property values. | *** ### `Hubspot Cancel Import` Integration name: **HUBSPOT\_CANCEL\_IMPORT** Cancels an active HubSpot data import job using its `importId`; this action is irreversible, and any data already processed will remain. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ---------- | ------- | :------: | ------- | -------------------------------------------------------------------------------------------------------------------------------- | | `importId` | integer | ✅ | `12345` | The unique identifier for the active HubSpot import job to be cancelled; must correspond to an import job currently in progress. | *** ### `Hubspot Clone Marketing Email` Integration name: **HUBSPOT\_CLONE\_MARKETING\_EMAIL** Duplicates an existing HubSpot marketing email, identified by its `id`, into a new draft; an optional `cloneName` can be assigned to this new email copy. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------- | ------ | :------: | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | ✅ | `"1234567890"` | The unique identifier of the existing marketing email to be cloned. | | `cloneName` | string | | `"New Q4 Promotional Email"` | The name for the newly cloned marketing email. If not provided, HubSpot may assign a default name (e.g., `'Copy of [Original Email Name]'`). | *** ### `Hubspot Configure Calling Extension Settings` Integration name: **HUBSPOT\_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`. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------------- | ------- | :------: | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `url` | string | ✅ | `"https://mycallingservice.com/ui"` | Publicly accessible HTTPS URL for the phone/calling UI, which should be built using the HubSpot Calling SDK. | | `name` | string | ✅ | `"My Awesome Caller"` | Display name for the calling service in the HubSpot interface. | | `appId` | integer | ✅ | `"123456"` | Unique identifier for the target HubSpot app whose calling extension settings are being configured. | | `width` | integer | ✅ | `"400"` | Target width in pixels for the iframe embedding the calling UI. | | `height` | integer | ✅ | `"600"` | Target height in pixels for the iframe embedding the calling UI. | | `isReady` | boolean | | `"true"` | If `true`, the calling service appears as an option under the `'Call'` action in contact records; `false` hides it. | | `supportsCustomObjects` | boolean | | `"true"` | Specifies if the service is compatible with HubSpot's engagement v2 service and custom objects. | *** ### `Hubspot Create Ab Test Variation` Integration name: **HUBSPOT\_CREATE\_AB\_TEST\_VARIATION** Creates 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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------------- | ------ | :------: | ----------------------------- | -------------------------------------------------------------------------------- | | `contentId` | string | ✅ | `"1234567890"` | The ID of the original email content to use as a template for the new variation. | | `variationName` | string | ✅ | `"Variation B - New Subject"` | A unique name for the new A/B test variation. | *** ### `Hubspot Create And Return A New Property Group` Integration name: **HUBSPOT\_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; properties must be added separately. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------- | ------- | :------: | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | ✅ | `"sales_info"` | The unique internal programmatic name for the property group within the specified `objectType`, used for API referencing. | | `label` | string | ✅ | `"Sales Information"` | Human-readable label for the property group, displayed in the HubSpot UI. | | `objectType` | string | ✅ | `"contacts"` | The CRM object type for which the property group will be created. | | `displayOrder` | integer | | `1` | Order in which the group appears in the HubSpot UI. Positive values are sorted ascendingly; `-1` places it after groups with positive `displayOrder`. If unspecified, the group is added at the end. | *** ### `Hubspot Create A New Marketing Email` Integration name: **HUBSPOT\_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; the internal `name` for the email is required. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ----------------------------------------- | ------- | :------: | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `name` | string | ✅ | `"July 2024 Newsletter - Internal"` | Internal name of the email, as displayed on the HubSpot email dashboard. | | `state` | string | | — | Current state of the email (e.g., `DRAFT`, `SCHEDULED`, `PUBLISHED`). | | `subject` | string | | `"Check out our new product update!"` | The subject line of the marketing email. | | `archived` | boolean | | — | True if the email is archived (typically hidden from main dashboard view). | | `campaign` | string | | `"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"` | ID (GUID) of the associated HubSpot campaign for tracking/reporting. | | `language` | string | | `"en-us"` | Primary language of the email content. | | `publishDate` | string | | `"2024-08-15T10:00:00Z"` | Scheduled ISO 8601 date-time for email publication or sending. | | `subcategory` | string | | `"product_launch"` | Email subcategory for internal organization or specific types (e.g., `'newsletter'`). | | `activeDomain` | string | | `"marketing.mycompany.com"` | Domain for sending the email; must be a connected and verified HubSpot sending domain. | | `rssData__url` | string | | `"http://myblog.com/feed"` | URL of the RSS feed for email content. Must be valid and accessible if using RSS features. | | `from__replyTo` | string | | `"noreply@example.com"` | Primary `'From'` and reply-to email address, unless `from__customReplyTo` is used. | | `sendOnPublish` | boolean | | — | True to send email immediately on publish; false to publish without sending until triggered/scheduled. | | `businessUnitId` | string | | `"78910"` | The ID of the business unit this email is associated with, if applicable. | | `from__fromName` | string | | `"The MyCompany Team"` | Sender name appearing in the `'From'` field of the received email. | | `rssData__timing` | object | | — | A dictionary specifying the timing and scheduling details for sending RSS emails. Each key must map to a dictionary/object value, not a simple string. Example: `{"dayOfWeek": {"value": "Tuesday"}, "time": {"hour": 9, "minute": 0}}`. | | `testing__testId` | string | | `"ab_test_123"` | The unique identifier for the A/B test associated with this email. | | `content__widgets` | object | | — | Dictionary of widgets (e.g., text, images, CTAs) and their configurations for email content. Each key must map to a dictionary/object value, not a simple string. Example: `{"widgetId": {"type": "text", "content": "Hello", "style": {...}}}`. | | `feedbackSurveyId` | string | | `"12345"` | The ID of the feedback survey linked to the email. | | `webversion__slug` | string | | `"july-newsletter-2024"` | Custom URL slug for the email's web version (e.g., `'july-newsletter'`). | | `testing__abStatus` | string | | — | Current A/B test status for this email (e.g., `master`, `variant`). | | `webversion__title` | string | | `"Our Latest Newsletter - Web Version"` | Browser tab title for the email's web version. | | `content__flexAreas` | object | | — | Dictionary defining content and layout of flexible, customizable areas in the email template. Each key must map to a dictionary/object value, not a simple string. Example: `{"areaName": {"content": {...}, "layout": {...}}}`. | | `webversion__domain` | string | | `"view.mycompany.com"` | Domain for the email's web version; defaults to HubSpot domain if unspecified. | | `from__customReplyTo` | string | | `"support@example.com"` | Custom reply-to email address, overrides main `'Reply To'` if set. | | `rssData__blogLayout` | string | | `"standard"` | Specifies the layout to be used for the blog RSS email. | | `rssData__maxEntries` | integer | | `"5"` | The maximum number of blog posts (RSS entries) to include in a single RSS email. | | `content__smartFields` | object | | — | Dictionary of smart fields for email personalization based on contact properties. Each key must map to a dictionary/object value, not a simple string. Example: `{"fieldName": {"value": "defaultValue", "conditions": {...}}}`. | | `testing__hoursToWait` | integer | | `"4"` | Hours to wait for A/B test results before sending the winning version to remaining recipients. | | `to__suppressGraymail` | boolean | | — | True to not send to contacts identified by HubSpot as `'graymail'` (low engagement). | | `content__templatePath` | string | | `"custom/page/my_email_template.html"` | Path to the email template in HubSpot Design Manager. | | `webversion__expiresAt` | string | | `"2025-01-01T00:00:00Z"` | ISO 8601 date-time when the web version expires and becomes inaccessible. | | `rssData__blogEmailType` | string | | `"daily"` | The type of blog email, which determines send frequency (e.g., instant, daily, weekly). | | `rssData__hubspotBlogId` | string | | `"987654321"` | The ID of the HubSpot blog to be used for the RSS email. | | `to__limitSendFrequency` | boolean | | — | True to apply HubSpot's send frequency limits, preventing over-mailing. | | `to__contactIds__exclude` | array | | `["201","202"]` | List of specific contact IDs to explicitly exclude, even if in included lists. | | `to__contactIds__include` | array | | `["101","102"]` | List of specific contact IDs to include as recipients. | | `testing__abSuccessMetric` | string | | — | Metric (e.g., `CLICKS_BY_OPENS`) to determine the A/B test winning version. | | `content__plainTextVersion` | string | | — | Plain text version of the email, for non-HTML clients or recipient preference. | | `content__widgetContainers` | object | | — | Dictionary of widget containers for grouping and managing widgets in the email template. | | `rssData__rssEntryTemplate` | string | | — | The HTML template for formatting each individual RSS entry within the email. | | `testing__abTestPercentage` | integer | | `"20"` | Percentage of recipients in the A/B test group (e.g., 20 for 20%). | | `to__contactLists__exclude` | array | | `["12345"]` | List of contact list IDs whose members to explicitly exclude. HubSpot contact list IDs are typically numeric strings (e.g., `'12345'`, `'67890'`). Provide the numeric ID as a string. | | `to__contactLists__include` | array | | `["12345","67890"]` | List of contact list IDs whose members to include as recipients. HubSpot contact list IDs are typically numeric strings (e.g., `'12345'`, `'67890'`). Provide the numeric ID as a string. | | `webversion__redirectToUrl` | string | | `"https://mycompany.com/email-expired"` | Custom URL for redirect if web version link is expired/deactivated. | | `rssData__blogImageMaxWidth` | integer | | `"600"` | The maximum width for images included from the blog feed in the RSS email. | | `testing__abSamplingDefault` | string | | — | Default email version (master/variant) if A/B test is inconclusive after the test period. | | `webversion__metaDescription` | string | | `"Catch up on our latest news and offers in this month's newsletter."` | Meta description for the web version, used by search engines. | | `content__themeSettingsValues` | object | | — | Dictionary of theme settings values to customize email appearance. Each key must map to a dictionary/object value, not a simple string. Example: `{"brandColor": {"value": "#0055CC"}, "fontFamily": {"name": "Arial"}}`. | | `testing__abSampleSizeDefault` | string | | — | Default email version (master/variant) if A/B test sample size is too small for significance. | | `webversion__redirectToPageId` | string | | `"1122334455"` | ID of a HubSpot page for redirect if web version link is expired/deactivated. | | `rssData__useHeadlineAsSubject` | boolean | | — | If true, the email subject will be automatically populated from the blog post headline for RSS emails. | | `subscriptionDetails__subscriptionId` | string | | `"sub_type_newsletter"` | ID of the specific subscription type (e.g., newsletter, product updates). | | `subscriptionDetails__officeLocationId` | string | | `"loc_boston_hq"` | ID of the office location for CAN-SPAM compliance and personalization. | | `subscriptionDetails__preferencesGroupId` | string | | `"pref_group_marketing"` | ID of the subscription preferences group for managing recipient preferences. | *** ### `Hubspot Create Association` Integration name: **HUBSPOT\_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; 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). #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------------ | ------ | :------: | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | string | | `"custom_contact_to_company_association"` | Optional, user-defined unique name for the new association type (e.g., `'contact_to_company_custom'`). If not supplied, HubSpot may generate a default. | | `objectType` | string | ✅ | `"2-123456"` | Fully qualified name or object type ID (e.g., `'2-12345'`) of the CUSTOM object schema for which the new association type is being defined. Must be a custom object, not a standard HubSpot object. | | `toObjectTypeId` | string | ✅ | `"companies"` | Object type ID or fully qualified name for the `'to'` side of the association. For standard objects use names (`'contacts'`, `'companies'`, `'deals'`, `'tickets'`) or IDs (`'0-1'`, `'0-2'`, `'0-3'`, `'0-5'`). For custom objects use their `objectTypeId` (e.g., `'2-12345'`). | | `fromObjectTypeId` | string | ✅ | `"contacts"` | Object type ID or fully qualified name for the `'from'` side of the association. For standard objects use names (`'contacts'`, `'companies'`, `'deals'`, `'tickets'`) or IDs (`'0-1'`, `'0-2'`, `'0-3'`, `'0-5'`). For custom objects use their `objectTypeId` (e.g., `'2-12345'`). | *** ### `Hubspot Create Batch Of Feedback Submissions` Integration name: **HUBSPOT\_CREATE\_BATCH\_OF\_FEEDBACK\_SUBMISSIONS** Creates a batch of feedback submissions in HubSpot, ideal for bulk imports; all property names, `associationTypeId`s, and association `to_id`s must reference existing entities in HubSpot. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `inputs` | array | ✅ | — | A list of feedback submission objects to create. Each object defines the properties and associations for a new feedback submission. | *** ### `Hubspot Create Batch Of Objects` Integration name: **HUBSPOT\_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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------ | :------: | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `inputs` | array | ✅ | — | A list of objects to be created in batch. Each item in the list defines the properties and associations for a new object. | | `objectType` | string | ✅ | `"contacts"` | The type of CRM object to create in batch (e.g., `'contacts'`, `'companies'`, `'deals'`, `'tickets'`, `'products'`, `'line_items'`, or a custom object ID). Must be a valid HubSpot CRM object type. | *** ### `Hubspot Create Batch Of Properties` Integration name: **HUBSPOT\_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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------ | :------: | ------------ | ------------------------------------------------------------------------------------------------------------------------- | | `inputs` | array | ✅ | — | List of definitions for the new properties to be created. | | `objectType` | string | ✅ | `"contacts"` | Target HubSpot CRM object type (e.g., `'contacts'`, `'companies'`, `'deals'`, or custom object ID) for property creation. | *** ### `Hubspot Create Batch Of Quotes` Integration name: **HUBSPOT\_CREATE\_BATCH\_OF\_QUOTES** Creates 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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | ----------------------------------------------------------------------------------------------------------------------- | | `inputs` | array | ✅ | — | A list of quote objects to be created. Each object in the list defines the properties and associations for a new quote. | *** ### `Hubspot Create Campaign` Integration name: **HUBSPOT\_CREATE\_CAMPAIGN** Creates a new HubSpot campaign. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------ | ------ | :------: | ------- | --------------------------------------------------------- | | `properties` | object | ✅ | — | Campaign properties including name and optional metadata. | *** ### `Hubspot Create Campaigns` Integration name: **HUBSPOT\_CREATE\_CAMPAIGNS** Creates 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. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | ----------------------------------- | | `inputs` | array | ✅ | — | List of campaign objects to create. | *** ### `Hubspot Create Companies` Integration name: **HUBSPOT\_CREATE\_COMPANIES** Creates multiple new HubSpot companies in a single batch operation. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | ------------------------------------------------------------------------------------------------ | | `inputs` | array | ✅ | — | A list of company objects to create. Each object represents one new company with its properties. | *** ### `Hubspot Create Company` Integration name: **HUBSPOT\_CREATE\_COMPANY** Creates a new HubSpot company. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------------- | ------ | :------: | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `zip` | string | | `"94105"` | Company's postal code. | | `city` | string | | `"San Francisco"` | City where the company is located. | | `name` | string | | `"Acme Corporation"` | Company name. | | `type` | string | | `"PROSPECT"` | Type of company. | | `phone` | string | | `"+1-555-123-4567"` | Company's primary phone number. | | `state` | string | | `"California"` | State or region where the company is located. | | `domain` | string | | `"example.com"` | Company's primary domain name. | | `address` | string | | `"123 Business St"` | Company street address. | | `country` | string | | `"United States"` | Country where the company is located. | | `website` | string | | `"https://www.example.com"` | Company's website URL. | | `about_us` | string | | `"We are a leading technology company."` | Company description or about us information. | | `address2` | string | | `"Suite 100"` | Additional address information (suite, floor, etc.). | | `industry` | string | | `"COMPUTER_SOFTWARE"` | The type of business the company performs. Must be one of HubSpot's predefined industry enum values in SCREAMING\_SNAKE\_CASE (e.g., COMPUTER\_SOFTWARE, FINANCIAL\_SERVICES, HOSPITAL\_HEALTH\_CARE, RETAIL, BIOTECHNOLOGY). See HubSpot's company properties documentation for the full list of \~120 valid values. | | `timezone` | string | | `"America/Los_Angeles"` | Company's timezone. | | `is_public` | string | | `"true"` | Whether the company is publicly traded. | | `description` | string | | `"Technology startup focused on AI solutions"` | Brief description of the company. | | `associations` | array | | — | List of associations to create with other existing HubSpot objects. | | `founded_year` | string | | `"2020"` | Year the company was founded. | | `annualrevenue` | string | | `"5000000"` | Company's annual revenue. | | `lifecyclestage` | string | | `"lead"` | Current lifecycle stage of the company. | | `custom_properties` | object | | — | Custom properties for the company. | | `numberofemployees` | string | | `"50"` | Number of employees in the company. | *** ### `Hubspot Create Contact` Integration name: **HUBSPOT\_CREATE\_CONTACT** Creates a new HubSpot contact. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ---------------------------------------------- | ------ | :------: | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `fax` | string | | `"+1-555-123-4568"` | The contact's fax number. | | `zip` | string | | `"02139"` | The contact's postal code or ZIP code. | | `city` | string | | `"Cambridge"` | The city where the contact resides. | | `email` | string | | `"testing@hubspot.com"` | The primary email address of the contact. This is a unique identifier for contacts in HubSpot. | | `phone` | string | | `"+1-555-123-4567"` | The contact's primary phone number (often a business phone). | | `photo` | string | | `"https://example.com/profiles/johndoe.jpg"` | URL of the contact's photo or avatar. | | `state` | string | | `"Massachusetts"` | The state or region where the contact resides. | | `degree` | string | | `"Master of Business Administration"` | The contact's highest completed educational degree. | | `gender` | string | | `"Male"` | The contact's gender. | | `school` | string | | `"Massachusetts Institute of Technology"` | The name of the school, college, or university the contact attended. | | `address` | string | | `"123 Main St, Apt 4B"` | The contact's street address, including apartment or unit number. | | `company` | string | | `"HubSpot"` | The name of the company the contact works for. If `associatedcompanyid` is set, this field might be auto-populated. | | `country` | string | | `"USA"` | The country where the contact resides. | | `ip_city` | string | | `"Cambridge"` | The city associated with the contact's IP address, often captured during their first website visit or form submission. | | `message` | string | | `"Interested in learning more about your enterprise solutions."` | A free-text message or note often captured from a form submission's message field. | | `website` | string | | `"https://www.example.com"` | The URL of the contact's personal or company website. | | `industry` | string | | `"Computer Software"` | The primary industry of the company the contact works for. | | `ip_state` | string | | `"Massachusetts"` | The state or region associated with the contact's IP address. | | `jobtitle` | string | | `"Marketing Manager"` | The contact's job title. | | `lastname` | string | | `"Doe"` | The contact's last name. | | `closedate` | string | | `"1609459200000"` | The date when the deal associated with this contact was closed. Expected format is a UTC timestamp in milliseconds. | | `firstname` | string | | `"John"` | The contact's first name. | | `ip_latlon` | string | | `"42.3611,-71.0571"` | The approximate latitude and longitude associated with the contact's IP address, typically in `'latitude,longitude'` format. | | `num_notes` | string | | `"15"` | The total number of notes logged on the contact's record. | | `ownername` | string | | `"Jane Salesrep"` | The full name of the HubSpot user who owns this contact. Read-only. | | `seniority` | string | | `"Director"` | The contact's seniority level within their organization. | | `createdate` | string | | `"2023-01-15T14:20:00Z"` | The date and time when the contact record was created in HubSpot. This is a read-only property, typically a UTC timestamp. | | `ip_country` | string | | `"United States"` | The country associated with the contact's IP address. | | `ip_zipcode` | string | | `"02139"` | The postal code or ZIP code associated with the contact's IP address. | | `owneremail` | string | | `"sales.rep@example.com"` | The email address of the HubSpot user who owns this contact. Read-only, reflects the owner's primary email. | | `salutation` | string | | `"Mr."` | The salutation for the contact (e.g., `'Mr.'`, `'Ms.'`, `'Dr.'`). | | `start_date` | string | | `"2020-06-01"` | The contact's start date, typically referring to their employment start date at their current company. Format can vary. | | `twitterbio` | string | | `"Tech enthusiast and avid blogger. #Innovation #Marketing"` | The contact's biography from their Twitter profile. | | `work_email` | string | | `"john.doe@company.com"` | The contact's work email address. This might be different from the primary `email` if that's a personal address. | | `linkedinbio` | string | | `"Experienced marketing professional with a passion for digital strategy."` | The contact's biography from their LinkedIn profile. | | `mobilephone` | string | | `"+1-555-987-6543"` | The contact's mobile phone number. | | `associations` | array | | — | List of associations to create with other existing HubSpot objects (e.g., companies, deals). | | `company_size` | string | | `"501-1000 employees"` | The size of the company the contact works for, often categorized (e.g., `'1-10 employees'`, `'501-1000 employees'`). | | `hubspotscore` | string | | `"75"` | The contact's HubSpot lead score, calculated based on criteria defined in your HubSpot portal's scoring settings. | | `job_function` | string | | `"Marketing"` | The contact's job function or department. | | `numemployees` | string | | `"750"` | The number of employees at the company the contact works for. This may differ from `'company_size'` if manually entered or from a different source. | | `annualrevenue` | string | | `"5000000"` | The annual revenue of the company the contact works for. | | `date_of_birth` | string | | `"1990-05-15"` | The contact's date of birth. Format can vary, but `YYYY-MM-DD` is common. | | `days_to_close` | string | | `"30"` | The number of days it took to close the deal associated with this contact. This is usually calculated automatically. | | `followercount` | string | | `"1500"` | The number of followers the contact has on a specified social media platform (e.g., Twitter). | | `ip_state_code` | string | | `"MA"` | The state or region code associated with the contact's IP address (e.g., US state code). | | `total_revenue` | string | | `"25000.00"` | The total revenue generated from all closed-won deals associated with this contact. | | `twitterhandle` | string | | `"johndoe_tweets"` | The contact's Twitter username (handle), without the `@` symbol. | | `field_of_study` | string | | `"Computer Science"` | The contact's primary field of study during their education. | | `hs_legal_basis` | string | | `"Freely given consent from contact"` | Legal basis for processing contact data under GDPR and privacy regulations. | | `lifecyclestage` | string | | `"lead"` | The contact's current stage in your sales and marketing funnel (e.g., `'Lead'`, `'Marketing Qualified Lead'`, `'Customer'`). These stages are customizable in HubSpot. | | `marital_status` | string | | `"Single"` | The contact's marital status. | | `graduation_date` | string | | `"2015-05-30"` | The contact's graduation date from their educational institution. Format can vary. | | `hs_all_team_ids` | string | | `"12345;67890;34567"` | A semicolon-separated list of all HubSpot Team IDs this contact is or has been associated with. | | `hubspot_team_id` | string | | `"12345"` | The ID of the HubSpot team that owns this contact. | | `ip_country_code` | string | | `"US"` | The two-letter country code (ISO 3166-1 alpha-2) associated with the contact's IP address. | | `military_status` | string | | `"Veteran"` | The contact's military status. | | `hs_all_owner_ids` | string | | `"5001;5002"` | A semicolon-separated list of all HubSpot Owner IDs who have been assigned to this contact at some point. | | `hubspot_owner_id` | string | | `"5001"` | The ID of the HubSpot user who is the current owner of this contact. | | `lastmodifieddate` | string | | `"2024-03-18T10:00:00Z"` | The date and time when the contact record was last modified. This is a read-only property, UTC timestamp. | | `custom_properties` | object | | — | A dictionary of custom properties to set for the contact. Keys are the internal names of your custom contact properties, and values are the data to set. Example: `{'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. | | `kloutscoregeneral` | string | | `"65"` | The contact's general Klout score, if available and integrated. Klout was a service that rated social media influence. | | `notes_last_updated` | string | | `"1615464000000"` | The date and time when the notes on the contact record were last updated. UTC timestamp in milliseconds. | | `recent_deal_amount` | string | | `"5000.00"` | The amount of the most recent closed-won deal associated with this contact. | | `associatedcompanyid` | string | | `"987654321"` | The ID of the primary company associated with this contact. This is a read-only property automatically updated when an association is made. | | `currentlyinworkflow` | string | | `"true"` | Indicates whether the contact is currently active in any HubSpot workflow. Boolean value, `'true'` or `'false'`. | | `hs_all_contact_vids` | string | | `"111222333;444555666"` | A semicolon-separated list of all HubSpot Contact VID (Visitor ID) values associated with this contact, typically used for merging contacts. | | `hs_analytics_source` | string | | `"Organic Search"` | The original source that generated the contact (e.g., `'Organic Search'`, `'Paid Social'`, `'Referrals'`). | | `linkedinconnections` | string | | `"500+"` | The number of LinkedIn connections the contact has. | | `num_contacted_notes` | string | | `"12"` | The number of notes on the contact record that relate to being contacted (e.g., call logs, meeting notes). | | `relationship_status` | string | | `"In a relationship"` | The contact's self-reported relationship status. | | `twitterprofilephoto` | string | | `"https://twitter.com/johndoe_tweets/profile_image"` | URL of the contact's Twitter profile photo. | | `hs_additional_emails` | string | | `"secondary@example.com;personal@example.org"` | A semicolon-separated list of additional email addresses for the contact. | | `hs_analytics_revenue` | string | | `"15000.00"` | Revenue attributed to this contact through HubSpot's analytics or e-commerce integrations. This is often a sum of closed-won deal amounts associated with the contact. | | `notes_last_contacted` | string | | `"1615377600000"` | The date and time the contact was last contacted, based on logged activities like calls, emails, or meetings. UTC timestamp in milliseconds. | | `num_associated_deals` | string | | `"3"` | The total number of deals currently associated with this contact. | | `first_conversion_date` | string | | `"2023-02-20T09:15:00Z"` | The date and time of the contact's first conversion (e.g., form submission). UTC timestamp. | | `hs_analytics_last_url` | string | | `"https://www.example.com/pricing"` | The last URL on your website that the contact visited. | | `num_conversion_events` | string | | `"8"` | The total number of conversion events (e.g., form submissions, CTA clicks) attributed to this contact. | | `hs_analytics_first_url` | string | | `"https://www.example.com/blog/my-first-post"` | The first URL on your website that the contact visited. | | `recent_conversion_date` | string | | `"2024-03-12T11:30:00Z"` | The date and time of the contact's most recent conversion event. UTC timestamp. | | `recent_deal_close_date` | string | | `"1614556800000"` | The close date of the most recent closed-won deal associated with this contact. UTC timestamp in milliseconds. | | `first_deal_created_date` | string | | `"2023-03-01T11:00:00Z"` | The date and time when the first deal was created for this contact. UTC timestamp. | | `hs_analytics_num_visits` | string | | `"7"` | The total number of sessions (visits) the contact has had on your website. | | `webinareventlastupdated` | string | | `"2023-11-01T00:00:00Z"` | Timestamp of the last update related to a webinar event (e.g., GoToWebinar) for this contact, if integrated. UTC timestamp. | | `notes_next_activity_date` | string | | `"1618444800000"` | The date and time of the next scheduled activity (e.g., task, meeting) with the contact. UTC timestamp in milliseconds. | | `hs_all_accessible_team_ids` | string | | `"12345;67890"` | A semicolon-separated list of HubSpot Team IDs that have access to this contact record. | | `hs_analytics_last_referrer` | string | | `"https://www.linkedin.com/"` | The last referring URL that brought the contact to your website before their most recent session. | | `hs_analytics_source_data_1` | string | | `"google"` | Additional detail for the source. For `'Organic search'`, this might be the search engine. For `'Paid social'`, this could be the social media platform. | | `hs_analytics_source_data_2` | string | | `"hubspot crm integration"` | Further detail for the source. For `'Organic search'`, this might be the keyword. For `'Paid social'`, this could be the campaign name. | | `hubspot_owner_assigneddate` | string | | `"1612137600000"` | The date and time when a HubSpot owner was most recently assigned to this contact. UTC timestamp in milliseconds. | | `first_conversion_event_name` | string | | `"Demo Request Form"` | The name or identifier of the event that marked the contact's first conversion. | | `hs_analytics_first_referrer` | string | | `"https://www.google.com/"` | The first referring URL that brought the contact to your website. | | `hs_analytics_last_timestamp` | string | | `"2024-03-15T16:45:00Z"` | Timestamp of the contact's last recorded interaction (e.g., last website visit, form submission). UTC timestamp. | | `hs_analytics_num_page_views` | string | | `"25"` | The total number of pages viewed by the contact on your website. | | `associatedcompanylastupdated` | string | | `"2023-10-26T10:30:00Z"` | The timestamp of the last update to the primary associated company. This is a read-only property. | | `hs_analytics_first_timestamp` | string | | `"2022-11-10T14:30:00Z"` | Timestamp of the contact's first recorded interaction (e.g., first website visit). UTC timestamp. | | `num_unique_conversion_events` | string | | `"4"` | The number of unique types of conversion events completed by the contact. | | `recent_conversion_event_name` | string | | `"Webinar Signup"` | The name or identifier of the contact's most recent conversion event. | | `surveymonkeyeventlastupdated` | string | | `"2023-09-15T00:00:00Z"` | Timestamp of the last update related to a SurveyMonkey event for this contact, if integrated. UTC timestamp. | | `engagements_last_meeting_booked` | string | | `"2024-03-10T10:00:00Z"` | Timestamp of the last meeting booked with the contact through HubSpot's meetings tool. | | `hs_analytics_average_page_views` | string | | `"3.5"` | The average number of pages viewed by the contact per session on your website, tracked by HubSpot analytics. | | `hs_all_assigned_business_unit_ids` | string | | `"101;202"` | A semicolon-separated list of Business Unit IDs assigned to this contact, if using HubSpot's Business Units feature. | | `hs_analytics_last_visit_timestamp` | string | | `"2024-03-15T16:45:00Z"` | Timestamp of the contact's most recent visit to your website. UTC timestamp. | | `hs_analytics_first_visit_timestamp` | string | | `"2022-11-10T14:30:00Z"` | Timestamp of the contact's first visit to your website. UTC timestamp. | | `hs_analytics_num_event_completions` | string | | `"5"` | The total number of HubSpot custom events completed by the contact. | | `engagements_last_meeting_booked_medium` | string | | `"Meetings Tool"` | The medium (e.g., `'Meetings Tool'`, `'Email'`) through which the last meeting was booked. | | `engagements_last_meeting_booked_source` | string | | `"SALES"` | The source (e.g., `'SALES'`, `'MARKETING'`) of the last meeting booked. | | `engagements_last_meeting_booked_campaign` | string | | `"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"` | The HubSpot campaign ID (GUID) associated with the last meeting booked. | | `hs_analytics_last_touch_converting_campaign` | string | | `"zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz"` | The HubSpot campaign ID (GUID) of the campaign that led to the contact's most recent conversion. | | `hs_analytics_first_touch_converting_campaign` | string | | `"yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"` | The HubSpot campaign ID (GUID) of the campaign that led to the contact's first conversion. | *** ### `Hubspot Create Contact From Nl` Integration name: **HUBSPOT\_CREATE\_CONTACT\_FROM\_NL** Creates a new contact in HubSpot from a natural language description. Fetches the contact property schema at runtime, uses an LLM to generate the correct property payload, and creates the contact. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------- | ------ | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `nl_query` | string | ✅ | — | Natural language description of the contact to create. Example: `'Add Jane Smith, email jane@test.com, phone +1-555-0100, company Acme Corp'`. | | `associations` | array | | — | Optional associations to create between the new contact and other CRM objects (e.g., companies, deals). Pass-through field, not LLM-generated. | *** ### `Hubspot Create Contacts` Integration name: **HUBSPOT\_CREATE\_CONTACTS** Creates multiple new HubSpot contacts in a single batch operation. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | -------------------------------------------------------------------------------------------------------------------------- | | `inputs` | array | ✅ | — | A list of contact objects to create. Each object represents one new contact with its properties and optional associations. | *** ### `Hubspot Create Crm Object From Nl` Integration name: **HUBSPOT\_CREATE\_CRM\_OBJECT\_FROM\_NL** Creates a new CRM object (contact, deal, company, ticket, or custom object) in HubSpot from a natural language description. Fetches the object's property schema at runtime, uses an LLM to generate the correct property payload, and creates the object. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------- | ------ | :------: | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `nl_query` | string | ✅ | — | Natural language description of the record to create. Example: `'Create a contact named John Doe with email john@example.com and phone +1-555-0100'`. | | `objectType` | string | ✅ | `"contacts"` | The type of CRM object to create. Standard types: `'contacts'`, `'deals'`, `'companies'`, `'tickets'`. Can also be a custom object type ID. | | `associations` | array | | — | Optional associations to create between the new object and other CRM objects. Pass-through field, not LLM-generated. Each association should include `'to'` and `'types'`. | *** ### `Hubspot Create Crm Object With Properties` Integration name: **HUBSPOT\_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). #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | -------------- | ------ | :------: | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `objectType` | string | ✅ | `"contacts"` | Type of CRM object to create (e.g., `'contacts'`, `'companies'`, `'deals'`, or custom object schema ID like `'p12345678'`). | | `properties` | object | ✅ | `"{\"email\": \"jane.doe@example.com\", \"firstname\": \"Jane\", \"lastname\": \"Doe\"}"` | Key-value pairs for the object's properties. Keys must be internal HubSpot property names valid for the `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. | | `associations` | array | ✅ | — | List of associations to create between the new object and existing CRM objects, using `to_id` and `types`. | *** ### `Hubspot Create Deal` Integration name: **HUBSPOT\_CREATE\_DEAL** Creates a new HubSpot deal. #### Parameters Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. | Parameter | Type | Required | Example | Description | | ------------------------------------------ | ------ | :------: | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `amount` | string | | `"1000.00"` | Total monetary value of the deal. | | `hs_acv` | string | | `"12000.00"` | Annual Contract Value (ACV) (HubSpot-calculated). | | `hs_arr` | string | | `"10000.00"` | Annual Recurring Revenue (ARR) (HubSpot-calculated). | | `hs_mrr` | string | | `"833.33"` | Monthly Recurring Revenue (MRR) (HubSpot-calculated). | | `hs_tcv` | string | | `"24000.00"` | Total Contract Value (TCV) (HubSpot-calculated). | | `dealname` | string | | `"New Website Project for Acme Corp"` | Descriptive name or title of the deal. | | `dealtype` | string | | `"newbusiness"` | Type of deal (e.g., `'newbusiness'`, `'existingbusiness'`). | | `pipeline` | string | | `"default"` | ID of the sales pipeline for this deal (required). | | `closedate` | string | | `"2023-12-31"` | Date (YYYY-MM-DD) or datetime (ISO 8601) when the deal closed or is expected to close. | | `dealstage` | string | | `"closedwon"` | Valid pipeline stage ID for the deal. IMPORTANT: Stage IDs must be actual values from your HubSpot pipeline configuration - random values, phone numbers, or placeholder text will be rejected by the API with `INVALID_OPTION` errors. Stage IDs can be either string-based (e.g., `'closedwon'`, `'closedlost'`) or numeric strings (e.g., `'2317386479'`) depending on your pipeline setup. You MUST retrieve valid stage IDs using the Pipelines API (`GET /crm/v3/pipelines/deals`) or from HubSpot Settings > Objects > Deals > Pipelines before setting this field. | | `createdate` | string | | `"2023-10-26T10:00:00Z"` | Date/time deal was created (read-only, HubSpot-set). | | `description` | string | | `"Initial discussion with client about their needs for a new CRM system."` | Detailed text description of the deal. | | `hs_campaign` | string | | `"a1b2c3d4-e5f6-7890-1234-567890abcdef"` | GUID of the HubSpot campaign that generated this deal. | | `hs_priority` | string | | `"high"` | Priority level (e.g., `'high'`, `'medium'`, `'low'`). | | `associations` | array | | — | Associations to create between the new deal and other CRM objects (e.g., contact, company). | | `hs_is_closed` | string | | `"true"` | Indicates if deal is closed (`'true'`/`'false'`; read-only, from deal stage properties). | | `hs_next_step` | string | | `"Send proposal by EOD Friday"` | Next planned step for this deal. | | `hs_object_id` | string | | `"1234567890"` | Unique ID of the deal object (read-only, HubSpot-assigned). | | `days_to_close` | string | | `"30"` | Days between creation and close (read-only, HubSpot-calculated). | | `hs_createdate` | string | | `"2023-10-26T10:00:00.000Z"` | Specific date/time deal record created (ISO 8601, read-only, HubSpot-set). | | `hs_all_team_ids` | string | | `"12345;67890"` | Semicolon-separated list of all associated team IDs (owner's primary, additional teams; typically read-only). | | `hs_all_owner_ids` | string | | `"101;202;303"` | Semicolon-separated list of all owner IDs (primary, co-owners). | | `hs_closed_amount` | string | | `"950.00"` | Actual amount when deal closed (HubSpot-calculated). | | `hubspot_owner_id` | string | | `"123456"` | ID of the HubSpot user owning the deal; may be auto-assigned if unspecified. | | `closed_won_reason` | string | | `"Strong product fit"` | Reason why the deal was won. | | `custom_properties` | object | | — | Custom properties for the deal. Keys are internal property names (as defined in your HubSpot account), values are the property values to set. CRITICAL: Enum/dropdown properties have STRICT validation - you MUST use exact values from your HubSpot configuration or the API will reject with `INVALID_OPTION` error. To find valid values: go to HubSpot Settings > Properties > Deals > \[Property Name] > Edit > Field Type Options. Requirements by type: (1) Enum/dropdown: case-sensitive exact match required (check your HubSpot property settings for valid options); (2) Number: numeric strings only, no units (e.g., `'12'` not `'12 months'`); (3) Date: ISO 8601 format (e.g., `'2024-01-15'`); (4) Checkbox: `'true'` or `'false'`. Properties are account-specific and may not exist in all HubSpot portals. Example: `{'project_type': 'migration', 'priority_level': 'high'}`. | | `closed_lost_reason` | string | | `"Price too high"` | Reason why the deal was lost. | | `deal_currency_code` | string | | `"USD"` | Currency code for deal amount. IMPORTANT: Only currency codes enabled in your HubSpot portal settings are valid. If omitted, defaults to your portal's home currency. To find valid currency codes: go to Settings > Account defaults > Currencies to see your enabled currencies. Common codes include `'USD'` and `'EUR'`, but availability depends on your portal configuration. | | `hs_forecast_amount` | string | | `"500.00"` | Forecasted amount (\`'Amount' \* 'hs\_deal\_stage\_probability'; HubSpot-calculated). | | `hs_analytics_source` | string | | `"Organic Search"` | Original deal source per HubSpot analytics (e.g., `'Organic Search'`; typically read-only). | | `hs_lastmodifieddate` | string | | `"2024-01-21T15:30:00.000Z"` | Date/time deal last modified (ISO 8601, read-only, HubSpot-updated). | | `hs_projected_amount` | string | | `"1100.00"` | Projected deal amount (manually set or calculated). | | `amount_in_home_currency` | string | | `"850.00"` | Deal's value in company's home currency (read-only, HubSpot-calculated). | | `hs_forecast_probability` | string | | `"0.6"` | Sales forecasting probability; may differ from `hs_deal_stage_probability`. | | `hs_deal_stage_probability` | string | | `"0.5"` | Win probability (decimal, e.g., `0.5`) based on current stage; typically stage-defined. | | `hs_all_accessible_team_ids` | string | | `"12345;67890"` | Semicolon-separated list of team IDs with access (typically read-only). | | `engagements_last_meeting_booked` | string | | `"2024-01-20T10:00:00Z"` | Date/time of last booked meeting for this deal (typically read-only). | | `hs_all_assigned_business_unit_ids` | string | | `"111;222"` | Semicolon-separated list of assigned business unit IDs (for Business Units add-on). | | `hs_closed_amount_in_home_currency` | string | | `"800.00"` | Closed amount in home currency (HubSpot-calculated). | | `hs_projected_amount_in_home_currency` | string | | `"935.00"` | Projected amount in home currency (HubSpot-calculated). | | `engagements_last_meeting_booked_medium` | string | | `"Meetings"` | Medium (e.g., `'Meetings'`) of last booked meeting (typically read-only). | | `engagements_last_meeting_booked_source` | string | | `"Calendar"` | Source (e.g., `'Calendar'`) of last booked meeting (typically read-only). | | `engagements_last_meeting_booked_campaign` | string | | `"7a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d"` | Campaign ID for the last booked meeting (typically read-only). | *** *The remaining HubSpot tool references continue in the same format, preserving each tool name, integration name, description, and parameter table exactly as provided.* --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.toolhouse.ai/toolhouse/integrations/hubspot.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.