Hubspot

Retrieves the recording settings for a specific calling extension app in the hubspot crm system. this endpoint allows developers to fetch the current configuration for call recording associated with a particular app integration. it’s useful for auditing, troubleshooting, or displaying the current recording settings to users. the endpoint should be used when you need to review or verify the recording configuration for a specific app, such as before making changes or when setting up a new integration. note that this endpoint only provides read access to the settings and does not allow modifications.

Action Parameters

Action Response

Resets the draft back to a copy of the live object.

Action Parameters

Action Response

List all the valid association types available between two object types

Action Parameters

Action Response

Deletes a specific marketing email from the hubspot system. this endpoint should be used when you need to permanently remove a marketing email from your hubspot account. it’s particularly useful for cleaning up outdated or unnecessary email content, or when you need to comply with data management policies. be cautious when using this endpoint, as the deletion is irreversible - once an email is deleted, it cannot be recovered. this endpoint only handles the deletion process and does not provide any information about the email being deleted or return the deleted content.

Action Parameters

Action Response

This endpoint allows you to search for company objects in the hubspot crm using custom criteria. it provides a powerful way to filter and retrieve company data based on specific properties or conditions. use this endpoint when you need to find companies matching certain criteria, such as industry, size, or custom properties. the search is performed using a post request with a json body containing the search parameters. the endpoint returns a paginated collection of matching company objects, making it efficient for handling large datasets.

Action Parameters

Action Response

This endpoint creates a duplicate of an existing marketing email in hubspot. it allows users to quickly replicate the content, design, and settings of a previously created email, saving time in the email creation process. the cloned email can be given a new name, making it easy to identify and manage multiple versions or variations of an email campaign. this tool is particularly useful when creating similar email campaigns or when testing different versions of an email while maintaining the original intact. note that while the email is cloned, it does not automatically send the new email or add it to any existing workflows or campaigns.

Action Parameters

Action Response

This endpoint retrieves a specific ticket from the hubspot crm system based on its id or a unique property value. it allows for customized responses by specifying which properties to include, fetching property history, and retrieving associated object ids. the endpoint is useful for getting detailed information about a single ticket, including its current state, historical changes, and related crm objects. it supports both active and archived tickets and can use custom id properties for ticket lookup.

Action Parameters

Action Response

Archives a specific line item in hubspot’s crm system by moving it to the recycling bin. this endpoint should be used when you need to remove a line item from active use without permanently deleting it. it’s particularly useful for data cleanup or when you want to hide outdated or irrelevant line items while retaining the ability to restore them later if needed. note that this action doesn’t permanently delete the line item, but rather moves it to a recoverable state in the recycling bin.

Action Parameters

Action Response

Retrieve emails sent by a workflow by id. returns information about email campaigns associated with the specified workflow.

Action Parameters

Action Response

Gets all marketing emails from a hubspot account. results can be filtered using various parameters.

Action Parameters

Action Response

Restores a previous revision of a marketing email. the current revision becomes old, and the restored revision is given a new version number.

Action Parameters

Action Response

Disassociate a specified asset from a campaign. important: currently, only the following asset types can be associated and disassociated via the api: forms, static lists, external website pages

Action Parameters

Action Response

Creates multiple email objects in hubspot’s crm system in a single api call. this endpoint is ideal for bulk email creation, allowing you to efficiently add numerous emails with custom properties and crm object associations. use this when you need to create multiple emails simultaneously, such as importing a batch of email records or setting up a series of automated emails. the endpoint provides flexibility in defining email properties and associations, enabling integration with various aspects of your hubspot crm data. note that this endpoint creates email objects in the crm, but does not send the emails; it’s primarily for record-keeping and crm management purposes.

Action Parameters

Action Response

Retrieves the configuration settings for a specific video conference application integrated with hubspot. this endpoint allows developers to access the current settings of their video conferencing extension, such as webhook urls and application-specific configurations. it’s particularly useful when you need to verify or audit the current setup of your video conferencing integration. the endpoint returns an externalsettings object containing the application’s configuration details. use this endpoint when you need to review or troubleshoot your video conferencing application settings within hubspot’s crm system.

Action Parameters

Action Response

Get a list of workflows for a hubspot portal. returns metadata for each workflow, useful for looking up workflows by id or displaying available workflows.

Action Parameters

Action Response

Creates a new contact in the hubspot crm system with the provided properties. this endpoint allows you to add a new contact to your hubspot database, populating it with the specified information. it’s ideal for scenarios where you need to programmatically create contacts, such as when integrating with other systems or automating lead capture processes. the endpoint returns a copy of the created contact object, including its unique id, which can be used for further operations or reference. note that while the endpoint offers flexibility in terms of properties you can set, it’s important to provide at least one property to create a meaningful contact entry.

Action Parameters

Action Response

Creates multiple timeline events in batch for hubspot’s crm based on an event template. this endpoint allows for efficient creation of multiple immutable events on object timelines, with the ability to update object properties if configured in the template. use this when you need to add multiple historical or real-time events to contact, company, or deal records in hubspot. it’s particularly useful for bulk imports or synchronizing events from external systems. note that once created, these events cannot be modified, so ensure accuracy before submission.

Action Parameters

Action Response

Creates a new product object in the hubspot crm system with the specified properties. this endpoint is used to add new products to your e-commerce catalog within hubspot. it allows you to define various attributes of the product such as name, price, description, and any custom properties configured in your hubspot account. upon successful creation, the endpoint returns a copy of the created product object, including its unique id assigned by hubspot. this tool is particularly useful for integrating external e-commerce systems with hubspot or for programmatically managing your product catalog. note that this endpoint creates basic product entries and may not support complex product configurations or variants.(DEPRECATED use create_product_object)

Action Parameters

Action Response

Creates multiple company records in hubspot’s crm system in a single api call. this endpoint is designed for efficiently adding a large number of companies to your hubspot account, which is particularly useful for bulk imports or when syncing data from another system. it allows for the creation of up to 100 companies per request, significantly reducing the number of api calls needed for large-scale operations. the endpoint returns detailed information about the success or failure of each company creation attempt, enabling easy tracking and error handling for batch operations.

Action Parameters

Action Response

Searches for contacts in the hubspot crm based on specified criteria. this endpoint allows for complex queries to filter and retrieve contact data, supporting various search parameters such as property filters, sorting options, and pagination. it’s ideal for finding specific contacts or groups of contacts that match certain conditions. the endpoint returns a collection of matching contacts along with total count and paging information, enabling efficient data retrieval and navigation through large result sets. use this when you need to perform advanced searches on your contact database or when integrating contact search functionality into your applications.

Action Parameters

Action Response

Archives a specific ticket in the hubspot crm system by moving it to the recycling bin. this endpoint should be used when you need to remove a ticket from active status, such as when a support issue has been resolved or is no longer relevant. the operation is permanent and cannot be undone through the api, so use it cautiously. this tool is ideal for cleaning up your ticket management system or implementing automated ticket archiving processes based on certain criteria.

Action Parameters

Action Response

Archives a batch of companies in the hubspot crm system using their unique ids. this endpoint allows for efficient bulk archiving of multiple companies simultaneously, which is particularly useful for data cleanup, removing outdated records, or managing large datasets. it should be used when you need to archive numerous companies at once, saving time compared to individual archiving operations. the endpoint does not delete the companies but moves them to an archived state, making them less prominent in the active crm view while still retaining the data. note that this operation cannot be undone through the api, so use it cautiously and ensure you have the correct company ids before proceeding.

Action Parameters

Action Response

Initiates a data import process in hubspot’s crm system. this endpoint allows you to upload one or more files containing data and start the import process to create or update crm objects such as contacts, companies, or deals. it converts rows in the uploaded files to objects in the crm based on the mapping specified in the import request. use this endpoint when you need to bulk import or update data in your hubspot crm. the import process is asynchronous, so this call starts the process but doesn’t wait for it to complete. you’ll need to use separate endpoints to check the status of the import job. be cautious when using this endpoint, as it can potentially create or modify large amounts of data in your crm.

Action Parameters

Action Response

This endpoint allows you to search for feedback submissions in hubspot’s crm using specified criteria. it’s designed for retrieving and filtering feedback data efficiently, supporting complex queries to find relevant submissions. the search functionality can be used to analyze customer feedback, track specific types of submissions, or gather data for reporting purposes. the endpoint returns a collection of matching feedback submissions along with pagination information for handling large result sets. note that this endpoint has a rate limit exemption, allowing for more frequent requests compared to standard endpoints.

Action Parameters

Action Response

This endpoint retrieves a paginated list of crm owners in hubspot. it allows you to fetch owner information with optional filtering by email address and archived status. the endpoint supports pagination for efficient data retrieval, making it ideal for applications that need to display or process owner data in manageable chunks. use this when you need to access owner information across your hubspot crm, such as for user management, reporting, or integration with other systems.(DEPRECATED use retrieve_page_of_crm_owners)

Action Parameters

Action Response

This endpoint allows you to retrieve multiple line items from hubspot’s crm in a single api call. it accepts a batch of line item identifiers or property values and returns the corresponding line item details. this is particularly useful for efficiently fetching data for multiple line items simultaneously, reducing the number of api calls needed. the endpoint can optionally filter results to include only archived items. it’s important to note that partial success is possible, where some line items may be successfully retrieved while others fail. error handling is provided for failed operations within the batch.

Action Parameters

Action Response

This endpoint allows you to archive multiple crm objects of a specified type in bulk. it’s designed for efficiently removing a large number of objects from active use in your hubspot crm. the archived objects are not deleted but are no longer accessible through standard crm operations. this is particularly useful for maintaining a clean and relevant database by archiving old or irrelevant records. use this endpoint when you need to archive many objects at once, such as during data cleanup operations or when removing outdated records. be cautious when using this endpoint, as archiving is a significant action that affects data accessibility and may impact related records or integrations.

Action Parameters

Action Response

Retrieves a paginated list of line items from the hubspot crm. this endpoint allows you to fetch detailed information about line items, which represent individual products or services within deals or orders. it offers flexible querying options, including customizable property selection, association retrieval, and filtering for archived items. use this endpoint when you need to access or analyze line item data in bulk, such as for reporting, data synchronization, or building custom integrations with hubspot’s crm. the endpoint supports pagination for handling large datasets efficiently.

Action Parameters

Action Response

Creates a new feedback submission in the hubspot crm system with the provided properties. this endpoint allows you to programmatically add customer feedback to your hubspot account, enabling better tracking and analysis of customer sentiments and experiences. use this when you need to submit feedback collected from various channels (e.g., surveys, support interactions, or product reviews) into hubspot. the endpoint returns a copy of the created feedback submission object, including its unique id, which can be used for future reference or updates. note that the specific properties available for feedback submissions may depend on your hubspot account configuration and custom properties.

Action Parameters

Action Response

Retrieves a specific quote from the hubspot crm by its unique identifier. this endpoint allows for detailed customization of the returned data, including specific properties, property history, and associated objects. it’s particularly useful when you need to fetch comprehensive information about a single quote, including its current state, historical changes, and relationships with other crm objects. use this endpoint when you need to access or display detailed quote information in your application, or when you need to verify the current state of a quote before taking further actions.

Action Parameters

Action Response

Get aggregated statistics in intervals for a specified time span. each interval contains aggregated statistics of the emails that were sent in that time.

Action Parameters

Action Response

Retrieves detailed information about a specific line item in hubspot’s crm using its unique identifier. this endpoint allows for flexible querying of line item data, including custom properties, historical values, and associated objects. it’s particularly useful for accessing up-to-date information about individual products or services within a deal, supporting various use cases such as order management, inventory tracking, or sales analysis. the endpoint offers granular control over the returned data, enabling efficient and tailored data retrieval based on specific business needs.(DEPRECATED use retrieve_line_item_by_id)

Action Parameters

Action Response

Updates an existing event template and its associated tokens in hubspot’s crm timeline. this endpoint allows you to modify the headertemplate and detailtemplate of an existing template, with changes taking effect for existing events. it also provides the ability to update or replace all tokens in the template in a single api call, streamlining the process of managing dynamic content. use this endpoint when you need to revise the structure or content of an existing event template, rather than creating a new one. it’s particularly useful for maintaining consistency across events while allowing for necessary updates to template designs or token configurations.

Action Parameters

Action Response

Retrieves a paginated list of products from the hubspot crm, allowing for customizable property selection and association retrieval. this endpoint is ideal for applications that need to display or process product information in batches, such as inventory management systems or e-commerce integrations. it supports filtering for archived products and can return the history of property values, making it useful for tracking changes over time. the endpoint’s paging mechanism enables efficient handling of large product catalogs, ensuring optimal performance for applications dealing with extensive product data.

Action Parameters

Action Response

This endpoint allows you to retrieve multiple tickets from hubspot’s crm system in a single api call. it’s designed for efficient bulk retrieval of ticket data, which is particularly useful for synchronization tasks, reporting, or updating local databases. the endpoint accepts a list of ticket identifiers (either ids or unique property values) and returns the corresponding ticket objects with their properties. it can handle both fully successful operations and partial successes, providing detailed error information for any tickets that couldn’t be retrieved. use this endpoint when you need to fetch data for multiple tickets simultaneously, reducing the number of api calls and improving performance for bulk operations.

Action Parameters

Action Response

Retrieves a paginated list of companies from the hubspot crm. this endpoint allows you to fetch company data with fine-grained control over the returned properties and associations. it’s ideal for scenarios where you need to list multiple companies, such as populating a company directory or performing bulk operations. the endpoint supports cursor-based pagination for efficiently handling large datasets and allows filtering for archived companies. use this when you need to fetch multiple company records at once, rather than retrieving a single company by id.

Action Parameters

Action Response

This endpoint retrieves detailed information about a specific crm property for a given object type in hubspot. it allows users to access custom fields and data associated with various crm objects such as deals, contacts, or companies. the endpoint is particularly useful when you need to verify the configuration, datatype, or other metadata of a specific property. it should be used when detailed property information is required, but not for bulk property retrieval or creating/updating properties.(DEPRECATED use read_a_crm_property_by_name)

Action Parameters

Action Response

Creates multiple contact records in hubspot’s crm system in a single api call. this endpoint is designed for efficient bulk creation of contacts, making it ideal for data imports, migrations, or synchronization between systems. it allows you to create up to 100 contacts simultaneously, significantly reducing the number of api calls required for large-scale contact creation. the endpoint returns detailed information about the success or failure of each contact creation attempt, enabling easy tracking and error handling for batch operations.(DEPRECATED use create_batch_of_contacts)

Action Parameters

Action Response

This endpoint allows you to update multiple product records in hubspot’s crm system in a single api call. it’s designed for bulk updates, improving efficiency when modifying numerous products simultaneously. use this endpoint when you need to update multiple products’ information, such as prices, descriptions, or any other product properties. the endpoint processes the updates in batch, returning either a successful operation result or detailed error information for any products that couldn’t be updated. keep in mind that there may be limitations on the number of products that can be updated in a single batch, so refer to hubspot’s documentation for specific constraints.

Action Parameters

Action Response

Searches for deals in the hubspot crm based on specified criteria. this endpoint allows for complex filtering, sorting, and property selection of deal objects. it’s ideal for finding deals that match specific conditions, such as those in a particular pipeline stage or with certain property values. the endpoint supports pagination for handling large result sets and can be used to power custom deal reports or dashboards. it should be used when you need to retrieve a subset of deals matching particular criteria rather than fetching all deals or a single deal by id.

Action Parameters

Action Response

Update a batch of deals.

Action Parameters

Action Response

Retrieves detailed information about a specific line item in hubspot’s crm using its unique identifier. this endpoint allows for flexible querying of line item data, including custom properties, historical values, and associated objects. it’s particularly useful for accessing up-to-date information about individual products or services within a deal, supporting various use cases such as order management, inventory tracking, or sales analysis. the endpoint offers granular control over the returned data, enabling efficient and tailored data retrieval based on specific business needs.

Action Parameters

Action Response

This endpoint allows for partial updates to a specific property group within hubspot’s crm. it enables you to modify existing property groups for various crm object types like contacts, companies, deals, or tickets. the endpoint is particularly useful when you need to make targeted changes to a property group without affecting its entire configuration. it accepts a json payload with the fields to be updated and returns the modified property group. this tool should be used when reorganizing or refining your crm’s data structure, but care should be taken as changes may affect how data is displayed and organized in the hubspot interface.

Action Parameters

Action Response

Merges two objects of the same type within the hubspot crm. this endpoint allows you to combine data from two separate objects into a single, unified object. use this when you need to consolidate duplicate records or combine information from multiple sources. the merge operation is permanent and cannot be undone, so ensure you have backups or are certain about the merge before proceeding. this tool is particularly useful for data cleansing and maintaining a single source of truth in your crm.

Action Parameters

Action Response

This endpoint allows for batch reading of contact records in the hubspot crm by their ids or specific properties. it’s designed for efficiently retrieving data for multiple contacts in a single api call, which is particularly useful when dealing with large datasets or when you need to update your local database with the latest contact information from hubspot. the endpoint supports filtering for archived contacts and allows you to specify which properties you want to retrieve for each contact, providing flexibility and optimizing data transfer. it’s important to note that this endpoint may return partial results if some contacts can’t be processed, so be prepared to handle both fully successful responses and responses with errors for individual contacts.

Action Parameters

Action Response

This endpoint retrieves a paginated list of contacts from the hubspot crm. it allows for flexible querying with options to specify the number of results per page, filter properties, include historical property values, and fetch associated object ids. the endpoint is ideal for tasks such as synchronizing contact data with external systems, generating reports, or displaying contact information in a user interface. it supports pagination for handling large datasets efficiently and provides fine-grained control over the data returned for each contact.(DEPRECATED use list_contacts_page)

Action Parameters

Action Response

Retrieves detailed information about a specific owner in the hubspot crm system. this endpoint allows you to fetch owner data using either their unique owner id or user id. it’s particularly useful when you need to access an owner’s profile, such as their name, email, or other associated details. the endpoint can retrieve both active and archived owners, making it versatile for various use cases including user management, audit trails, or data synchronization between systems. note that this endpoint focuses on individual owner retrieval and does not support bulk operations or modifications to owner data.(DEPRECATED use retrieve_owner_by_id_or_user_id)

Action Parameters

Action Response

This endpoint allows you to merge two company records of the same type in hubspot’s crm system. it combines the data from two separate company entries into a single, consolidated record. this operation is useful for eliminating duplicate company entries, consolidating information from multiple sources, or cleaning up your crm database. the merge process is irreversible, so it should be used with caution and only when you are certain that the two companies are indeed duplicates or need to be combined. after the merge, the primary company record will contain the consolidated information, while the secondary company record will be removed from the crm.

Action Parameters

Action Response

Get a campaign identified by a specific campaignguid with the given properties. along with the campaign information, it also returns information about assets. depending on the query parameters used, this can also be used to return information about the corresponding assets’ metrics. metrics are available only if startdate and enddate are provided.

Action Parameters

Action Response

Archives a batch of deals in the hubspot crm by their ids. this endpoint allows for bulk archiving of multiple deals simultaneously, which is useful for removing outdated or irrelevant deals from active view. it should be used when you need to archive numerous deals at once, improving crm organization and performance. note that archiving is a significant action that removes deals from standard views and reports, so use this endpoint cautiously and ensure you have backups or a way to unarchive if needed.

Action Parameters

Action Response

The batchreademails endpoint allows for efficient retrieval of multiple email objects and their properties from hubspot’s crm in a single api call. this endpoint is particularly useful when you need to fetch data for numerous emails simultaneously, reducing the number of individual api requests and improving performance. it provides flexibility in selecting which properties to retrieve, including the option to fetch historical data for specific properties. use this endpoint when you need to bulk retrieve email data, such as for reporting, data synchronization, or populating a custom interface with email information from hubspot. note that this endpoint is designed for reading data only and cannot be used for updating or creating email objects.

Action Parameters

Action Response

Updates an existing object schema in hubspot’s crm, allowing you to modify the structure and attributes of custom objects. this endpoint is essential for evolving your crm data model as your business needs change. use it to add, modify, or remove properties from your custom object schemas, ensuring that your crm data structure remains aligned with your organizational requirements. this operation is particularly useful when you need to accommodate new data points or refine existing ones within your custom objects.

Action Parameters

Action Response

This endpoint creates a new ticket object in the hubspot crm system. it allows you to programmatically generate support tickets with specified properties. use this endpoint when you need to create tickets automatically, such as from user submissions on your website or from internal systems. the endpoint accepts a json payload with ticket details and returns the created ticket object, including its newly assigned id. this is particularly useful for integrating external systems with hubspot’s customer service workflows. note that the specific fields available for ticket creation may depend on your hubspot account configuration.

Action Parameters

Action Response

Updates specific properties of a feedback submission object in hubspot’s crm system. this endpoint allows for partial updates, meaning only the properties provided in the request body will be modified. it’s useful for making targeted changes to feedback data without affecting the entire object. the endpoint can identify the feedback submission using either its internal id or a unique property value. use this when you need to update survey responses, modify feedback details, or adjust any custom properties associated with a feedback submission. note that read-only properties cannot be modified, and attempting to update non-existent properties will have no effect.

Action Parameters

Action Response

Retrieve detailed information about the budget and spend items for a specified campaign, including the total budget, total spend, and remaining budget. budget and spend items may be returned in any order, but the order field specifies their sequence based on the creation date. the item with order 0 is the oldest, and items with higher order values are newer

Action Parameters

Action Response

Retrieves detailed information about a specific property group for a given crm object type in hubspot. this endpoint allows developers to access the structure and attributes of property groups, which are collections of related properties within the crm system. use this tool when you need to understand the organization of properties for a particular object type or when working with custom property groups. it provides essential metadata about the group but does not return the actual property values for crm objects.

Action Parameters

Action Response

This endpoint allows you to update the recording settings for a specific calling app integrated with hubspot’s crm. it enables you to modify how call recordings are handled and stored for the specified app. use this endpoint when you need to change recording configurations, such as enabling/disabling recording, setting storage options, or updating compliance settings. this operation directly affects how calls are recorded and managed within the hubspot ecosystem for the given app, so use it cautiously and ensure you understand the implications of the changes.

Action Parameters

Action Response

Cancels an active import process in the hubspot crm system. this endpoint allows you to immediately stop an ongoing data import, which is useful for preventing unwanted data from being added to your crm or halting an import that was started by mistake. it should be used when you need to urgently stop a data import that is currently in progress. note that this action is irreversible, and any data that has already been imported will remain in the system. the endpoint returns an actionresponse indicating the success or failure of the cancellation request.

Action Parameters

Action Response

Creates a new custom object schema in hubspot’s crm, allowing you to define tailored data structures with custom properties and associations. this endpoint is essential for businesses that need to store and manage unique data types not covered by hubspot’s standard objects. use this when you need to extend your crm’s capabilities to handle industry-specific or company-specific data. the response includes the complete object schema, including the newly assigned object type id, all defined properties, and associations, providing immediate confirmation and details of the created schema.

Action Parameters

Action Response

Retrieves all pipelines for a specified object type in hubspot’s crm system. this endpoint allows users to fetch the complete set of pipelines associated with a particular crm object, such as deals or tickets. it’s essential for understanding the workflow stages and organization of different object types within a hubspot account. use this endpoint when you need a comprehensive view of how a specific object type is managed through various stages in the crm.

Action Parameters

Action Response

Archives a specific crm object in hubspot by moving it to the recycling bin. this endpoint allows you to remove an object from active use without permanently deleting it, providing a safety net for accidental deletions. it can be used for various crm object types such as contacts, companies, deals, or quotes. the operation is irreversible through the api, but the object can be restored from the recycling bin in the hubspot interface if needed.

Action Parameters

Action Response

This endpoint allows you to archive multiple contacts in the hubspot crm simultaneously by providing their ids. it’s particularly useful for bulk operations when you need to remove several contacts from active use in your crm. the endpoint accepts a json object containing an array of contact ids and performs the archive operation on all specified contacts. upon successful execution, the contacts will be marked as archived in the hubspot system, making them inactive and no longer visible in the main contact lists. this operation is irreversible through this api, so use it cautiously. if you need to restore archived contacts, you would need to use a separate unarchive endpoint or do it manually through the hubspot interface.

Action Parameters

Action Response

This endpoint permanently deletes a contact and all associated content to comply with gdpr regulations. it’s specifically designed for data erasure requests under gdpr. the endpoint allows for contact identification by email address using an optional ‘idproperty’ set to ‘email’. if the email is not found, it’s added to a blocklist to prevent future use. this action is irreversible and should be used with caution, only when a valid gdpr erasure request is received. it ensures complete removal of contact data, helping businesses maintain gdpr compliance.

Action Parameters

Action Response

This endpoint allows for partial updates to a contact in the hubspot crm using the contact’s internal object id. it enables you to modify specific properties of a contact without affecting other properties not included in the update. the endpoint accepts a json object with the properties to be updated and their new values. it’s particularly useful for updating individual fields of a contact record without having to send a complete contact object. note that read-only properties will be ignored, and you can clear property values by sending an empty string. this endpoint should be used when you need to make targeted updates to a contact’s information without overwriting the entire record.

Action Parameters

Action Response

Move an object identified by {emailid} to the recycling bin.

Action Parameters

Action Response

This endpoint deletes a specific timeline event template from hubspot’s crm system. it permanently removes the template and all associated events from search results and the timeline ui. use this endpoint when you need to completely remove an event template and its data from your hubspot application. this operation is irreversible, so it should be used with caution. before deletion, ensure that the template and its associated events are no longer needed, as they cannot be recovered after deletion. the endpoint requires both the event template id and the app id for precise identification and execution of the deletion process.

Action Parameters

Action Response

Permanently deletes a company record and all associated content from hubspot’s crm system to comply with gdpr regulations. this endpoint should be used when a company exercises their right to be forgotten under gdpr. it permanently removes all data related to the specified company, including associated contacts, deals, and other records. use with caution as this action is irreversible and will result in complete data loss for the specified company.

Action Parameters

Action Response

Partially updates a crm object in hubspot by its object type and id. this endpoint allows you to modify specific properties of various crm object types (such as contacts, deals, companies, or quotes) without affecting unspecified fields. it’s ideal for updating only necessary information, improving efficiency in data management. the endpoint supports using either the internal object id or a unique property value for object identification, offering flexibility in how you reference your crm data.

Action Parameters

Action Response

This endpoint retrieves a paginated list of crm objects of a specified type from hubspot, with customizable property and association data. it allows for efficient querying of large datasets by supporting pagination, property filtering, and inclusion of associated object information. the endpoint is versatile, supporting various object types and enabling the retrieval of both current and historical property values. it’s particularly useful for bulk data retrieval, data synchronization, and building comprehensive views of crm data including related entities.

Action Parameters

Action Response

This endpoint retrieves a paginated list of tickets from the hubspot crm, allowing for customized data retrieval and filtering. it’s designed for querying ticket data with flexible property selection, historical data retrieval, and association mapping. the endpoint supports pagination for handling large datasets efficiently and provides options for including archived tickets. use this when you need to fetch ticket data for reporting, analysis, or synchronization with other systems. it’s particularly useful for building custom dashboards, generating reports, or integrating hubspot ticket data with external customer support tools. note that the amount of data returned can be significant, especially when using the propertieswithhistory parameter, which may impact the maximum number of tickets retrievable in a single request.

Action Parameters

Action Response

This endpoint allows you to create multiple tickets in the hubspot crm simultaneously. it’s designed for bulk ticket creation, which is particularly useful for importing support requests from external systems or creating multiple related tickets efficiently. the endpoint accepts a batch of ticket data and processes them in a single api call, reducing the number of individual requests needed. use this when you need to create multiple support tickets at once, such as during data migration or when integrating with other customer support platforms. note that while this endpoint can handle multiple tickets, there may be limits on the number of tickets that can be created in a single batch, so check hubspot’s documentation for current limitations.

Action Parameters

Action Response

Perform a partial update of a campaign identified by the specified campaignguid. provided property values will be overwritten. read-only and non-existent properties will cause 400 error. if an empty string is passed for any property in the batch update, it will reset that property’s value.

Action Parameters

Action Response

Permanently delete a contact and all associated content to follow gdpr. use optional property ‘idproperty’ set to ‘email’ to identify contact by email address. if email address is not found, the email address will be added to a blocklist and prevent it from being used in the future.

Action Parameters

Action Response

Updates the configuration settings for a specific video conferencing application integrated with hubspot. this endpoint allows developers to modify various settings such as webhook urls, application credentials, or custom parameters that control how the video conferencing app interacts with hubspot’s crm. it’s used when changes to the application’s behavior or integration setup are needed, such as updating oauth tokens or changing notification preferences. the endpoint requires the application’s unique identifier and accepts a json payload with the new settings. it returns the updated settings object, allowing verification of the changes made.

Action Parameters

Action Response

This endpoint allows you to read a batch of products by their ids or properties from the hubspot crm. it’s particularly useful for retrieving information about multiple products simultaneously, improving efficiency when dealing with large datasets. the endpoint supports optional filtering for archived products and provides detailed responses, including potential errors for each product in the batch.

Action Parameters

Action Response

This endpoint allows you to create multiple crm properties in a single api call for a specified object type in hubspot. it’s particularly useful when setting up or updating your crm schema in bulk, saving time and reducing the number of api calls needed. the endpoint follows the same rules and constraints as creating individual properties, ensuring consistency in your crm structure. use this when you need to add several new fields to your crm objects efficiently, such as during initial setup or when expanding your data model. note that while this operation is atomic, it may result in partial success, so always check the response for any errors on specific properties.

Action Parameters

Action Response

This endpoint retrieves a paginated list of contacts from the hubspot crm. it allows for flexible querying with options to specify the number of results per page, filter properties, include historical property values, and fetch associated object ids. the endpoint is ideal for tasks such as synchronizing contact data with external systems, generating reports, or displaying contact information in a user interface. it supports pagination for handling large datasets efficiently and provides fine-grained control over the data returned for each contact.

Action Parameters

Action Response

This endpoint retrieves detailed information about a specific crm property for a given object type in hubspot. it allows users to access custom fields and data associated with various crm objects such as deals, contacts, or companies. the endpoint is particularly useful when you need to verify the configuration, datatype, or other metadata of a specific property. it should be used when detailed property information is required, but not for bulk property retrieval or creating/updating properties.

Action Parameters

Action Response

Purges (permanently deletes) a schema associated with a specific object type in hubspot’s crm. this endpoint should be used when you need to completely remove a custom schema definition for an object type, such as when cleaning up unused or outdated schemas. it’s important to note that this action is irreversible and may have significant implications on data integrity and related operations. use this endpoint with extreme caution, as it will permanently delete the schema and potentially affect any data or processes relying on it. this endpoint is deprecated, which means it may be removed in future versions of the api, and alternative methods should be considered for managing schemas.

Action Parameters

Action Response

Merges two deals of the same type in hubspot’s crm system. this endpoint allows you to combine information from two separate deal records into a single, consolidated deal. use this when you need to eliminate duplicate deals or combine related opportunities. the merge operation is permanent and can’t be undone, so ensure you have the correct deal ids before proceeding. after merging, one deal will be designated as the primary record, retaining the most up-to-date information from both deals.

Action Parameters

Action Response

Archives a company in the hubspot crm by moving it to the recycling bin. this endpoint should be used when you need to remove a company from active use without permanently deleting it. archiving a company may affect its visibility and associations within the crm. once archived, the company can be restored if needed, but it won’t appear in most standard company lists or searches. use this endpoint with caution, as it can impact reporting and user access to company data.

Action Parameters

Action Response

Creates a new custom property for a specified crm object type in hubspot. this endpoint allows you to extend the data model of your crm objects by adding new fields to store additional information. use this when you need to capture custom data that isn’t covered by hubspot’s default properties. the new property will be available for use immediately after creation, allowing you to store and retrieve custom data for the specified object type. this operation is essential for tailoring your crm to your specific business needs and workflows.

Action Parameters

Action Response

This endpoint allows for batch retrieval of multiple deals from hubspot’s crm by their ids or specific property values. it’s designed for efficient querying of deal data when you need to fetch information about multiple deals simultaneously. the endpoint can return both active and archived deals, depending on the ‘archived’ parameter. it’s particularly useful for synchronizing deal data with external systems, generating reports, or updating dashboards with current deal information. note that this endpoint requires appropriate authentication and is subject to hubspot’s api rate limits.

Action Parameters

Action Response

Deletes the settings for a specific video conferencing application integrated with hubspot. this endpoint should be used when you need to remove the configuration of a video conferencing app from your hubspot account, such as when discontinuing the use of a particular integration or preparing to set up a new configuration. it’s important to note that this action is irreversible and will remove all associated settings for the specified application id. this endpoint does not affect any scheduled meetings or historical data, but it will prevent the app from functioning within hubspot until reconfigured.

Action Parameters

Action Response

Retrieves all pipelines for a specified object type in hubspot’s crm system. this endpoint allows users to fetch the complete set of pipelines associated with a particular crm object, such as deals or tickets. it’s essential for understanding the workflow stages and organization of different object types within a hubspot account. use this endpoint when you need a comprehensive view of how a specific object type is managed through various stages in the crm.(DEPRECATED use retrieve_all_pipelines_for_specified_object_type)

Action Parameters

Action Response

This endpoint deletes a batch of campaigns. the maximum number of items in a batch request is 50. the response will always be 204 no content, regardless of whether the campaigns exist or not, whether they were successfully deleted or not, or if only some of the campaigns in the batch were deleted.

Action Parameters

Action Response

This endpoint permanently deletes a contact and all associated content to comply with gdpr regulations. it allows for the complete removal of a contact’s data from the hubspot crm, ensuring privacy and data protection compliance. the tool provides an option to identify contacts by email address and includes a blocklist feature to prevent future use of deleted email addresses. use this endpoint when a user requests the deletion of their personal data or when you need to remove contact information to maintain gdpr compliance.

Action Parameters

Action Response

This endpoint allows you to perform a partial update on a specific deal in hubspot’s crm system. it’s useful when you need to modify only certain properties of a deal without affecting the entire object. the endpoint accepts the deal’s unique identifier and a set of properties to update, making it efficient for targeted changes. it’s particularly valuable for integrations that need to sync specific deal information from external systems or update deal progress without overwriting unrelated data.

Action Parameters

Action Response

This endpoint allows you to merge two contact records of the same type in hubspot’s crm system. it combines the information from two separate contact entries into a single, consolidated record. this is useful for eliminating duplicate contacts and maintaining a clean, accurate database. the merge operation is irreversible, so it should be used with caution. the endpoint requires specifying which contact should be considered the primary record, and the resulting merged contact will retain this primary contact’s id.

Action Parameters

Action Response

This endpoint allows users to search for and return a page of campaigns based on various query parameters. users can filter by name, sort, and paginate through the campaigns, as well as control which properties are returned in the response.

Action Parameters

Action Response

This endpoint allows for partial updates to a company object in hubspot’s crm. it enables you to modify specific properties of a company without affecting other properties. the endpoint is particularly useful when you need to update one or more fields of a company record without having to provide all the company data. it supports identifying the company by its internal id or any unique property, and allows clearing of property values by passing empty strings. read-only and non-existent properties in the request will be ignored, ensuring safe updates.

Action Parameters

Action Response

Associate a specified asset with a campaign. important: currently, only the following asset types can be associated and disassociated via the api: forms, static lists, external website pages

Action Parameters

Action Response

The searchemails endpoint allows you to search for and retrieve emails within the hubspot crm using various filtering and sorting options. this powerful tool enables you to find specific emails based on content, properties, and metadata. use it when you need to locate emails matching certain criteria, analyze email trends, or gather data for reporting purposes. the endpoint supports pagination for handling large result sets and allows you to specify which email properties to include in the response. it’s particularly useful for integrations that need to sync email data or for building custom email analytics solutions. note that this endpoint focuses on searching and retrieving email data; it does not provide functionality for sending or modifying emails.

Action Parameters

Action Response

This endpoint retrieves key attribution metrics for a specified campaign, such as sessions, new contacts, and influenced contacts.

Action Parameters

Action Response

This endpoint allows for partial updates to a product in hubspot’s crm system. it’s designed to modify existing product information by overwriting specified property values while preserving unmentioned properties. the endpoint is particularly useful for e-commerce integrations, enabling seamless product data management. it supports both internal object ids and custom unique properties for product identification, offering flexibility in how products are referenced and updated.

Action Parameters

Action Response

Merges two quotes of the same type in hubspot’s crm system. this endpoint allows you to consolidate multiple quotes into a single quote, streamlining the sales process and simplifying quote management. use this when you need to combine information from two separate quotes, such as when updating a customer’s quote with new line items or terms. the operation is irreversible, so it should be used with caution. the merged quote will contain combined information from both source quotes, with the primary quote’s properties taking precedence in case of conflicts.

Action Parameters

Action Response

Use this endpoint to create a new marketing email.

Action Parameters

Action Response

Create a campaign with the given properties and return the campaign object, including the campaignguid and created properties.

Action Parameters

Action Response

Retrieves a paginated list of active imports for the hubspot account. this endpoint allows users to monitor ongoing import processes, track their status, and manage bulk data operations efficiently. it’s particularly useful for checking the progress of large-scale data imports, identifying any issues, and ensuring data integrity during the import process. the endpoint returns a collection of import responses, providing detailed information about each active import job.

Action Parameters

Action Response

The mergecrmemails endpoint allows you to combine two email objects in the hubspot crm into a single record. this operation is useful for de-duplicating email records, consolidating information, and maintaining a clean crm database. when called, the endpoint will merge the specified secondary email object into the primary email object, retaining the primary object’s id and updating it with any non-conflicting information from the secondary object. the secondary object will be deleted after the merge. this endpoint should be used cautiously, as the merge operation is irreversible. it’s recommended to back up your data before performing merge operations, especially when dealing with large numbers of records or critical customer information.

Action Parameters

Action Response

Configures call recording settings for a specific app within hubspot’s crm system. this endpoint allows you to set up or modify how calls are recorded, which is crucial for compliance, quality assurance, and customer service improvement. use this when you need to enable, disable, or adjust call recording features for a particular app integration. the settings applied here will affect how calls are handled and stored within the hubspot crm for the specified app.

Action Parameters

Action Response

This endpoint lets you obtain the variation of an a/b marketing email. if the email is variation a (master) it will return variation b (variant) and vice versa.

Action Parameters

Action Response

This endpoint allows you to search for line items in hubspot’s crm based on specific criteria. it’s particularly useful for retrieving detailed information about individual items within larger transactions or orders. you can use this endpoint to filter, sort, and paginate through line items, enabling efficient data analysis and reporting. the search is performed using a post request with a json body containing your search criteria, allowing for complex queries. the response includes a collection of matching line items along with pagination information for handling large result sets. this endpoint is ideal for scenarios where you need to analyze sales data, track specific products or services, or integrate line item information with other systems.

Action Parameters

Action Response

This endpoint allows you to archive multiple feedback submissions in bulk within your hubspot crm. it’s designed for efficient management of large volumes of feedback data, enabling you to move older or processed submissions out of active view. the operation is performed asynchronously, meaning it will be queued for processing after the request is received. use this endpoint when you need to clean up your active feedback submissions or organize your data for long-term storage. note that archived submissions are not deleted and can be retrieved if needed, but they won’t appear in standard searches or reports.

Action Parameters

Action Response

Create or update the draft version of a marketing email. if no draft exists, the system creates a draft from the current “live” email then applies the request body to that draft. the draft version only lives on the buffer—the email is not cloned.

Action Parameters

Action Response

This endpoint allows for partial updates to a product in hubspot’s crm system. it’s designed to modify existing product information by overwriting specified property values while preserving unmentioned properties. the endpoint is particularly useful for e-commerce integrations, enabling seamless product data management. it supports both internal object ids and custom unique properties for product identification, offering flexibility in how products are referenced and updated.(DEPRECATED use update_product)

Action Parameters

Action Response

Use this endpoint to get aggregated statistics of emails sent in a specified time span. it also returns the list of emails that were sent during the time span.

Action Parameters

Action Response

Performs a partial update on a specific quote object in the hubspot crm. this endpoint allows you to modify individual properties of an existing quote without affecting other properties not included in the update. it’s particularly useful for making targeted changes to quote information, such as updating the status, amount, or any custom properties associated with the quote. the endpoint supports identification of quotes either by their internal hubspot id or by a unique custom property, providing flexibility in how you reference and update quote objects in your integration.

Action Parameters

Action Response

Retrieves a batch of crm object properties for a specified object type in hubspot. this endpoint allows you to efficiently read multiple properties in a single api call, reducing the number of requests needed for bulk data retrieval. it’s particularly useful when you need to fetch various attributes for multiple objects of the same type, such as contacts, companies, or deals. the endpoint supports partial success, returning data for successfully processed properties while providing error information for any failed requests within the batch.

Action Parameters

Action Response

This endpoint permanently deletes a deal and all associated content from hubspot’s crm for gdpr compliance purposes. it’s designed to help businesses adhere to the general data protection regulation (gdpr) by allowing the complete removal of deal data upon request. the endpoint can identify deals by email address if the optional ‘idproperty’ is set to ‘email’. if the specified email address is not found, it will be added to a blocklist to prevent future use. this operation is irreversible and should be used with caution, only when gdpr compliance requires the permanent removal of deal data.

Action Parameters

Action Response

Retrieves all existing properties for a specified object type in the hubspot crm. this endpoint is crucial for understanding the structure and available fields for different crm objects such as contacts, companies, deals, or custom objects. use this tool when you need to get a comprehensive list of properties, including both default and custom properties, for a particular object type. it’s especially useful when setting up integrations, creating custom views, or preparing data imports. note that this endpoint does not return the actual values of these properties for specific records, only their definitions and metadata.

Action Parameters

Action Response

Retrieves detailed information about a specific pipeline stage within a hubspot crm pipeline. this endpoint allows you to fetch the properties and metadata of a single stage by providing its unique identifier, the pipeline it belongs to, and the object type it’s associated with. use this when you need to access or verify the details of a particular stage in your crm workflow, such as its label, display order, or any custom properties. this endpoint is particularly useful for applications that need to dynamically update or display pipeline stage information.

Action Parameters

Action Response

Change properties of a marketing email.

Action Parameters

Action Response

Creates a new variation of an existing email for a/b testing in hubspot’s email marketing tools. this endpoint allows marketers to generate alternative versions of an email to compare performance and optimize engagement. use this when you want to set up an a/b test for an email campaign, testing elements such as subject lines, content, or calls-to-action. the new variation is based on an existing email content and is assigned a unique name for easy identification. this tool is specifically for creating test variations and does not initiate the actual a/b test or send emails.

Action Parameters

Action Response

Retrieves the schema definition for an existing object in hubspot’s crm. this endpoint allows developers to fetch detailed information about the structure, properties, and associations of a specific crm object type. it’s particularly useful when working with custom objects or when you need to understand the data model of standard hubspot objects. use this endpoint when you need to inspect the fields, data types, and relationships of a crm object before performing operations on it. note that this endpoint only retrieves existing schemas and cannot be used to create or modify object schemas.

Action Parameters

Action Response

Publishes or sends a marketing email in hubspot. requires marketing hub enterprise account or transactional email add-on.

Action Parameters

Action Response

This endpoint allows for partial updates to a hubspot ticket identified by its unique id. it enables you to modify specific properties of a ticket object without affecting the entire record, making it ideal for targeted updates to customer support issues. the endpoint accepts a json object containing only the properties you wish to update, ignoring read-only and non-existent fields. use this when you need to make selective changes to a ticket, such as updating its status, priority, or any custom fields. note that you can clear property values by passing an empty string, and the endpoint provides flexibility in identifying tickets through either their internal id or a custom unique property.

Action Parameters

Action Response

This endpoint retrieves detailed information about a specific crm object in hubspot by its unique identifier. it allows for flexible querying of various object types (such as contacts, companies, or deals) and provides granular control over the returned data. use this endpoint when you need to fetch comprehensive details about a single crm object, including its properties, historical changes, and associated entities. it’s particularly useful for displaying detailed views of crm records, tracking changes over time, or gathering related data across different object types in a single api call. the endpoint supports customization of the response through optional parameters, enabling efficient data retrieval tailored to specific needs.

Action Parameters

Action Response

Update a batch of tickets.

Action Parameters

Action Response

Creates multiple line items in a single api call within the hubspot crm. this endpoint is designed for bulk operations, allowing efficient creation of numerous line items simultaneously. it’s particularly useful for scenarios such as importing large datasets, setting up initial inventory, or updating multiple products at once. the endpoint accepts a batch of line item data and returns the created objects or error information for any failed creations.

Action Parameters

Action Response

Get a list of all versions of a marketing email, with each entry including the full state of that particular version. the current revision has the id -1.

Action Parameters

Action Response

Updates existing calling extension settings for a specific app in hubspot’s crm system. this endpoint allows developers to modify various properties of a calling extension, such as its name, url, dimensions, and feature support flags. it should be used when changes to an existing calling extension configuration are needed, for example, to update the iframe url or adjust the display size. the endpoint requires the app id and a json object with the updated settings. it returns the modified settings upon successful update.

Action Parameters

Action Response

Read a page of emails. control what is returned via the properties query param.

Action Parameters

Action Response

The batchupdateemails endpoint allows for updating multiple email records simultaneously in the hubspot crm. this powerful feature enables efficient bulk modifications of email properties, such as updating statuses, changing pipeline stages, or modifying custom fields for multiple emails in a single api call. it’s particularly useful for synchronizing data from external systems or performing mass updates based on certain criteria. the endpoint accepts an array of email objects, each identified by either their hubspot id or a custom unique property, along with the properties to be updated. while it streamlines bulk operations, users should be cautious when updating large numbers of records to avoid hitting api rate limits.

Action Parameters

Action Response

Retrieves detailed information about all owners in the hubspot crm system. this endpoint allows you to fetch owner data using either their unique owner id or user id. it’s particularly useful when you need to access an multiple owners’ profile, such as their name, email etc. and use it in filtergroups.

Action Parameters

Action Response

The results can be filtered, allowing you to find a specific set of emails. see the table below for a full list of filtering options.

Action Parameters

Action Response

This endpoint retrieves a paginated list of crm owners in hubspot. it allows you to fetch owner information with optional filtering by email address and archived status. the endpoint supports pagination for efficient data retrieval, making it ideal for applications that need to display or process owner data in manageable chunks. use this when you need to access owner information across your hubspot crm, such as for user management, reporting, or integration with other systems.

Action Parameters

Action Response

This endpoint creates a batch of campaigns. the maximum number of items in a batch request is 50. the campaigns in the response are not guaranteed to be in the same order as they were provided in the request.

Action Parameters

Action Response

Creates a new company object in the hubspot crm with the provided properties. this endpoint allows you to add a new company to your crm database, including custom fields and properties specific to your hubspot account configuration. upon successful creation, it returns a copy of the newly created company object, including its unique id assigned by hubspot. use this endpoint when you need to programmatically add new companies to your crm, such as when integrating with other systems or automating company record creation. note that the specific properties available for a company may vary based on your hubspot account setup and any custom properties you’ve defined.

Action Parameters

Action Response

This endpoint lists all assets of the campaign by asset type. the assettype parameter is required, and each request can only fetch assets of a single type. asset metrics can also be fetched along with the assets; they are available only if start and end dates are provided.

Action Parameters

Action Response

This endpoint reads a batch of campaigns based on the provided input data and returns the campaigns along with their associated assets. the maximum number of items in a batch request is 50. the campaigns in the response are not guaranteed to be in the same order as they were provided in the request. if duplicate campaign ids are provided in the request, duplicates will be ignored. the response will include only unique ids and will be returned without duplicates.

Action Parameters

Action Response

Retrieves a specific feedback submission object from hubspot’s crm system using its unique identifier. this endpoint allows for customized data retrieval, including specific properties, property history, and associated object ids. it’s particularly useful when you need detailed information about a single feedback submission, such as its content, sentiment, or related data. the tool provides flexibility in how the object is identified and what data is returned, making it valuable for various use cases from basic retrieval to complex data analysis.

Action Parameters

Action Response

Creates a new product object in the hubspot crm system with the specified properties. this endpoint is used to add new products to your e-commerce catalog within hubspot. it allows you to define various attributes of the product such as name, price, description, and any custom properties configured in your hubspot account. upon successful creation, the endpoint returns a copy of the created product object, including its unique id assigned by hubspot. this tool is particularly useful for integrating external e-commerce systems with hubspot or for programmatically managing your product catalog. note that this endpoint creates basic product entries and may not support complex product configurations or variants.

Action Parameters

Action Response

Creates a new timeline event in hubspot’s crm based on a predefined event template. this endpoint allows you to add custom, immutable events to object timelines, providing a detailed record of interactions or activities. once created, the event cannot be modified. if the event template is configured with object property updates, this call will also attempt to update or add those properties to the associated object. use this endpoint to enrich your crm data with specific, structured events tied to contacts, companies, or deals.

Action Parameters