Hubspot

This endpoint allows for batch updating of multiple quotes in the hubspot crm system. it enables efficient modification of quote data by processing multiple updates in a single api call. this endpoint is particularly useful when you need to update a large number of quotes simultaneously, such as adjusting prices, updating expiration dates, or modifying custom fields across multiple quotes. the batch update functionality can significantly reduce the number of api calls required for bulk quote modifications, potentially improving performance and reducing api usage. however, be cautious when using this endpoint, as it can make widespread changes to your crm data in a single operation.

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

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

This endpoint allows you to search for quotes in the hubspot crm based on specified criteria. it provides a flexible way to filter and retrieve quote data, enabling you to find specific quotes or groups of quotes that match your requirements. the search functionality supports complex queries with multiple filter groups and sorting options. use this endpoint when you need to locate quotes based on custom criteria, such as date ranges, amounts, or associated deals. the search results include a collection of quote objects along with pagination information for handling large result sets. note that while this endpoint is powerful, it requires a well-structured request body to function effectively, and the search is limited to the quotes scope within the crm.

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

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.(DEPRECATED use create_company_object)

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

Retrieves a batch of quotes from hubspot’s crm based on specified property values or ids. this endpoint allows for efficient bulk retrieval of quote data, making it ideal for synchronizing large datasets or performing mass updates. it supports filtering by various quote properties and can optionally include archived quotes. the response provides detailed information about each retrieved quote, including all associated properties and values. use this endpoint when you need to fetch multiple quotes simultaneously, reducing the number of api calls required for large-scale operations.

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

Creates a new quote object in hubspot’s crm system with the provided properties. this endpoint allows you to programmatically generate quotes, which can be associated with deals, contacts, or companies in your hubspot account. it’s useful for automating quote creation in sales processes or integrating quote generation with external systems. the endpoint returns a copy of the created quote object, including its newly assigned id, which can be used for further operations or reference. while this endpoint creates standard quotes, be aware that complex or highly customized quote structures may require additional setup in your hubspot account.

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

Retrieves detailed information about a specific hubspot crm contact using their internal object id. this endpoint allows for customized data retrieval, enabling developers to specify which properties to return, include property history, fetch associated object ids, and filter for archived contacts. it’s ideal for situations where you need to access comprehensive contact information or integrate contact data into external systems. the endpoint is particularly useful for building custom crm dashboards, generating detailed contact reports, or syncing contact data with other applications.(DEPRECATED use read_crm_contact_by_id)

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 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

This endpoint creates a new association between object types in hubspot’s crm system. it allows you to define relationships between different entities, such as linking contacts to companies or deals to products. the association is created for the primary object type specified in the path parameter and can be linked to one or more other object types. this tool is essential for structuring and organizing data within the crm, enabling more complex data relationships and improved data management. use it when you need to establish new connections between different types of data in your hubspot crm. note that this endpoint requires specific permissions and should be used carefully as it affects the overall structure of your crm data.

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

The batcharchiveemails endpoint allows you to archive multiple emails in hubspot’s crm system with a single api call. this endpoint is particularly useful for bulk email management, enabling efficient organization of email records within the crm. it should be used when you need to archive a large number of emails simultaneously, which can help in maintaining a clean and organized email database. the endpoint accepts a list of email ids and processes them in batch, which is more efficient than making individual archive requests for each email. however, be aware that this operation is irreversible, so ensure that you truly want to archive the specified emails before making the call.

Action Parameters

Action Response

Update a batch of deals.

Action Parameters

Action Response

Creates a new line item object in the hubspot crm with the provided properties. this endpoint is used to add individual products or services to deals, quotes, or orders. it returns a copy of the created object, including its unique id. use this when you need to add new items to a customer’s order or deal in the hubspot system.

Action Parameters

Action Response

This endpoint permanently deletes a contact and all associated content from hubspot’s crm system to comply with gdpr regulations. it’s designed for use when a data subject exercises their right to be forgotten under gdpr. the endpoint can identify contacts by their 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, enhancing data protection. this tool should be used with caution as the deletion is permanent and irreversible. it’s crucial to verify the necessity and legality of the deletion before using this endpoint, as it will remove all traces of the contact from the crm.

Action Parameters

Action Response

This endpoint allows you to create multiple crm objects of a specified type in a single api call. it’s designed for bulk creation of objects like contacts, companies, deals, or tickets in the hubspot crm system. the endpoint is particularly useful when you need to import a large number of records or synchronize data from another system. it supports creating various object types, determined by the ‘objecttype’ path parameter. the request body should contain an array of objects to be created, following the batchinputsimplepublicobjectinputforcreate schema. the response will either indicate successful creation of all objects or provide details on any errors encountered during the batch creation process. this endpoint is ideal for operations requiring the creation of multiple crm records simultaneously, improving efficiency and reducing the number of api calls needed for bulk data operations.

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

Merges two tickets of the same type in hubspot’s crm system. this endpoint allows you to combine duplicate or related support issues into a single ticket, streamlining your customer support workflow. use this when you need to consolidate information from two separate tickets into one comprehensive record. the merged ticket will contain data from both original tickets, but only one will remain active in the system.

Action Parameters

Action Response

Deletes a custom schema in hubspot’s crm by its object type. this endpoint should be used when you need to remove a custom object schema from your hubspot account. it’s crucial to note that all existing records of this schema must be deleted before calling this endpoint; otherwise, the operation will fail. this is a permanent action and cannot be undone, so use it with caution. the endpoint is particularly useful when restructuring your crm or removing obsolete custom object types.

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

This endpoint archives a batch of quotes in the hubspot crm by their ids. it allows for efficient bulk archiving of multiple quotes in a single api call, which is useful for removing outdated or irrelevant quotes from active use. the operation is irreversible, so use it cautiously. this endpoint should be used when you need to archive multiple quotes simultaneously, such as during a cleanup process or when closing multiple deals. it will not delete the quotes but move them to an archived state, making them inaccessible through normal quote retrieval methods.

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 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

Restores a previous revision of a marketing email to draft state. if there is currently something in the draft for that object, it is overwritten.

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 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

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

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

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

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

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 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

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

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

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

Archives a specific property group in hubspot’s crm by moving it to the recycling bin. this operation allows users to remove obsolete or unnecessary property groups from active use without permanently deleting them. it should be used when reorganizing crm properties or during cleanup processes. once archived, the property group will no longer be available for use in crm operations, but can potentially be restored if needed. exercise caution when using this endpoint, as it immediately impacts the availability of the property group across the crm system.

Action Parameters

Action Response

Retrieves all object schemas that have been defined for your hubspot account. this endpoint is essential for developers working with custom objects and integrating with hubspot’s crm. it returns a comprehensive list of schema definitions, including both standard and custom objects, providing crucial information about the structure and properties of each object type in your account. use this endpoint when you need to understand the data model of your hubspot instance, plan integrations, or work with custom objects. it’s particularly useful for applications that need to dynamically adapt to changes in your hubspot data structure. note that this endpoint does not provide the actual data of the objects, only their schema definitions.

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

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 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

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

This endpoint allows you to archive multiple line items in the hubspot crm system by their ids in a single batch operation. it’s designed for efficient bulk management of line items, particularly useful when you need to archive a large number of items simultaneously. the endpoint should be used when you want to remove multiple line items from active use without permanently deleting them. it’s important to note that this operation is not reversible through the api, so use it carefully. the endpoint doesn’t return the archived items; it only confirms the successful processing of the request with a 204 no content response.

Action Parameters

Action Response

Configures the settings for a calling extension in hubspot’s crm. this endpoint allows you to customize the appearance and behavior of your calling extension by setting the menu label, target iframe url, and dimensions. use this when you need to create or update the configuration for your calling extension to integrate it seamlessly into the hubspot interface. it’s essential for tailoring the user experience of your calling extension within the hubspot crm environment.

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

Retrieves a specific company object from hubspot’s crm by its internal id or a unique property value. this endpoint allows you to fetch detailed information about a company, including selected properties, property history, and associated object ids. use this when you need to access comprehensive data about a particular company in your hubspot crm. the tool provides flexibility in specifying which properties to return and can include archived companies if needed. it’s particularly useful for gathering up-to-date company information for crm synchronization, reporting, or displaying detailed company profiles in your application.

Action Parameters

Action Response

Creates a new stage within an existing pipeline in hubspot’s crm. this endpoint allows you to add a new stage to a specific pipeline, which can be used to represent different steps in your sales, marketing, or customer service processes. the created stage will be associated with the pipeline identified by the provided pipelineid. use this when you need to expand or modify the structure of your crm pipelines by adding new stages. the endpoint returns the complete details of the newly created stage, including its unique identifier.

Action Parameters

Action Response

Removes an existing association from a schema in hubspot’s crm. this endpoint allows you to modify the structure of your custom objects by deleting specific relationships between objects. use this when you need to update your crm’s data model by removing outdated or unnecessary associations. it’s particularly useful when restructuring your crm to reflect changes in your business processes or data requirements. the operation is irreversible, so use it with caution to avoid unintended data relationship loss.

Action Parameters

Action Response

Retrieves detailed information about a specific product in the hubspot crm system. this endpoint allows you to fetch a product by its unique identifier, which can be either the internal object id or a custom unique property value. it provides flexibility in specifying which properties to return, including historical values, and can fetch associated object ids. use this endpoint when you need to access comprehensive product data, including custom properties and associations with other crm objects. it’s particularly useful for e-commerce applications that need to sync product information with hubspot or display detailed product data within an integrated system.

Action Parameters

Action Response

Update a batch of tickets.

Action Parameters

Action Response

Creates a new crm object in hubspot with specified properties and returns a copy of the created object, including its unique id. this endpoint is versatile and can be used to create various standard crm objects (such as contacts, companies, deals) as well as custom objects. it’s ideal for adding new records to your hubspot crm programmatically, allowing for seamless integration with external systems or automated workflows. the endpoint requires specifying the object type and providing the necessary properties for the object being created.

Action Parameters

Action Response

Change properties of a marketing email.

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 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

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

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 the calling extension settings configured for a specific app in hubspot’s crm system. this endpoint allows developers to access important configuration details such as the app’s name, iframe url, dimensions, readiness status, and support for custom objects. use this endpoint when you need to verify or display the current calling settings for your app within hubspot. it’s particularly useful for troubleshooting, auditing configurations, or retrieving settings before making updates. the endpoint returns a comprehensive set of settings but does not allow for modifying these settings directly.

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 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

Retrieves detailed error information for a specific import operation in hubspot’s crm. this endpoint allows users to fetch a paginated list of errors that occurred during the import process, helping to identify and troubleshoot issues with data imports. it should be used after an import operation to check for any problems that may have arisen during the import. the tool provides specific error details, enabling users to correct their data or import process for future attempts. it does not provide information about successful imports or allow for error correction directly through the api.

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

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.(DEPRECATED use read_all_properties_for_object_type)

Action Parameters

Action Response

This endpoint allows you to create multiple feedback submissions in a single api call within hubspot’s crm system. it’s designed for bulk creation of feedback data, which is useful for importing large datasets or synchronizing feedback information from external systems. the endpoint accepts a batch of feedback submission objects and processes them together, returning either a successful batch response or a response with potential errors for each submission. use this endpoint when you need to efficiently create multiple feedback entries simultaneously, reducing the number of individual api calls and improving performance for large-scale data operations.

Action Parameters

Action Response

This endpoint permanently deletes a contact and all associated content from the hubspot crm system to comply with gdpr regulations. it allows for the identification of contacts by email address and includes a feature to blocklist email addresses that are not found to prevent future use. this tool should be used when a data subject exercises their ‘right to be forgotten’ under gdpr. it’s important to note that this action is irreversible and should be used with caution. the endpoint requires proper authentication and the ‘crm.objects.contacts.write’ scope for access.

Action Parameters

Action Response

This endpoint allows you to create multiple quotes simultaneously in the hubspot crm system. it’s designed for efficiency when you need to add a large number of quotes at once, such as during data migration or when processing bulk quote requests. the endpoint accepts a batch of quote objects and attempts to create all of them, returning detailed results for each quote in the batch. use this when you have multiple quotes to create and want to optimize api usage by reducing the number of individual calls. note that partial success is possible, so it’s important to check the response for any errors on specific quotes within the batch.

Action Parameters

Action Response

Permanently deletes a contact and all associated content from hubspot’s crm system to comply with gdpr regulations. this endpoint should be used when a data subject exercises their right to erasure under gdpr. it provides the option to identify a contact by email address using the ‘idproperty’ set to ‘email’. if the 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, as it will remove all data associated with the contact.

Action Parameters

Action Response

Replaces all properties of an existing pipeline in hubspot’s crm system with the provided values. this operation overwrites any existing pipeline stages and returns the updated pipeline in the response. it allows for complete customization of pipeline properties and stages for different crm object types such as deals, tickets, or contacts. use this endpoint when you need to perform a full update of a pipeline’s structure and properties, rather than making incremental changes.

Action Parameters

Action Response

This endpoint allows you to merge two existing feedback submissions in hubspot’s crm system. it combines the data from two separate feedback submissions into a single record, which can be useful for consolidating duplicate entries or combining related feedback from the same customer. the merged result will contain information from both original submissions, with one submission typically taking precedence for overlapping fields. use this endpoint when you need to clean up your feedback data or combine information from multiple submissions. note that this operation is irreversible, so it’s important to ensure you want to permanently combine the selected feedback submissions before making the api call. the endpoint returns the merged feedback submission object upon successful completion.

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

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 permanently deletes line items and all associated content to comply with gdpr regulations. it’s designed for situations where a complete erasure of customer data is required, such as when a customer exercises their “right to be forgotten”. the deletion is irreversible, ensuring that all traces of the specified line items are removed from the system. additionally, it offers the option to identify contacts by email address, adding unmatched emails to a blocklist to prevent future use. use this endpoint with caution, as it permanently removes data and cannot be undone.

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

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 enables batch reading of crm objects in hubspot by their ids or property values. it supports retrieving multiple objects of a specified type (e.g., contacts, companies, deals) in a single api call, improving efficiency for bulk data retrieval operations. the endpoint allows filtering for archived objects and requires a request body specifying the objects to be fetched. it’s particularly useful for synchronizing large datasets or performing bulk operations on crm data.

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

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

Archives a specific quote object in hubspot’s crm by moving it to the recycling bin. this endpoint is used to remove a quote from active use while preserving its data for potential future reference. it’s particularly useful for managing outdated or rejected quotes, helping to keep the active quote list clean and organized. the operation is irreversible through this api, so it should be used with caution when permanent removal of a quote from active status is desired.

Action Parameters

Action Response

Partially updates a specific crm property in hubspot, identified by the object type and property name. this endpoint allows you to modify existing properties for various crm objects like contacts, companies, deals, or custom objects. use this when you need to change certain attributes of a property without affecting the entire property configuration. the update is performed by overwriting only the provided fields, leaving others unchanged.

Action Parameters

Action Response

Retrieves detailed information about a specific product in the hubspot crm system. this endpoint allows you to fetch a product by its unique identifier, which can be either the internal object id or a custom unique property value. it provides flexibility in specifying which properties to return, including historical values, and can fetch associated object ids. use this endpoint when you need to access comprehensive product data, including custom properties and associations with other crm objects. it’s particularly useful for e-commerce applications that need to sync product information with hubspot or display detailed product data within an integrated system.(DEPRECATED use read_product_by_id)

Action Parameters

Action Response

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

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

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

Action Response

Retrieves all existing property groups for a specified crm object type in your hubspot account. this endpoint is useful for understanding how properties are organized within your crm, which can aid in data management and reporting. it should be used when you need an overview of the property structure for a particular object type, such as contacts or companies. the endpoint returns a collection of property groups without pagination, providing a complete list in a single request. note that this endpoint only returns the groups themselves, not the individual properties within each group.(DEPRECATED use read_property_groups_for_object_type)

Action Parameters

Action Response

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

Action Parameters

Action Response

This endpoint allows you to remove a specific deal object from the hubspot crm by moving it to the recycling bin. it’s used when you need to delete a deal that is no longer relevant or was created in error. the operation is permanent and should be used with caution. once a deal is moved to the recycling bin, it will no longer appear in active deal lists or reports. this endpoint is particularly useful for maintaining a clean and accurate sales pipeline in your crm.

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

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 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

Searches for products in the hubspot crm based on specified criteria. this endpoint allows you to find products that match certain conditions, enabling efficient product management and retrieval. use this when you need to locate specific products or groups of products within your hubspot crm. the search is performed using a flexible criteria system, allowing for complex queries. the results are paginated, making it suitable for handling large product catalogs. note that this endpoint has a rate limit exemption, allowing for more frequent use compared to other endpoints.(DEPRECATED use search_products_by_criteria)

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

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

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

List all the valid association types available between two object types

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 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

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

This endpoint moves a specified crm property to the recycling bin in hubspot. it allows users to archive properties that are no longer needed or relevant, without permanently deleting them. the endpoint should be used when you want to remove a property from active use in your crm objects, such as contacts, companies, or deals. it’s important to note that this action doesn’t permanently delete the property, but rather moves it to a recyclable state. use this endpoint with caution, as archiving a property may affect existing records and integrations that rely on that property.

Action Parameters

Action Response

Fetch the list of contact ids for the specified campaign and contact type

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

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 allows you to create multiple products in the hubspot crm simultaneously using a single api call. it’s designed for efficient bulk product creation, particularly useful for e-commerce applications that need to add or update large numbers of products. the endpoint accepts a batch of product data and processes them together, returning individual results for each product in the batch. use this when you need to create multiple products at once to optimize api usage and streamline your product management workflow.

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 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

This endpoint allows for batch updating of multiple crm objects of a specified type in hubspot. it enables efficient bulk modifications of records such as contacts, companies, or deals. the endpoint can update objects either by their internal ids or by matching property values. use this when you need to update multiple records simultaneously, which is more efficient than making individual api calls for each object. note that the success of updates can be partial, with some objects updated successfully while others may fail.

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 partially update an existing pipeline in hubspot’s crm system. it’s used to modify specific attributes of a pipeline without replacing the entire object. you can update various aspects of the pipeline, such as its stages, display order, or active status. this operation is useful when you need to make incremental changes to a pipeline without affecting its entire structure or unspecified fields. the endpoint returns the fully updated pipeline object, reflecting all changes made.

Action Parameters

Action Response

Get a specific revision of a marketing email.

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

Updates an existing token on a hubspot crm event template. this endpoint allows you to modify token properties such as label and options, but does not permit changes to the token’s name or type. use this when you need to refine or adjust the details of a token within an event template, such as updating labels or modifying enumeration options. this operation is crucial for maintaining and evolving your custom event templates in the hubspot crm timeline without creating new tokens or altering the fundamental structure of existing ones.

Action Parameters

Action Response

Retrieves a paginated list of feedback submissions from hubspot surveys. this endpoint allows you to fetch feedback data with customizable property selection, association retrieval, and filtering options. use this when you need to analyze customer feedback, track survey responses, or integrate feedback data into your applications. the endpoint supports pagination for handling large datasets and provides options to retrieve both current and historical property values.

Action Parameters

Action Response

Archives a product in the hubspot crm by moving it to the recycling bin. this endpoint is used to remove a product from active use without permanently deleting it. it’s ideal for managing product catalogs in e-commerce applications integrated with hubspot. the operation is irreversible through the api, but archived products can be restored manually through the hubspot interface if needed. use this endpoint when a product is no longer available or relevant, but you want to retain its historical data.

Action Parameters

Action Response

Retrieves a paginated list of deals from the hubspot crm system. this endpoint allows for customizable data retrieval by specifying which properties and associations to include in the response. it supports efficient handling of large datasets through cursor-based pagination. use this endpoint when you need to fetch deal information in bulk, such as for reporting, data synchronization, or displaying deal lists in your application. the endpoint provides flexibility in filtering archived deals and retrieving historical property values, making it suitable for various crm data management tasks.

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 you to search for crm objects in hubspot based on specific criteria. it provides a flexible way to retrieve records across different object types such as contacts, companies, deals, and tickets. the search functionality enables you to filter and find exact matches or apply more complex search logic to locate the desired crm objects. this endpoint is particularly useful when you need to find specific records that meet certain conditions or when you want to perform advanced queries on your crm data. it should be used when you need to retrieve a collection of objects that match your search criteria, rather than fetching all objects or looking up a single object by id.

Action Parameters

Action Response

Get the details for a marketing email.

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 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

This endpoint retrieves a comprehensive list of all event templates associated with a specific app in hubspot’s crm timeline. it allows developers to access detailed information about each template, including their structure, associated object types, and custom tokens. use this endpoint when you need to review, audit, or manage the event templates created for your hubspot app. it’s particularly useful for understanding the current configuration of your app’s timeline events or preparing for updates to existing templates. the endpoint returns a collection of template objects, providing a complete overview of how timeline events are structured for the specified app.

Action Parameters

Action Response

Use this endpoint to create a new marketing email.

Action Parameters

Action Response

Archives a contact in the hubspot crm by moving it to the recycling bin. this endpoint should be used when you need to remove a contact from active use in your crm. the operation is irreversible through the api, so use it with caution. once archived, the contact will no longer appear in standard contact lists or searches. this endpoint is useful for data cleanup or when a contact is no longer relevant to your business operations.

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

This endpoint allows you to perform a partial update on a line item object in hubspot’s crm system. it’s used to modify specific properties of an existing line item without affecting other properties. the endpoint is ideal for making targeted changes to line items, such as updating prices, quantities, or other attributes. it supports flexible object identification through either the internal object id or a custom unique property. the update operation will overwrite provided property values, ignore read-only and non-existent properties, and allows clearing of property values by passing an empty string. this tool is essential for maintaining accurate and up-to-date line item information in the crm, especially when dealing with changes in orders or deals.

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

Fully delete a workflow by id. warning: deleted workflows cannot be restored via the api. if you need to restore an accidentally deleted flow, you’ll need to contact support.

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

This endpoint updates a batch of campaigns based on the provided input data. the maximum number of items in a batch request is 50. if an empty string ("") is passed for any property in the batch update, it will reset that property’s value.

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

Updates multiple feedback submissions in the hubspot crm system simultaneously. this endpoint allows for efficient bulk modifications of feedback data, streamlining the process of managing customer feedback at scale. it’s particularly useful for updating large sets of feedback submissions or synchronizing data from external systems. the endpoint accepts a batch of feedback submission updates and processes them in a single request, reducing api calls and improving performance for large-scale operations.

Action Parameters

Action Response

Archives a batch of tickets in the hubspot crm by their ids. this endpoint allows for efficient bulk archiving of multiple tickets in a single api call. it should be used when you need to remove tickets from active status, making them inaccessible for further updates or interactions. this operation is particularly useful for data cleanup, removing old or resolved tickets, or managing large volumes of ticket data. the endpoint processes the provided ticket ids in bulk, improving performance for large-scale archiving operations.

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

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

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