> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # HubSpot > HubSpot is an inbound marketing, sales, and customer service platform integrating CRM, email automation, and analytics to facilitate lead nurturing and seamless customer experience HubSpot is an inbound marketing, sales, and customer service platform integrating CRM, email automation, and analytics to facilitate lead nurturing and seamless customer experiences `hubspot` · **245 tools** · **2 triggers** ## Connect it ```bash theme={"theme":"github-dark"} run auth hubspot run auth hubspot --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run hubspot # common commands run hubspot --all # every command ``` ```ts theme={"theme":"github-dark"} import { hubspot } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `create-contact-from-nl` | Creates a new contact in HubSpot from a natural language description. | | `create-crm-object-from-nl` | Creates a new CRM object (contact, deal, company, ticket, or custom object) in HubSpot from a natural language description. | | `create-deal-from-nl` | Creates a new deal in HubSpot from a natural language description. | | `create-meeting` | Creates a new meeting engagement in HubSpot CRM. Use this action when you need to log a meeting that occurred or schedule a future meeting with... | | `create-object-association` | Tool to create or label an association between two CRM records using HubSpot Associations v4 API. | | `create-product` | Creates a new HubSpot product. Note: Products are catalog items and cannot be directly associated with deals, contacts, or companies. | | `create-tickets` | Creates multiple HubSpot tickets in a batch, each with its own properties and associations; `inputs` list must not be empty, each item needs... | | `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. | | `list-company-activities` | List all activity/engagement associations from a company to a specified activity type (calls, emails, meetings, notes, or tasks). | | `list-company-meetings` | List all meetings associated with a specific company in HubSpot. | | `list-deal-activities` | Retrieves activities (notes, calls, emails, meetings, tasks) associated with a specific HubSpot deal. | | `read-associations-batch` | Tool to batch-read CRM associations (e.g., deals→contacts, deals→companies) for up to 1,000 source record IDs in one request. | | Tool | What it does | | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `add-asset-association` | Associates an existing asset ('FORM', 'OBJECT\_LIST', or 'EXTERNAL\_WEB\_URL') with a specified HubSpot marketing campaign. | | `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... | | `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... | | `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. | | `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. | | `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. | | `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... | | `archive-companies` | Archives multiple HubSpot companies by their IDs. | | `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. | | `archive-contact` | Archives a HubSpot contact by its ID. | | `archive-contacts` | Archives multiple HubSpot contacts by their IDs. | | `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... | | `archive-deals` | Archives multiple HubSpot deals by their IDs. | | `archive-email` | Archives the HubSpot email specified by `emailId` by moving it to the recycling bin, making it inaccessible unless restored. | | `archive-emails` | Archives multiple HubSpot emails by their IDs. | | `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). | | `archive-line-item` | Archives a specific HubSpot line item by its ID, moving it to a recoverable state. | | `archive-product` | Archives a HubSpot product by its ID. | | `archive-products` | Archives multiple HubSpot products by their IDs. | | `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. | | `archive-property-group` | Archives a HubSpot property group, making it inactive and hidden (not permanently deleted, allowing potential restoration) with immediate effect on... | | `archive-quote` | Archives a HubSpot Quote object by ID, moving it to the recycling bin where it can be restored within 90 days. | | `archive-ticket` | Archives a HubSpot ticket by its ID. | | `archive-tickets` | Archives multiple HubSpot tickets by their IDs. | | `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... | | `batch-read-companies-by-properties` | Batch-retrieves up to 100 HubSpot company records by their IDs in a single request. | | `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... | | `cancel-import` | Cancels an active HubSpot data import job using its `importId`; this action is irreversible, and any data already processed will remain. | | `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. | | `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... | | `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... | | `create-and-return-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. | | `create-new-marketing-email` | Creates a new marketing email in HubSpot, allowing comprehensive configuration of content, recipients, sender details, A/B testing, scheduling, web... | | `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... | | `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... | | `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... | | `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)... | | `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... | | `create-campaign` | Creates a new HubSpot campaign. | | `create-campaigns` | Creates multiple HubSpot campaigns by calling the single campaign creation endpoint for each campaign. | | `create-companies` | Creates multiple new HubSpot companies in a single batch operation. | | `create-company` | Creates a new HubSpot company. | | `create-contact` | Creates a new HubSpot contact. | | `create-contact-from-nl` | Creates a new contact in HubSpot from a natural language description. | | `create-contacts` | Creates multiple new HubSpot contacts in a single batch operation. | | `create-crm-object-from-nl` | Creates a new CRM object (contact, deal, company, ticket, or custom object) in HubSpot from a natural language description. | | `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`... | | `create-deal` | Creates a new HubSpot deal. | | `create-deal-from-nl` | Creates a new deal in HubSpot from a natural language description. | | `create-deals` | Creates multiple deals in HubSpot CRM; ensure any associated object IDs, deal stages, and pipeline IDs specified are valid and exist within the HubSpot account. | | `create-email` | Creates a new HubSpot email engagement record. REQUIRED FIELDS in properties dict: - hs\_email\_subject: Subject line - hs\_email\_html: HTML content -... | | `create-emails` | Creates multiple HubSpot emails in a single batch operation. | | `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... | | `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. | | `create-line-item` | Creates a new HubSpot line item. | | `create-line-items` | Creates multiple HubSpot line items in a single batch operation. | | `create-meeting` | Creates a new meeting engagement in HubSpot CRM. Use this action when you need to log a meeting that occurred or schedule a future meeting with... | | `create-note` | Creates a new HubSpot CRM note. Use when you need to add a timestamped note with optional attachments and associations to contacts, companies, deals, or tickets. | | `create-object-association` | Tool to create or label an association between two CRM records using HubSpot Associations v4 API. | | `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... | | `create-or-update-draft-version` | Creates or updates the draft version of a marketing email identified by `emailId`; if no draft exists, a new one is created from the current live... | | `create-pipeline` | Creates a new HubSpot pipeline for a specified CRM `objectType` (e.g., 'deals', 'tickets'), requiring the pipeline `label` be unique for that... | | `create-pipeline-stage` | Creates a new stage in a specified HubSpot CRM pipeline for a given object type, such as 'deals' or 'tickets'. | | `create-product` | Creates a new HubSpot product. Note: Products are catalog items and cannot be directly associated with deals, contacts, or companies. | | `create-products` | Creates multiple HubSpot products in a single batch operation. | | `create-property-for-specified-object-type` | Creates a new custom property for a specified HubSpot CRM object type; ensure `groupName` refers to an existing property group for the `objectType`. | | `create-quote-object` | Creates a new quote object in HubSpot CRM with specified properties and associations. | | `create-task` | Creates a new CRM task record. Use when adding a task with properties and optional associations. | | `create-ticket` | Creates a new HubSpot ticket. | | `create-tickets` | Creates multiple HubSpot tickets in a batch, each with its own properties and associations; `inputs` list must not be empty, each item needs... | | `create-timeline-event` | Creates an immutable custom timeline event on a CRM object's record using a specified, existing event template (identified by `eventTemplateId`)... | | `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; may... | | `create-workflow` | Creates a new HubSpot workflow to automate processes; ensure `enrollmentCriteria` and `actions` use properties relevant to the specified `objectTypeId`. | | `delete-call` | Permanently deletes a HubSpot call record by its ID. This action removes a call engagement from the CRM. | | `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... | | `delete-campaign` | Permanently deletes a marketing campaign from HubSpot using its `campaignGuid`; returns a 204 No Content status even if the campaign does not exist. | | `delete-campaigns-batch` | Archives a batch of up to 50 marketing campaigns, hiding them from active views rather than permanently deleting them. | | `delete-company-gdpr` | Permanently deletes a company (identified by objectId) and its associated data from HubSpot for GDPR compliance; this action is irreversible and... | | `delete-contact-gdpr` | Irreversibly erases a HubSpot contact and associated data per a GDPR request; if an email is given for a non-existent contact, it's blocklisted. | | `delete-deal-gdpr` | Archives a HubSpot deal by its ID. Note: HubSpot's GDPR permanent deletion API only supports contacts, not deals. | | `delete-line-items-gdpr` | Permanently deletes a specified line item and its associated content for GDPR compliance; this action is irreversible and cannot be undone. | | `delete-marketing-email` | Permanently deletes a marketing email from your HubSpot account. | | `delete-meeting` | Permanently deletes (archives) a HubSpot meeting by its ID, moving it to the recycling bin where it can be restored within 90 days. | | `delete-note` | Archives a HubSpot note by its ID, removing it from active view. | | `delete-pipeline` | Permanently deletes a HubSpot pipeline and all its stages by `pipelineId` and `objectType`; this is irreversible, so use validation flags to avoid... | | `delete-pipeline-stage` | Permanently deletes a specific pipeline stage for an `objectType` (e.g., 'deals', 'tickets') that supports pipelines; this operation is irreversible... | | `delete-schema` | Deletes a HubSpot custom object schema by `objectType`. With `archived=false` (default), it archives the schema (soft delete). | | `delete-task` | Archives a HubSpot task by its ID, removing it from active task lists. | | `delete-timeline-event-template` | Permanently and irreversibly deletes a specific timeline event template, identified by its `eventTemplateId`, from the application `appId`. | | `delete-video-conferencing-app-settings` | Irreversibly deletes all settings for a video conferencing application identified by its `appId` in HubSpot, removing its configuration and... | | `delete-workflow` | Permanently deletes a HubSpot workflow by its ID; deleted workflows cannot be restored via the API and the ID must exist. | | `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. | | `fetch-recording-settings` | Fetches call recording settings for a specified, existing HubSpot calling extension app. | | `fetch-revenue` | Fetches a revenue attribution report for a specified, existing marketing campaign, optionally using a specific attribution model and date range; if... | | `get-ab-email-variation` | Retrieves the alternate variation of a specified A/B marketing email; the `emailId` must identify an email currently in an A/B test. | | `get-account-info` | Gets current HubSpot account info (email, hubId, user details) using access-token lookup. | | `get-active-imports-list` | Retrieves a list of currently active import jobs in HubSpot for monitoring ongoing data operations. | | `get-aggregated-statistic-intervals` | Retrieves aggregated statistics for marketing emails (e.g., send counts), grouped by specified time intervals within a defined time range. | | `get-aggregated-statistics` | Retrieves aggregated statistics for marketing emails, optionally within an ISO8601 formatted time range, by email IDs, or specific email properties. | | `get-all-marketing-emails-for-account` | Fetches a list of marketing emails from a HubSpot account, with options for filtering, sorting, pagination, and including performance statistics. | | `get-campaign` | Retrieves a HubSpot campaign by its ID. | | `get-campaign-metrics` | Retrieves key attribution metrics for an existing marketing campaign, identified by its `campaignGuid`, within an optional date range. | | `get-campaigns` | Retrieves multiple HubSpot campaigns. | | `get-company` | Retrieves a HubSpot company by its ID. | | `get-contact-ids` | Fetches a list of contact IDs for a specific HubSpot campaign based on interaction type. | | `get-deal` | Retrieves a HubSpot deal by its ID. | | `get-deals` | Retrieves multiple HubSpot deals by their IDs in a single batch request. | | `get-emails` | Retrieves multiple HubSpot email engagement records by their IDs in a single batch request. | | `get-event-template` | Retrieves detailed information about a specific event template for a given application in HubSpot's CRM timeline. | | `get-import-record-information` | Retrieves a comprehensive summary of a specific HubSpot CRM import record by its `importId`, including status, progress, updates, results, and... | | `get-marketing-email-draft` | Retrieves the draft version of a marketing email by its `emailId`; if no draft exists, returns the published version. | | `get-marketing-email-revision` | Retrieves a specific, previously saved revision of a marketing email using its unique email ID and revision ID. | | `get-marketing-email-revisions` | Retrieves a paginated list of all historical versions (including full state like content, settings, metadata) for a specified, existing marketing... | | `get-pipeline-by-id` | Retrieves a specific pipeline by its ID and CRM object type, detailing its stages and properties. | | `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. | | `get-product` | Retrieves a HubSpot product by its ID. | | `get-products` | Retrieves multiple HubSpot products by their IDs. | | `get-quote` | Retrieves a specific HubSpot quote by its unique identifier. | | `get-segment-members` | Tool to retrieve segment (list) members ordered by join timestamp. | | `get-details-of-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. | | `get-ticket` | Retrieves a HubSpot ticket by its ID. | | `get-tickets` | Retrieves multiple HubSpot tickets by their IDs. | | `get-workflow-by-id` | Retrieves comprehensive details for an existing HubSpot workflow by its unique ID; unsupported actions are designated 'UNSUPPORTED\_ACTION' in the response. | | `get-workflows` | Retrieves a list of workflow summaries (ID, name, type, status) from HubSpot, using the 'limit' parameter for pagination. | | `list-assets` | Lists assets of a specific `assetType` for a given HubSpot marketing `campaignGuid`, optionally including performance metrics for a date range. | | `list-association-types` | Lists all valid association types between two specified HubSpot CRM object types. | | `list-companies` | Retrieves a paginated list of HubSpot companies. | | `list-company-activities` | List all activity/engagement associations from a company to a specified activity type (calls, emails, meetings, notes, or tasks). | | `list-company-calls` | Lists all calls associated with a specific HubSpot company. Returns call IDs and their association types with the company. | | `list-company-meetings` | List all meetings associated with a specific company in HubSpot. | | `list-contact-notes` | List all notes associated with a specific HubSpot contact. Returns note IDs and association metadata. | | `list-contact-properties` | Lists all contact properties in your HubSpot account, including custom properties you've created. | | `list-contacts` | Retrieves a paginated list of HubSpot contacts. | | `list-contact-tasks` | List all tasks associated with a specific contact. Returns task IDs and association metadata for tasks linked to the given contact. | | `list-deal-activities` | Retrieves activities (notes, calls, emails, meetings, tasks) associated with a specific HubSpot deal. | | `list-deal-meetings` | List all meetings associated with a specific deal in HubSpot. | | `list-deals` | Retrieves a paginated list of HubSpot deals. | | `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. | | `list-event-templates` | Retrieves all event templates associated with a valid `appId` for an existing application in HubSpot's CRM Timeline. | | `list-feedback-submissions` | Retrieves a paginated list of feedback submissions from HubSpot, allowing specification of properties (including history), associated object IDs, and... | | `list-granted-scopes` | Tool to introspect the current OAuth access token and return its granted scopes and metadata. | | `list-object-associations` | List all associations from a single CRM record to a specified target object type. | | `list-products` | Retrieves a paginated list of HubSpot products. | | `list-quotes` | Retrieves a paginated list of quotes, allowing selection of specific properties, property history, associated object IDs, and filtering by archived status. | | `list-tickets` | Retrieves a paginated list of HubSpot tickets. | | `merge-companies` | Merges two existing company records of the same type in HubSpot CRM, where `objectIdToMerge` is absorbed into `primaryObjectId`; this operation is irreversible. | | `merge-contacts` | Merges two HubSpot contacts into one. | | `merge-deals` | Merges two HubSpot deals into one. | | `merge-emails` | Merges two HubSpot emails into one. | | `merge-feedback-submissions` | Merges two existing feedback submissions by ID, primarily for consolidating duplicates or related feedback; this operation is irreversible, and... | | `merge-line-items` | Merges two line items, `objectIdToMerge` into `primaryObjectId`, which must be of the same type; `objectIdToMerge` is absorbed and the operation is irreversible. | | `merge-objects` | Merges two distinct HubSpot CRM objects of the same `objectType`, consolidating data into `primaryObjectId` (which is preserved) and deleting... | | `merge-products` | Merges two HubSpot products into one. | | `merge-quotes` | Merges two distinct quotes of the same type by consolidating `objectIdToMerge` into `primaryObjectId` (e.g., for combining information or updating... | | `merge-tickets` | Merges two HubSpot tickets into one. | | `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... | | `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. | | `publish-marketing-email` | Publishes or sends a specified HubSpot marketing email that is valid and ready for sending; requires Marketing Hub Enterprise or the transactional email add-on. | | `purge-schema` | Permanently and irreversibly deletes the schema for an existing `objectType` in HubSpot CRM; this deprecated endpoint should be used with extreme caution. | | `read-crm-property-by-name` | Reads a specific CRM property definition for a given HubSpot object type by its internal 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). | | `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). | | `read-associations-batch` | Tool to batch-read CRM associations (e.g., deals→contacts, deals→companies) for up to 1,000 source record IDs in one request. | | `read-batch-crm-object-properties` | Retrieves property definitions (metadata) for a batch of CRM object properties for a specified object type. | | `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. | | `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... | | `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`. | | `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... | | `read-budget` | Fetches detailed budget (total, spent, remaining) and spend information for a marketing campaign, including an 'order' field for sequencing... | | `read-contact` | Retrieves a HubSpot contact by its ID. | | `read-contacts` | Batch read multiple HubSpot contacts by their IDs or custom identifier property. | | `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... | | `read-email` | Call this to retrieve an existing HubSpot email by its `emailId` or an alternative unique `idProperty`. | | `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... | | `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. | | `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... | | `remove-asset-association` | Disassociates an asset from a HubSpot marketing campaign. Supports a wide range of asset types including forms, landing pages, emails, blog posts... | | `remove-association` | Tool to remove all associations between two CRM records using the v4 associations endpoint. | | `remove-association-from-schema` | Permanently removes a specified association definition (type) from a HubSpot object's schema, preventing future creations of this association type... | | `remove-deal` | Removes a HubSpot deal by its ID. | | `remove-token-from-event-template` | Removes a token from a HubSpot event template, preventing its inclusion in new events created from that template. | | `render-event-detail-template` | Renders detailed information for a specific HubSpot CRM timeline event using a predefined event template, ignoring `extraData` references in the... | | `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. | | `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. | | `replace-pipeline-stage-properties` | Replaces all properties of a specified pipeline stage; the new `label` must be unique within the pipeline, and if `objectType` is 'deals', the... | | `reset-draft` | Resets a marketing email's draft to its currently published (live) version, discarding all unpublished changes; the email must have a live version to revert to. | | `restore-email-revision` | Restores a specific revision of a marketing email to a DRAFT state, overwriting any existing draft. | | `restore-marketing-email-revision` | Restores a specific, existing, non-active revision of a marketing email to become the new live version for that email. | | `retrieve-all-object-schemas` | Retrieves all object schema definitions (not data records) for a HubSpot account, supporting retrieval of either active or archived schemas. | | `retrieve-all-pipelines-for-specified-object-type` | Retrieves all pipelines in HubSpot for a specified CRM object type, such as deals or tickets. | | `retrieve-calling-settings-for-app` | Retrieves the read-only calling extension settings for a specific HubSpot app; the app must exist and have calling extensions configured. | | `retrieve-line-item-by-id` | Retrieves a HubSpot CRM line item by its ID or a specified unique property (`idProperty`). | | `retrieve-line-items` | Fetches a paginated list of HubSpot CRM line items, allowing selection of specific properties (including history), associated object IDs, and... | | `retrieve-object-schema` | Fetches the detailed schema definition for a specified, existing standard or custom HubSpot CRM object type; this action is read-only and does not... | | `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. | | `retrieve-owners` | Retrieves a list of all owners in the HubSpot CRM, including their ID, first name, last name, email, and user ID. | | `retrieve-page-of-crm-owners` | Retrieves a paginated list of CRM owners from HubSpot, optionally filtering by email or archived status. | | `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... | | `retrieve-pipeline-stages` | Fetches all stages for a specified HubSpot CRM object type and pipeline ID. | | `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... | | `retrieve-video-conference-settings-by-id` | Retrieves video conference application settings, such as webhook URLs and user/account management configurations, for a specified `appId`. | | `search-campaigns` | Searches for HubSpot campaigns. | | `search-companies` | Searches for HubSpot companies using flexible criteria and filters. | | `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... | | `search-crm-objects-by-criteria` | Searches HubSpot CRM objects (e.g., 'contacts', 'companies') by `objectType` using complex criteria including filters, sorting, and pagination... | | `search-deals` | Searches for HubSpot deals using flexible criteria and filters. | | `search-emails` | Searches for HubSpot emails using flexible criteria and filters. | | `search-feedback-submissions` | Searches for feedback submissions in HubSpot CRM using text query, filter groups, sorting, and pagination, returning specified properties. | | `search-line-items-by-criteria` | Searches HubSpot line items using criteria including filters, sorting, and pagination; `after` must be a valid cursor from a previous response, and... | | `search-products` | Searches for HubSpot products using flexible criteria and filters. | | `search-quotes-by-criteria` | Searches HubSpot CRM quotes using a text query, complex filter criteria, sorting, and pagination. | | `search-tickets` | Searches for HubSpot tickets using flexible criteria and filters. | | `set-call-recording-settings` | Configures the URL (`urlToRetrieveAuthedRecording`) that HubSpot uses to retrieve call recordings for a specified third-party calling app (`appId`). | | `start-import` | Call this action to start an asynchronous data import into HubSpot CRM using uploaded files and a detailed `importRequest` JSON configuration... | | `update-marketing-email` | Updates properties of an existing marketing email identified by its `emailId`; unspecified fields retain their current values. | | `update-batch-feedback-submissions` | Updates a batch of HubSpot feedback submissions; property keys must be existing internal HubSpot names and values must be correctly formatted strings. | | `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; updates can be partial. | | `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`. | | `update-calling-extension-settings` | Updates settings (e.g., display name, UI URL/dimensions, feature flags) for an existing calling extension app, identified by `appId`. | | `update-campaign` | Partially updates specific, writable properties of an existing HubSpot marketing campaign identified by `campaignGuid`; an empty string value in... | | `update-campaigns` | Updates properties for up to 50 existing HubSpot marketing campaigns in a single batch operation. | | `update-companies` | Updates multiple HubSpot companies in a single batch operation. | | `update-company` | Updates properties for an existing HubSpot company. | | `update-contact` | Updates properties for an existing HubSpot contact. | | `update-contacts` | Updates multiple HubSpot contacts in a single batch operation. | | `update-crm-property` | Updates attributes of an existing HubSpot CRM property, identified by its `objectType` and `propertyName`; only provided fields are modified, and... | | `update-deal` | Updates properties for an existing HubSpot deal. | | `update-deals` | Updates multiple HubSpot deals in a single batch operation. | | `update-email` | Partially updates properties of an existing HubSpot email object, identified by `emailId` (as internal ID or custom unique property value if... | | `update-emails` | Updates multiple HubSpot emails in a single batch operation. | | `update-event-template` | Updates an existing HubSpot event template's name, display templates, and tokens; providing `tokens` replaces the entire existing list, and the `id`... | | `update-feedback-submission` | Partially updates writable properties of an existing HubSpot Feedback Submission, identified by its `feedbackSubmissionId` (which can be an internal... | | `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... | | `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... | | `update-object-schema` | Updates an existing custom object schema's metadata in HubSpot, such as its description, labels, display properties, required properties, searchable... | | `update-pipeline` | Partially updates a CRM pipeline's label, display order, or restores an archived pipeline by setting `archived` to `false`. | | `update-pipeline-stage` | Partially updates a HubSpot CRM pipeline stage identified by `objectType`, `pipelineId`, and `stageId`, requiring `metadata` in the request... | | `update-product` | Updates properties for an existing HubSpot product. | | `update-products` | Updates multiple HubSpot products in a single batch operation. | | `update-property-group` | Partially updates a property group's `displayOrder` or `label` for a specified CRM `objectType` in HubSpot. | | `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... | | `update-ticket` | Updates properties for an existing HubSpot ticket. | | `update-tickets` | Updates multiple HubSpot tickets in a single batch operation. | | `update-token-on-event-template` | Updates the label or options of an existing token within a specified HubSpot CRM event template; token name and data type remain unchanged. | | `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`. | ## Triggers (2) Subscribe with `.on(...)` in a script. A trigger with required configuration takes it as the second argument. | Trigger | Needs | What fires it | | ------------------------- | ----------------------------- | ------------------------- | | Contact Created Trigger | `app_id`, `developer_api_key` | Contact Created Trigger | | Deal Stage UpdatedTrigger | `app_id`, `developer_api_key` | Deal Stage UpdatedTrigger | [Open HubSpot in the console →](https://app.boxd.sh/integrations/detail/hubspot)