+
Beyond-Bot.ai + hubspot
HubSpot is an inbound marketing, sales, and customer service platform integrating CRM, email automation, and analytics to facilitate lead nurturing and seamless customer experiences
What You Can Do with this Integration
Automate Data Entry
Automatically sync new contacts or deals from Beyond-Bot.ai to hubspot.
Enrich Customer Profiles
Use Beyond-Bot.ai to find and add new information to your records in hubspot.
Trigger Workflows
Start automated workflows in hubspot based on conversations with your virtual expert.
Available Actions
Here are the specific actions your virtual expert can perform within hubspot.
Hubspot Create Batch Of Ticket
Creates multiple hubspot tickets in a batch, each with its own properties and associations; `inputs` list must not be empty, each item needs `properties`, and associations/custom properties must be validly defined using internal names for custom fields and iso 8601 for dates.
Hubspot Create Product Batch
Creates multiple products in hubspot crm in a batch, allowing unique properties and associations per product; ensure `associationcategory` and `associationtypeid` are valid, and `to id` refers to an existing crm object id when specifying associations.
Hubspot Create Product Object
Creates a new product in hubspot with specified properties and optional associations; ensure `hs sku` is unique if provided, custom properties are pre-defined in hubspot, and any association `to id` and `associationtypeid` are valid.
Hubspot Get Pipeline Stage Audit
Retrieves a reverse chronological list of all mutations (changes) for a specific pipeline stage; the associated pipeline id is inferred from the api path and is not a direct input.
Hubspot List Products With Paging
Retrieves a paginated list of products from hubspot crm, optionally including specific properties, their history, associated object ids, and filtering by archived status.
Hubspot Update Product
Partially updates an existing hubspot crm product, identified by `productid` (or a custom unique `idproperty`), by modifying only specified `properties`.
Hubspot Add Asset Association
Associates an existing asset ('form', 'object list', or 'external web url') with a specified hubspot marketing campaign.
Hubspot Add Token To Event Template
Adds a new custom data token to an existing event template for a specified hubspot application, optionally populating a crm object property if objectpropertyname is provided.
Hubspot Archive
Archives the hubspot email specified by `emailid` by moving it to the recycling bin, making it inaccessible unless restored.
Hubspot Archive A Batch Of Emails By Id
Archives multiple hubspot crm emails by id; ids must exist as archiving is irreversible.
Hubspot Archive A Batch Of Quotes By Id
Archives a batch of existing, non-archived quotes by their ids; this action is irreversible and useful for managing outdated or irrelevant quotes.
Hubspot Archive Batch Of Companies By Id
Archives a batch of companies by their unique ids; targeted companies must exist, not be previously archived, and this api operation is irreversible.
Hubspot Archive Batch Of Contacts By Id
Archives a batch of existing contacts by their hubspot crm ids, rendering them inactive; this action is irreversible via the api and requires manual restoration or a separate unarchive endpoint.
Hubspot Archive Batch Of Deals By Id
Archives a batch of existing deals by their unique hubspot ids, removing them from active views and reports (soft delete); archived deals may be restorable.
Hubspot Archive Batch Of Feedback Submissions By Id
Asynchronously archives a batch of hubspot feedback submissions using their unique ids, which must correspond to valid and existing submissions; the operation is queued, and submissions are moved from active views without being deleted.
Hubspot Archive Batch Of Line Items By Id
Archives a batch of existing line items by their unique ids in hubspot crm; this operation is irreversible via the api.
Hubspot Archive Batch Of Objects By Id
Archives a batch of existing, non-archived crm objects of a specified `objecttype` by their ids, effectively hiding them from active use.
Hubspot Archive Batch Of Properties
Archives a batch of properties by their internal names for a specified hubspot crm object type; this operation is idempotent and safe to retry.
Hubspot Archive Batch Of Tickets By Id
Archives a batch of existing, unarchived hubspot crm tickets by their unique ids.
Hubspot Archive Batch Products By Id
Archives a batch of existing, unarchived hubspot products by their ids; this action is irreversible via the api.
Hubspot Archive Company
Archives an existing company in hubspot crm by its `companyid`, moving it to a recycling bin from which it can be restored, rather than permanently deleting it.
Hubspot Archive Contact By Id
Archives a contact in hubspot crm by its id, moving it to the recycling bin; this is generally irreversible via api and removes the contact from active use.
Hubspot Archive Crm Object By Id
Archives a specific hubspot crm object by its type and id, moving it to the recycling bin; this action is irreversible via the api but objects can often be restored via the hubspot ui.
Hubspot Archive Feedback Submission
Archives an existing, non-archived feedback submission in hubspot crm by its id, moving it to the recycling bin (not permanently deleting it).
Hubspot Archive Line Item By Id
Archives a specific hubspot line item by its id, moving it to a recoverable state.
Hubspot Archive Product By Product Id
Archives an existing product in hubspot crm by its `productid`, moving it to an archived state (irreversible via api) to remove it from active use while retaining its data.
Hubspot Archive Property By Object Type And Name
Archives a specified crm property by its object type and name, moving it to the recycling bin; note that some default hubspot properties cannot be archived.
Hubspot Archive Property Group
Archives a hubspot property group, making it inactive and hidden (not permanently deleted, allowing potential restoration) with immediate effect on its crm visibility and usability.
Hubspot Archive Quote Object By Id
Archives a hubspot quote object by id to the recycling bin; this is api-irreversible and may need manual restoration.
Hubspot Archive Ticket By Id
Archives an existing hubspot ticket by its id, moving it to the recycling bin; this is a permanent operation not undoable via the api.
Hubspot Audit Pipeline Changes By Id
Retrieves a reverse chronological audit log of all changes for a specific, existing hubspot crm pipeline, which is identified by its `pipelineid` and a valid `objecttype` that supports pipelines (e.g., 'deals', 'tickets').
Hubspot Batch Read Companies By Properties
Batch-retrieves hubspot company records by their ids, allowing custom id properties, specific properties to fetch, and historical data.
Hubspot Batch Update Quotes
Updates multiple existing hubspot quotes in a batch; each quote is identified by its object id or a custom unique property (via `idproperty`), and only writable properties are modified.
Hubspot Campaign Search
Searches for and retrieves a paginated list of hubspot marketing campaigns.
Hubspot Cancel Active Import
Cancels an active hubspot data import job using its `importid`; this action is irreversible, and any data already processed will remain.
Hubspot Clone Marketing Email
Duplicates an existing hubspot marketing email, identified by its `id`, into a new draft; an optional `clonename` can be assigned to this new email copy.
Hubspot Configure Calling Extension Settings
Configures or updates settings for a hubspot app's calling extension, including its name, ui url, iframe dimensions, `isready` status, and `supportscustomobjects` flag, for the specified `appid`.
Hubspot Create
**deprecated: use the `create product object` action instead.** creates a new hubspot product; ensure `hs sku` is unique if provided, custom properties are pre-defined in hubspot, and any association `to id` and `associationtypeid` are valid.
Hubspot Create Ab Test Variation
Creates a new a/b test variation for an existing hubspot email, using its `contentid`; this action only creates the variation, it does not start the a/b test or send emails.
Hubspot Create And Return A New Property Group
Creates a new, empty property group for a specified crm object type in hubspot, requiring a unique group name for that object type; properties must be added separately.
Hubspot Create Association For Object Type
Creates the *definition* (schema) of a new association in hubspot, specifying how two crm object types relate (not an actual link between records); any provided `name` must be unique for the `fromobjecttypeid` and `toobjecttypeid` pair.
Hubspot Create A Batch Of Campaigns
Creates up to 50 marketing campaigns in a single batch operation.
Hubspot Create A Batch Of Companies
Creates multiple company records in hubspot crm in a single batch operation, processing up to 100 companies per request.
Hubspot Create A Batch Of Contacts
Deprecated: use the `create batch of contacts` action instead. creates multiple hubspot contact records.
Hubspot Create A Batch Of Emails
Creates multiple email objects for record-keeping (does not send emails) within hubspot crm in a single batch, allowing properties and associations to other crm objects to be set for each email.
Hubspot Create A Campaign
Creates a new marketing campaign in hubspot with the specified properties, returning the created campaign data including its `campaignguid`.
Hubspot Create A New Marketing Email
Creates a new marketing email in hubspot, allowing comprehensive configuration of content, recipients, sender details, a/b testing, scheduling, web version, and other settings; the internal `name` for the email is required.
Hubspot Create Batch Of Contacts
Creates up to 100 new contact records in hubspot crm, optionally associating them with existing crm objects; ensure associated object ids are valid.
Hubspot Create Batch Of Deals
Creates multiple deals in hubspot crm; ensure any associated object ids, deal stages, and pipeline ids specified are valid and exist within the hubspot account.
Hubspot Create Batch Of Feedback Submissions
Creates a batch of feedback submissions in hubspot, ideal for bulk imports; all property names, `associationtypeid`s, and association `to id`s must reference existing entities in hubspot.
Hubspot Create Batch Of Line Items
Creates multiple hubspot line items in a batch, each with specified properties and associations to other existing crm objects.
Hubspot Create Batch Of Objects
Creates multiple crm objects of a specified `objecttype` (e.g., contacts, companies, deals) in a single batch operation, where each object can have its own set of properties and associations.
Hubspot Create Batch Of Properties
Efficiently creates multiple crm properties in a single batch for a specified hubspot object type (e.g., 'contacts', 'companies', custom object id), ideal for schema setup or updates.
Hubspot Create Batch Of Quotes
Creates multiple hubspot crm quotes in a batch, ideal for bulk operations; provide meaningful quote details in `inputs` as property requirements can vary, and inspect response for individual quote statuses as partial success is possible.
Hubspot Create Company Object
Creates a new company object in hubspot crm with specified properties and associations, returning the new company object.
Hubspot Create Contact Object With Properties
Creates a new hubspot contact with specified properties and optional associations; requires at least one identifiable property (e.g., email) and valid `to id` for any associations.
Hubspot Create Crm Object With Properties
Creates a new hubspot crm object (e.g., contact, company, custom object) with specified `properties` (using valid internal names) and `associations` (to existing objects via valid type ids).
Hubspot Create Event Template For App
Creates a new event template for a hubspot app, defining structure, custom properties (tokens), and appearance (markdown with handlebars) of custom timeline events for crm objects; this template must exist before logging corresponding events.
Hubspot Create Feedback Submission
Creates a new hubspot feedback submission to record customer feedback (e.g., survey responses, support interactions), optionally associating it with crm objects.
Hubspot Create Line Item Object
Creates a new hubspot line item, where `properties` must contain all keys required by the specific hubspot instance, `associations` items must link to existing crm objects via `to id`, and an empty `associations` list is permissible if the api supports unassociated line items.
Hubspot Create Multiple Timeline Events Batch
Creates multiple immutable timeline events in a batch, ideal for bulk data imports or real-time synchronizations, using a valid event template; may update crm properties if the template is so configured.
Hubspot Create New Deal Object
Creates a new deal in hubspot crm with specified properties and associations; ensure `pipeline`, `dealstage`, and any `associations.to id` are valid existing ids, and providing `dealname` is highly recommended.
Hubspot Create New Object Schema With Custom Properties
Creates a new custom object schema in hubspot crm with unique naming for schema and properties, defined display/required/searchable properties within the 'properties' list, provided immutable labels, and correctly configured 'enumeration' type properties (options/referencedobjecttype).
Hubspot Create Or Update Draft Version
Creates or updates the draft version of a marketing email identified by `emailid`; if no draft exists, a new one is created from the current live version to prepare changes or a/b tests before publishing.
Hubspot Create Pipeline For Object Type
Creates a new hubspot pipeline for a specified crm `objecttype` (e.g., 'deals', 'tickets'), requiring the pipeline `label` be unique for that `objecttype` and each stage `label` be unique within the pipeline.
Hubspot Create Pipeline Stage
Creates a new stage in a specified hubspot crm pipeline for a given object type, such as 'deals' or 'tickets'.
Hubspot Create Property For Specified Object Type
Creates a new custom property for a specified hubspot crm object type; ensure `groupname` refers to an existing property group for the `objecttype`.
Hubspot Create Quote Object
Creates a new quote object in hubspot crm with specified properties and associations.
Hubspot Create Ticket Object
Creates a new ticket in hubspot with specified properties and associations; ensure custom property names, associated object ids (`to`), pipeline ids (`hs pipeline`), and stage ids (`hs pipeline stage`) are valid in your hubspot instance.
Hubspot Create Timeline Event Based On Template
Creates an immutable custom timeline event on a crm object's record using a specified, existing event template (identified by `eventtemplateid`), optionally updating crm object properties if defined in the template; requires `email`, `utk`, or `objectid` for association.
Hubspot Create Workflow
Creates a new hubspot workflow to automate processes; ensure `enrollmentcriteria` and `actions` use properties relevant to the specified `objecttypeid`.
Hubspot Customizable Contacts Page Retrieval
Deprecated: use 'list contacts page' to retrieve a paginated list of hubspot contacts.
Hubspot Delete A Batch Of Campaigns
Archives a batch of up to 50 marketing campaigns, hiding them from active views rather than permanently deleting them.
Hubspot Delete A Marketing Email
Deletes an existing marketing email, either permanently (default) or by archiving if `archived` is `true`.
Hubspot Delete Calling Extension Settings
Permanently deletes the settings for a calling extension app, specified by its `appid`, rendering it unusable for all connected hubspot accounts; this operation is irreversible.
Hubspot Delete Campaign
Permanently deletes a marketing campaign from hubspot using its `campaignguid`; returns a 204 no content status even if the campaign does not exist.
Hubspot Delete Contact For Gdpr Compliance
Irreversibly deletes a hubspot contact for gdpr compliance (identified via `objectid` and `idproperty`); an email `objectid` for a non-existent contact may be blocklisted.
Hubspot Delete Pipeline By Id
Permanently deletes a hubspot pipeline and all its stages by `pipelineid` and `objecttype`; this is irreversible, so use validation flags to avoid errors if the pipeline is not empty.
Hubspot Delete Pipeline Stage By Id
Permanently deletes a specific pipeline stage for an `objecttype` (e.g., 'deals', 'tickets') that supports pipelines; this operation is irreversible, so ensure no active crm records are associated with the stage to prevent data issues.
Hubspot Delete Schema By Object Type
Permanently deletes a hubspot custom object schema, specified by its `objecttype`, after all associated crm records have been deleted.
Hubspot Delete Timeline Event Template
Permanently and irreversibly deletes a specific timeline event template, identified by its `eventtemplateid`, from the application `appid`.
Hubspot Delete Video Conferencing App Settings
Irreversibly deletes all settings for a video conferencing application identified by its `appid` in hubspot, removing its configuration and preventing it from functioning until reconfigured; existing meetings and historical data are unaffected.
Hubspot Delete Workflow
Permanently deletes a hubspot workflow by its id; deleted workflows cannot be restored via the api and the id must exist.
Hubspot Fetch Contact Details By Id
Deprecated: use `read crm contact by id` instead. retrieves a hubspot crm contact by its unique internal hubspot id, allowing selection of properties, historical values, associated objects, and filtering for archived contacts.
Hubspot Fetch Contact Ids
Fetches hubspot contact ids for a specified `campaignguid` (must be a valid uuid of an existing campaign) and `contacttype`, supporting date filtering and pagination.
Hubspot Fetch Import Error Details
Fetches a paginated list of read-only error details for a specific hubspot crm import, requiring a valid `importid` for a processed import.
Hubspot Fetch Object Details By Id Or Property
Deprecated: use the 'retrieve line item by id' action instead.
Hubspot Fetch Recording Settings By App Id
Fetches call recording settings for a specified, existing hubspot calling extension app.
Hubspot Fetch Revenue
Fetches a revenue attribution report for a specified, existing marketing campaign, optionally using a specific attribution model and date range; if both start and end dates are given, `enddate` must not be earlier than `startdate`.
Hubspot Gdpr Delete
Permanently deletes a contact and associated content for gdpr compliance; an email used for identification via `idproperty`='email' that is not found will be irreversibly blocklisted.
Hubspot Get Active Imports List
Retrieves a list of currently active import jobs in hubspot for monitoring ongoing data operations.
Hubspot Get Aggregated Statistics
Retrieves aggregated statistics for marketing emails, optionally within an iso8601 formatted time range, by email ids, or specific email properties.
Hubspot Get Aggregated Statistic Intervals
Retrieves aggregated statistics for marketing emails (e.g., send counts), grouped by specified time intervals within a defined time range.
Hubspot Get All Marketing Emails For A Hub Spot Account
Fetches a list of marketing emails from a hubspot account, with options for filtering, sorting, pagination, and including performance statistics.
Hubspot Get All Workflows
Retrieves a list of workflow summaries (id, name, type, status) from hubspot, using the 'limit' parameter for pagination.
Hubspot Get A Page Of Owners
Retrieves a paginated list of crm owners from hubspot, optionally filtering by email or archived status. <<deprecated: use 'retrieve page of crm owners' instead.>>
Hubspot Get A Revision Of A Marketing Email
Retrieves a specific, previously saved revision of a marketing email using its unique email id and revision id.
Hubspot Get Campaign Metrics
Retrieves key attribution metrics for an existing marketing campaign, identified by its `campaignguid`, within an optional date range.
Hubspot Get Draft Version Of A Marketing Email
Retrieves the draft version of a marketing email by its `emailid`; if no draft exists, returns the published version.
Hubspot Get Import Record Information
Retrieves a comprehensive summary of a specific hubspot crm import record by its `importid`, including status, progress, updates, results, and errors; useful for monitoring and troubleshooting data imports.
Hubspot Get Marketing Emails
Fetches a list of marketing emails from hubspot, supporting filtering by creation/update timestamps, pagination, and sorting.
Hubspot Get Quote By Id
Retrieves a specific hubspot quote by its unique identifier.
Hubspot Get Revisions Of A Marketing Email
Retrieves a paginated list of all historical versions (including full state like content, settings, metadata) for a specified, existing marketing email; revision id -1 identifies the current version.
Hubspot Get Specific Event Template For App
Retrieves detailed information about a specific event template for a given application in hubspot's crm timeline.
Hubspot Get The Details Of A Specified Marketing Email
Retrieves detailed information for a specific marketing email in hubspot using its unique email id, optionally including performance statistics and specific properties.
Hubspot Get The Variation Of A An A B Marketing Email
Retrieves the alternate variation of a specified a/b marketing email; the `emailid` must identify an email currently in an a/b test.
Hubspot Get Workflow By Id
Retrieves comprehensive details for an existing hubspot workflow by its unique id; unsupported actions are designated 'unsupported action' in the response.
Hubspot Get Workflow Email Campaigns
Retrieves email campaigns associated with a specific hubspot workflow id.
Hubspot Initiate Data Import Process
Call this action to start an asynchronous data import into hubspot crm using uploaded files and a detailed `importrequest` json configuration, ensuring this json correctly maps file columns to hubspot properties and files align with these mappings.
Hubspot Instantiate And Return New Company Object
Deprecated: creates a new hubspot crm company object with given properties and associations; use create company object instead.
Hubspot List
Retrieves a paginated list of hubspot emails, allowing selection of specific properties (with or without history), associated object ids, and filtering by archive status.
Hubspot List All Event Templates For App
Retrieves all event templates associated with a valid `appid` for an existing application in hubspot's crm timeline.
Hubspot List Assets
Lists assets of a specific `assettype` for a given hubspot marketing `campaignguid`, optionally including performance metrics for a date range.
Hubspot List Association Types
Lists all valid association types between two specified hubspot crm object types.
Hubspot List Contacts Page
Retrieves a paginated list of hubspot contacts, optionally specifying properties, historical values, and associations; ensure provided property and association names are valid hubspot internal names.
Hubspot List Feedback Submissions Page
Retrieves a paginated list of feedback submissions from hubspot, allowing specification of properties (including history), associated object ids, and filtering by archive status.
Hubspot List Page Of Tickets
Retrieves a paginated list of tickets from hubspot crm, allowing specification of properties to return, properties with history, associated object types, and archival status; use the `after` token from a previous response to fetch subsequent pages.
Hubspot List Quotes Page
Retrieves a paginated list of quotes, allowing selection of specific properties, property history, associated object ids, and filtering by archived status.
Hubspot Merge Two Companies Of Same Type
Merges two existing company records of the same type in hubspot crm, where `objectidtomerge` is absorbed into `primaryobjectid`; this operation is irreversible.
Hubspot Merge Two Contacts Of Same Type
Merges a hubspot contact (`objectidtomerge`) into another contact (`primaryobjectid`), deleting the former and making `primaryobjectid` absorb its data; this irreversible action is used for deduplicating contacts of the same type.
Hubspot Merge Two Deals Of Same Type
Permanently merges two hubspot crm deals of the same type, typically to eliminate duplicates or consolidate related sales opportunities.
Hubspot Merge Two Emails With Same Type
Merges two existing, same-type hubspot crm emails: `objectidtomerge` is absorbed into `primaryobjectid` and then deleted; use for de-duplication, this action is irreversible.
Hubspot Merge Two Feedback Submissions
Merges two existing feedback submissions by id, primarily for consolidating duplicates or related feedback; this operation is irreversible, and `primaryobjectid` values take precedence in conflicts.
Hubspot Merge Two Line Items Of Same Type
Merges two line items, `objectidtomerge` into `primaryobjectid`, which must be of the same type; `objectidtomerge` is absorbed and the operation is irreversible.
Hubspot Merge Two Objects Of Same Type
Merges two distinct hubspot crm objects of the same `objecttype`, consolidating data into `primaryobjectid` (which is preserved) and deleting `objectidtomerge`; this operation is permanent and irreversible.
Hubspot Merge Two Products Of The Same Type
To de-duplicate or combine product variants, merges two existing, same-type hubspot product records by consolidating `objectidtomerge` into `primaryobjectid`; `objectidtomerge` is archived/deleted, and the operation is irreversible.
Hubspot Merge Two Quotes Of Same Type
Merges two distinct quotes of the same type by consolidating `objectidtomerge` into `primaryobjectid` (e.g., for combining information or updating terms); this operation is irreversible.
Hubspot Merge Two Tickets Of Same Type
Merges two existing hubspot tickets of the same type, where `objectidtomerge` (which is then deactivated) is absorbed into `primaryobjectid`.
Hubspot Modify Calling Extension Settings
Updates settings (e.g., display name, ui url/dimensions, feature flags) for an existing calling extension app, identified by `appid`.
Hubspot Partially Update Contact Using Contact Id
Partially updates specified properties for an existing hubspot contact, identified by its valid `contactid`.
Hubspot Partially Update Crm Object By Id
Partially updates specified properties of a crm object (e.g., contact, company, deal) identified by its type and id, or optionally by a unique property value if `idproperty` is specified.
Hubspot Partially Update Deal By Id
Partially updates specified properties of an existing hubspot crm deal, identified by its `dealid` or an optional custom unique `idproperty`.
Hubspot Partially Update Pipeline By Id
Partially updates a crm pipeline's label, display order, or restores an archived pipeline by setting `archived` to `false`.
Hubspot Partially Update Property Group
Partially updates a property group's `displayorder` or `label` for a specified crm `objecttype` in hubspot.
Hubspot Partially Update Ticket By Id
Modifies specified properties of an existing hubspot ticket, identified by `ticketid` or a custom `idproperty`; to clear a property, provide an empty string as its value.
Hubspot Partial Update Company Object By Id
Partially updates specified `properties` of an existing hubspot company, identified by its `companyid` (optionally using `idproperty` as the unique key), ensuring property names are valid hubspot internal names.
Hubspot Partial Update Quote By Quote Id
Performs a partial update on an existing hubspot quote's specified properties, identifying the quote by `quoteid` (either its internal id or a custom unique property value if `idproperty` is provided).
Hubspot Permanently Delete Company For Gdpr Compliance
Permanently deletes a company (identified by objectid) and its associated data from hubspot for gdpr compliance; this action is irreversible and requires the company to exist.
Hubspot Permanently Delete Contact For Gdpr
Irreversibly deletes a hubspot contact for gdpr; if deleting by a non-existent email (using idproperty 'email'), the email is blocklisted instead.
Hubspot Permanently Delete Contact For Gdpr Compliance
Irreversibly erases a hubspot contact and associated data per a gdpr request; if an email is given for a non-existent contact, it's blocklisted.
Hubspot Permanently Delete Contact Gdpr Compliance
Permanently and irreversibly deletes a hubspot **quote** (not a contact, despite the action's internal naming) to comply with gdpr's 'right to be forgotten'.
Hubspot Permanently Delete Contact Via Gdpr
Permanently deletes a hubspot contact and all its associated data for gdpr compliance, identifying the contact by its id or another unique property.
Hubspot Permanently Delete Deal For Gdpr Compliance
Permanently deletes a hubspot deal for gdpr compliance, identified by its unique id or a specified property value; this action is irreversible and may blocklist the identifier if the deal isn't found when using `idproperty`.
Hubspot Permanently Delete Gdpr Contact And Content
Permanently and irreversibly deletes an existing hubspot contact and associated content for gdpr compliance, optionally blocklisting the contact's email.
Hubspot Permanently Delete Line Items For Gdpr
Permanently deletes a specified line item and its associated content for gdpr compliance; this action is irreversible and cannot be undone.
Hubspot Publish Marketing Email
Publishes or sends a specified hubspot marketing email that is valid and ready for sending; requires marketing hub enterprise or the transactional email add-on.
Hubspot Purge Schema By Object Type
Permanently and irreversibly deletes the schema for an existing `objecttype` in hubspot crm; this deprecated endpoint should be used with extreme caution.
Hubspot Read
Deprecated: use `read product by id` instead. retrieves a hubspot product by id, optionally using a unique `idproperty` which must be configured as unique in hubspot, and allows customizing returned data.
Hubspot Read All Properties
Deprecated: use `read all properties for object type` instead. retrieves property definitions for a specified hubspot crm object type.
Hubspot Read All Properties For Object Type
Retrieves definitions and metadata (not actual values) for properties of a specified hubspot crm object type (e.g., 'contacts', 'companies', 'deals', or custom objects).
Hubspot Read All Property Groups
Retrieves all property groups for a specified hubspot crm object type. <<DEPRECATED use read_property_groups_for_object_type>>
Hubspot Read An Owner By Given Id Or User Id
**deprecated:** please use the `retrieve owner by id or user id` action instead. retrieves a specific hubspot crm owner by their id, with options to specify id type (owner or user) and to include archived records.
Hubspot Read Apage Of Objects By Type
Retrieves a paginated list of objects for a specified and valid hubspot crm object type (e.g., 'contacts', 'companies', 'deals', or custom id).
Hubspot Read A Batch Of Campaigns
Retrieves details for a batch of up to 50 marketing campaigns by their ids, optionally including specified properties and asset metrics for a given date range; response order is not guaranteed and duplicate ids are ignored.
Hubspot Read A Batch Of Crm Object Properties
Reads definitions (metadata, not values) for a batch of crm object properties for a specified `objecttype`, supporting partial success.
Hubspot Read A Campaign
Retrieves details for a marketing campaign by `campaignguid`, optionally including specified `properties` and asset metrics if both `startdate` and `enddate` are provided.
Hubspot Read A Crm Property By Name
Reads a specific crm property definition for a given hubspot object type by its internal name.
Hubspot Read A Page Of Deals
Retrieves a paginated list of hubspot crm deals; use the 'after' token from a previous response's 'paging.next.after' for subsequent pages.
Hubspot Read A Property
Deprecated: use `read a crm property by name` to read a specific crm property definition for a given hubspot object type by its internal name.
Hubspot Read A Property Group
Retrieves metadata for a specific property group of a given crm object type, detailing its structure and attributes, but not the actual property values of crm objects.
Hubspot Read Batch Emails
Retrieves a batch of hubspot email objects by their internal ids or values of a specified unique property, allowing targeted property selection, including historical data.
Hubspot Read Batch Feedback Submissions By Id Or Property
Retrieves up to 100 feedback submissions in a batch using their ids or a specified unique `idproperty`, optionally including specified properties and their history.
Hubspot Read Batch Of Contacts By Id Or Properties
Reads a batch of hubspot contacts by their ids or a specified unique `idproperty`, optionally including property history and filtering by archived status; ensure `inputs` refer to existing contacts and `idproperty` (if used) is a unique identifier.
Hubspot Read Batch Of Crm Objects By Id Or Property Values
Reads a batch of crm objects of a specified `objecttype` using their hubspot ids or unique property values from the `inputs` list, allowing retrieval of specific `properties`, their historical values (`propertieswithhistory`), and filtering by `archived` status.
Hubspot Read Batch Of Line Items By Id Or Property Values
Retrieves a batch of hubspot crm line items by their ids, or optionally by values of a custom unique property defined in `idproperty`.
Hubspot Read Batch Of Products By Id Or Property
Retrieves a batch of hubspot crm products by their ids or a specified unique `idproperty`, optionally filtering by archived status and including historical changes for specified properties.
Hubspot Read Batch Of Quotes By Property Values
Efficiently retrieves a batch of hubspot crm quotes by their ids (or a specified unique property), optionally including archived quotes, specific properties, and property history.
Hubspot Read Batch Of Tickets By Id Or Unique Values
Retrieves a batch of hubspot crm tickets using a list of their ids, or optionally via a custom unique property specified in `idproperty`, allowing for selection of specific properties, their history, and filtering by archival status.
Hubspot Read Budget
Fetches detailed budget (total, spent, remaining) and spend information for a marketing campaign, including an 'order' field for sequencing budget/spend items (0 is oldest).
Hubspot Read Crm Contact By Id
Retrieves a hubspot crm contact by its unique internal hubspot id, allowing selection of properties, historical values, associated objects, and filtering for archived contacts.
Hubspot Read Crm Object By Id
Retrieves a specific crm object (e.g., contact, company, deal, ticket) by its id or a unique property, optionally including specific properties, history, and associations.
Hubspot Read Feedback Submission By Id
Reads a hubspot feedback submission by its id, optionally using a custom unique 'idproperty', and allows specifying properties to return including history and associations.
Hubspot Read Product By Id
Retrieves a hubspot product by its id, allowing customization of returned properties, history, and associations; `idproperty` can specify an alternative unique identifier property which must be configured as unique in hubspot.
Hubspot Read Property Groups For Object Type
Retrieves all property groups in a single call for a specified hubspot crm object type (e.g., 'contacts', 'companies'), returning only the groups themselves, not the individual properties within them.
Hubspot Recycle Contact By Id
Deprecated: use the `archive contact by id` action to archive a hubspot crm contact by its id.
Hubspot Remove Asset Association
Disassociates an asset (form, object list, or external web url) from a hubspot campaign.
Hubspot Remove Association From Schema
Permanently removes a specified association definition (type) from a hubspot object's schema, preventing future creations of this association type without affecting existing instances.
Hubspot Remove Deal Object By Id
Archives a hubspot deal by its `dealid`, moving it to the recycling bin when it's no longer relevant, created in error, or needs removal from active view; archived deals won't appear in active lists or reports.
Hubspot Remove Token From Event Template
Removes a token from a hubspot event template, preventing its inclusion in new events created from that template.
Hubspot Render Event Detail Template
Renders detailed information for a specific hubspot crm timeline event using a predefined event template, ignoring `extradata` references in the template not present in event data.
Hubspot Render Event Header Or Detail As Html
Renders an event's header or detail template as html for a specified event on the hubspot crm timeline, using a given event template id and event id.
Hubspot Replace All Properties Of Pipeline
Overwrites an entire crm pipeline (specified by `objecttype` and `pipelineid`) and all its stages with a new definition, returning the updated pipeline.
Hubspot Replace Pipeline Stage Properties
Replaces all properties of a specified pipeline stage; the new `label` must be unique within the pipeline, and if `objecttype` is 'deals', the `metadata` must include a 'probability' key.
Hubspot Reset Draft
Resets a marketing email's draft to its currently published (live) version, discarding all unpublished changes; the email must have a live version to revert to.
Hubspot Restore A Revision Of A Marketing Email
Restores a specific, existing, non-active revision of a marketing email to become the new live version for that email.
Hubspot Restore Email Revision
Restores a specific revision of a marketing email to a draft state, overwriting any existing draft.
Hubspot Retrieve All Object Schemas
Retrieves all object schema definitions (not data records) for a hubspot account, supporting retrieval of either active or archived schemas.
Hubspot Retrieve All Pipelines
Deprecated: use `retrieve all pipelines for specified object type` instead. retrieves all pipelines in hubspot for a specified crm object type like deals or tickets.
Hubspot Retrieve All Pipelines For Specified Object Type
Retrieves all pipelines in hubspot for a specified crm object type, such as deals or tickets.
Hubspot Retrieve Batch Of Deals By Ids Or Property Values
Retrieves a batch of hubspot crm deals by their hubspot ids or values of a specified unique `idproperty`; `inputs` must contain at least one entry and `idproperty`, if used, must name a property that uniquely identifies deals.
Hubspot Retrieve Calling Settings For App
Retrieves the read-only calling extension settings for a specific hubspot app; the app must exist and have calling extensions configured.
Hubspot Retrieve Company Object By Id
Retrieves a specific hubspot company by its id (or an alternative unique property value if `idproperty` is specified), optionally including specific properties, property history, associated object ids, or archived records.
Hubspot Retrieve Deal By Id
Fetches a hubspot crm deal by its id, optionally including specific properties, their history, and associations; use `idproperty` for retrieval with a custom unique property.
Hubspot Retrieve Existing Object Schema
Fetches the detailed schema definition for a specified, existing standard or custom hubspot crm object type; this action is read-only and does not create or modify schemas.
Hubspot Retrieve Line Items List
Fetches a paginated list of hubspot crm line items, allowing selection of specific properties (including history), associated object ids, and filtering by archive status; ensure property and association names are valid hubspot internal names.
Hubspot Retrieve Line Item By Id
Retrieves a hubspot crm line item by its id or a specified unique property (`idproperty`).
Hubspot Retrieve Owners
Retrieves a list of all owners in the hubspot crm, including their id, first name, last name, email, and user id.
Hubspot Retrieve Owner By Id Or User Id
Retrieves a specific hubspot crm owner by their id, with options to specify id type (owner or user) and to include archived records.
Hubspot Retrieve Page Of Companies
Retrieves a paginated list of companies from hubspot, using an 'after' cursor from a previous response for subsequent pages.
Hubspot Retrieve Page Of Crm Owners
Retrieves a paginated list of crm owners from hubspot, optionally filtering by email or archived status.
Hubspot Retrieve Pipeline Stages
Fetches all stages for a specified hubspot crm object type and pipeline id.
Hubspot Retrieve Pipeline Stage By Id
Fetches detailed properties and metadata (e.g., label, display order, custom properties) for a specific stage within a hubspot crm pipeline, identified by its `objecttype`, `pipelineid`, and `stageid`.
Hubspot Retrieve Ticket By Id
Retrieves a hubspot ticket by its `ticketid` or by a unique `idproperty` (if `idproperty` is used, its values must be unique across all tickets), allowing customization of returned properties, property history, associations, and archived status.
Hubspot Retrieve Timeline Event By Ids
Retrieves a specific hubspot crm timeline event by its `eventtemplateid` (for an existing template) and `eventid` (for an existing event), returning event details which may not include full associated crm object data.
Hubspot Retrieve Video Conference Settings By Id
Retrieves video conference application settings, such as webhook urls and user/account management configurations, for a specified `appid`.
Hubspot Return Pipeline By Id
Retrieves a specific pipeline by its id and crm object type, detailing its stages and properties.
Hubspot Search Company Objects
Searches hubspot company objects using a text query, complex filter groups (anded within, ored between), sorting, and specific property selection, including custom properties.
Hubspot Search Contacts By Criteria
Searches for hubspot contacts using a text query, specific filter criteria (filters in a group are anded, groups are ored), sorting, and pagination to retrieve selected properties.
Hubspot Search Crm Email Objects
Searches crm email objects using full-text queries, complex filtering (filters within a group are or'd, groups are and'd), sorting, pagination, and property selection; ensure `propertyname` in filters is valid and filterable for emails.
Hubspot Search Crm Objects By Criteria
Searches hubspot crm objects (e.g., 'contacts', 'companies') by `objecttype` using complex criteria including filters, sorting, and pagination; property names used in filters, sorts, and returned properties must be valid for the specified `objecttype`.
Hubspot Search Deals By Criteria
Searches hubspot deals using complex criteria (text queries, property filters, sorting, pagination) for targeted retrieval beyond simple id lookups; ensure filter operator/value combinations are valid for the target hubspot property.
Hubspot Search Feedback Submissions
Searches for feedback submissions in hubspot crm using text query, filter groups, sorting, and pagination, returning specified properties.
Hubspot Search Line Items By Criteria
Searches hubspot line items using criteria including filters, sorting, and pagination; `after` must be a valid cursor from a previous response, and `sorts`/`properties` must refer to valid line item property names.
Hubspot Search Products By Criteria
Searches hubspot products using text queries, filters, and sorting by sortable properties, with options for pagination and specifying returned properties.
Hubspot Search Quotes By Criteria
Searches hubspot crm quotes using a text query, complex filter criteria, sorting, and pagination.
Hubspot Search Tickets By Criteria
Retrieves hubspot tickets by applying filters on properties, a full-text query, sort preferences, and pagination, allowing selection of specific fields to be returned.
Hubspot Secure Product Search By Criteria
Deprecated: searches hubspot products by criteria; use `search products by criteria` instead.
Hubspot Set Call Recording Settings
Configures the url (`urltoretrieveauthedrecording`) that hubspot uses to retrieve call recordings for a specified third-party calling app (`appid`), which must be an existing calling extension app integrated with the hubspot account.
Hubspot Update
Deprecated: partially updates an existing hubspot crm product, identified by `productid` (or a custom unique `idproperty`), by modifying specified `properties`; use 'update product' instead.
Hubspot Update A Batch Of Campaigns
Updates properties for up to 50 existing hubspot marketing campaigns in a single batch operation.
Hubspot Update A Batch Of Contacts
Updates specified properties for a batch of up to 100 hubspot contacts, identified by their vids; ensure property values use hubspot internal names and formats (e.g., for enums like 'lifecyclestage').
Hubspot Update A Batch Of Emails
Updates multiple hubspot email engagement records in a batch, identifying each by its hubspot object `id` (or an alternative unique property via `idproperty`) and setting new string values for specified properties (which must be valid internal email property names).
Hubspot Update A Batch Of Line Items
Updates a batch of existing hubspot crm line items in a single operation, identifying each by its primary id or a unique `idproperty` (which must be a unique identifier property in hubspot), and modifies their specified properties.
Hubspot Update A Marketing Email
Updates properties of an existing marketing email identified by its `emailid`; unspecified fields retain their current values.
Hubspot Update Batch Feedback Submissions
Updates a batch of hubspot feedback submissions; property keys must be existing internal hubspot names and values must be correctly formatted strings.
Hubspot Update Batch Of Companies
Updates specified properties for multiple existing hubspot companies in a batch, identifying each company by its hubspot id or by a unique property name in `idproperty` with its value in `id`.
Hubspot Update Batch Of Crmobjects Tickets
Batch updates properties for multiple hubspot crm tickets using a list of inputs, where each input specifies the ticket `id` and the `properties` to modify.
Hubspot Update Batch Of Deals
Updates properties for multiple existing hubspot crm deals in a batch; ensure property names are the internal hubspot names.
Hubspot Update Batch Of Objects By Idor Property Values
Performs a batch update on a valid `objecttype` where properties are writeable and any `idproperty` used is designated unique; updates can be partial.
Hubspot Update Batch Of Products
Updates multiple hubspot product records in a single batch; all properties to be updated must already exist in hubspot.
Hubspot Update Calling App Recording Settings
Updates the recording settings, such as the url for retrieving authenticated recordings, for a specific calling extension app identified by its `appid`.
Hubspot Update Campaign
Partially updates specific, writable properties of an existing hubspot marketing campaign identified by `campaignguid`; an empty string value in `properties` clears a property.
Hubspot Update Existing Event Template
Updates an existing hubspot event template's name, display templates, and tokens; providing `tokens` replaces the entire existing list, and the `id` in the request body must match `eventtemplateid` in the path.
Hubspot Update Existing Object Schema
Updates an existing custom object schema's metadata in hubspot, such as its description, labels, display properties, required properties, searchable properties, and restorability, for a specified `objecttype` that must already exist.
Hubspot Update Feedback Submission By Id
Partially updates writable properties of an existing hubspot feedback submission, identified by its `feedbacksubmissionid` (which can be an internal object id, or a unique property value if `idproperty` is specified).
Hubspot Update Line Item Object Partially
Partially updates specified properties of an existing hubspot line item, identified by `lineitemid` (as hubspot object id or value of `idproperty` if used); new values overwrite existing ones, and an empty string clears a property.
Hubspot Update Pipeline Stage By Ids
Partially updates a hubspot crm pipeline stage identified by `objecttype`, `pipelineid`, and `stageid`, requiring `metadata` in the request; unspecified fields are unchanged.
Hubspot Update Specific Crm Property
Updates attributes of an existing hubspot crm property, identified by its `objecttype` and `propertyname`; only provided fields are modified, and changing a property's `type` can cause data loss if incompatible with existing data.
Hubspot Update Token On Event Template
Updates the label or options of an existing token within a specified hubspot crm event template; token name and data type remain unchanged.
Hubspot Update Video Conference App Settings
Updates interaction urls (for creating/updating/deleting meetings, fetching accounts, verifying users) for a video conference application specified by `appid`; the application must exist and all urls must be valid and publicly accessible.