HubSpot

Tools

Name & DescriptionType
HUBSPOT_CREATE_BATCH_OF_TICKETCreates 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.
action
HUBSPOT_CREATE_PRODUCT_BATCHCreates 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.
action
HUBSPOT_CREATE_PRODUCT_OBJECTCreates 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.
action
HUBSPOT_GET_PIPELINE_STAGE_AUDITRetrieves 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.
action
HUBSPOT_LIST_PRODUCTS_WITH_PAGINGRetrieves a paginated list of products from HubSpot crm, optionally including specific properties, their history, associated object ids, and filtering by archived status.
action
HUBSPOT_UPDATE_PRODUCTPartially updates an existing HubSpot crm product, identified by `productid` (or a custom unique `idproperty`), by modifying only specified `properties`.
action
HUBSPOT_ADD_ASSET_ASSOCIATIONAssociates an existing asset ('form', 'object list', or 'external web url') with a specified HubSpot marketing campaign.
action
HUBSPOT_ADD_TOKEN_TO_EVENT_TEMPLATEAdds 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.
action
HUBSPOT_ARCHIVEArchives the HubSpot email specified by `emailid` by moving it to the recycling bin, making it inaccessible unless restored.
action
HUBSPOT_ARCHIVE_A_BATCH_OF_EMAILS_BY_IDArchives multiple HubSpot crm emails by id; ids must exist as archiving is irreversible.
action
HUBSPOT_ARCHIVE_A_BATCH_OF_QUOTES_BY_IDArchives a batch of existing, non-archived quotes by their ids; this action is irreversible and useful for managing outdated or irrelevant quotes.
action
HUBSPOT_ARCHIVE_BATCH_OF_COMPANIES_BY_IDArchives a batch of companies by their unique ids; targeted companies must exist, not be previously archived, and this API operation is irreversible.
action
HUBSPOT_ARCHIVE_BATCH_OF_CONTACTS_BY_IDArchives 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.
action
HUBSPOT_ARCHIVE_BATCH_OF_DEALS_BY_IDArchives a batch of existing deals by their unique HubSpot ids, removing them from active views and reports (soft delete); archived deals may be restorable.
action
HUBSPOT_ARCHIVE_BATCH_OF_FEEDBACK_SUBMISSIONS_BY_IDAsynchronously 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.
action
HUBSPOT_ARCHIVE_BATCH_OF_LINE_ITEMS_BY_IDArchives a batch of existing line items by their unique ids in HubSpot crm; this operation is irreversible via the API.
action
HUBSPOT_ARCHIVE_BATCH_OF_OBJECTS_BY_IDArchives a batch of existing, non-archived crm objects of a specified `objecttype` by their ids, effectively hiding them from active use.
action
HUBSPOT_ARCHIVE_BATCH_OF_PROPERTIESArchives a batch of properties by their internal names for a specified HubSpot crm object type; this operation is idempotent and safe to retry.
action
HUBSPOT_ARCHIVE_BATCH_OF_TICKETS_BY_IDArchives a batch of existing, unarchived HubSpot crm tickets by their unique ids.
action
HUBSPOT_ARCHIVE_BATCH_PRODUCTS_BY_IDArchives a batch of existing, unarchived HubSpot products by their ids; this action is irreversible via the API.
action
HUBSPOT_ARCHIVE_COMPANYArchives 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.
action
HUBSPOT_ARCHIVE_CONTACT_BY_IDArchives 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.
action
HUBSPOT_ARCHIVE_CRM_OBJECT_BY_IDArchives 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.
action
HUBSPOT_ARCHIVE_FEEDBACK_SUBMISSIONArchives an existing, non-archived feedback submission in HubSpot crm by its id, moving it to the recycling bin (not permanently deleting it).
action
HUBSPOT_ARCHIVE_LINE_ITEM_BY_IDArchives a specific HubSpot line item by its id, moving it to a recoverable state.
action
HUBSPOT_ARCHIVE_PRODUCT_BY_PRODUCT_IDArchives 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.
action
HUBSPOT_ARCHIVE_PROPERTY_BY_OBJECT_TYPE_AND_NAMEArchives 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.
action
HUBSPOT_ARCHIVE_PROPERTY_GROUPArchives a HubSpot property group, making it inactive and hidden (not permanently deleted, allowing potential restoration) with immediate effect on its crm visibility and usability.
action
HUBSPOT_ARCHIVE_QUOTE_OBJECT_BY_IDArchives a HubSpot quote object by id to the recycling bin; this is API-irreversible and may need manual restoration.
action
HUBSPOT_ARCHIVE_TICKET_BY_IDArchives an existing HubSpot ticket by its id, moving it to the recycling bin; this is a permanent operation not undoable via the API.
action
HUBSPOT_AUDIT_PIPELINE_CHANGES_BY_IDRetrieves 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.
action
HUBSPOT_BATCH_READ_COMPANIES_BY_PROPERTIESBatch-retrieves HubSpot company records by their ids, allowing custom id properties, specific properties to fetch, and historical data.
action
HUBSPOT_BATCH_UPDATE_QUOTESUpdates 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.
action
HUBSPOT_CAMPAIGN_SEARCHSearches for and retrieves a paginated list of HubSpot marketing campaigns.
action
HUBSPOT_CANCEL_ACTIVE_IMPORTCancels an active HubSpot data import job using its `importid`; this action is irreversible, and any data already processed will remain.
action
HUBSPOT_CLONE_MARKETING_EMAILDuplicates an existing HubSpot marketing email, identified by its `id`, into a new draft; an optional `clonename` can be assigned to this new email copy.
action
HUBSPOT_CONFIGURE_CALLING_EXTENSION_SETTINGSConfigures 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`.
action
HUBSPOT_CREATE**deprecated: use the `create product object` action instead.
action
HUBSPOT_CREATE_AB_TEST_VARIATIONCreates 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.
action
HUBSPOT_CREATE_AND_RETURN_A_NEW_PROPERTY_GROUPCreates 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.
action
HUBSPOT_CREATE_ASSOCIATION_FOR_OBJECT_TYPECreates 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.
action
HUBSPOT_CREATE_A_BATCH_OF_CAMPAIGNSCreates up to 50 marketing campaigns in a single batch operation.
action
HUBSPOT_CREATE_A_BATCH_OF_COMPANIESCreates multiple company records in HubSpot crm in a single batch operation, processing up to 100 companies per request.
action
HUBSPOT_CREATE_A_BATCH_OF_CONTACTSDeprecated: use the `create batch of contacts` action instead.
action
HUBSPOT_CREATE_A_BATCH_OF_EMAILSCreates 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.
action
HUBSPOT_CREATE_A_CAMPAIGNCreates a new marketing campaign in HubSpot with the specified properties, returning the created campaign data including its `campaignguid`.
action
HUBSPOT_CREATE_A_NEW_MARKETING_EMAILCreates 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.
action
HUBSPOT_CREATE_BATCH_OF_CONTACTSCreates up to 100 new contact records in HubSpot crm, optionally associating them with existing crm objects; ensure associated object ids are valid.
action
HUBSPOT_CREATE_BATCH_OF_DEALSCreates multiple deals in HubSpot crm; ensure any associated object ids, deal stages, and pipeline ids specified are valid and exist within the HubSpot account.
action
HUBSPOT_CREATE_BATCH_OF_FEEDBACK_SUBMISSIONSCreates 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.
action
HUBSPOT_CREATE_BATCH_OF_LINE_ITEMSCreates multiple HubSpot line items in a batch, each with specified properties and associations to other existing crm objects.
action
HUBSPOT_CREATE_BATCH_OF_OBJECTSCreates multiple crm objects of a specified `objecttype` (e.
action
HUBSPOT_CREATE_BATCH_OF_PROPERTIESEfficiently creates multiple crm properties in a single batch for a specified HubSpot object type (e.
action
HUBSPOT_CREATE_BATCH_OF_QUOTESCreates 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.
action
HUBSPOT_CREATE_COMPANY_OBJECTCreates a new company object in HubSpot crm with specified properties and associations, returning the new company object.
action
HUBSPOT_CREATE_CONTACT_OBJECT_WITH_PROPERTIESCreates a new HubSpot contact with specified properties and optional associations; requires at least one identifiable property (e.
action
HUBSPOT_CREATE_CRM_OBJECT_WITH_PROPERTIESCreates a new HubSpot crm object (e.
action
HUBSPOT_CREATE_EVENT_TEMPLATE_FOR_APPCreates 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.
action
HUBSPOT_CREATE_FEEDBACK_SUBMISSIONCreates a new HubSpot feedback submission to record customer feedback (e.
action
HUBSPOT_CREATE_LINE_ITEM_OBJECTCreates 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.
action
HUBSPOT_CREATE_MULTIPLE_TIMELINE_EVENTS_BATCHCreates 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.
action
HUBSPOT_CREATE_NEW_DEAL_OBJECTCreates a new deal in HubSpot crm with specified properties and associations; ensure `pipeline`, `dealstage`, and any `associations.
action
HUBSPOT_CREATE_NEW_OBJECT_SCHEMA_WITH_CUSTOM_PROPERTIESCreates 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).
action
HUBSPOT_CREATE_OR_UPDATE_DRAFT_VERSIONCreates 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.
action
HUBSPOT_CREATE_PIPELINE_FOR_OBJECT_TYPECreates a new HubSpot pipeline for a specified crm `objecttype` (e.
action
HUBSPOT_CREATE_PIPELINE_STAGECreates a new stage in a specified HubSpot crm pipeline for a given object type, such as 'deals' or 'tickets'.
action
HUBSPOT_CREATE_PROPERTY_FOR_SPECIFIED_OBJECT_TYPECreates a new custom property for a specified HubSpot crm object type; ensure `groupname` refers to an existing property group for the `objecttype`.
action
HUBSPOT_CREATE_QUOTE_OBJECTCreates a new quote object in HubSpot crm with specified properties and associations.
action
HUBSPOT_CREATE_TICKET_OBJECTCreates 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.
action
HUBSPOT_CREATE_TIMELINE_EVENT_BASED_ON_TEMPLATECreates 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.
action
HUBSPOT_CREATE_WORKFLOWCreates a new HubSpot workflow to automate processes; ensure `enrollmentcriteria` and `actions` use properties relevant to the specified `objecttypeid`.
action
HUBSPOT_CUSTOMIZABLE_CONTACTS_PAGE_RETRIEVALDeprecated: use 'list contacts page' to retrieve a paginated list of HubSpot contacts.
action
HUBSPOT_DELETE_A_BATCH_OF_CAMPAIGNSArchives a batch of up to 50 marketing campaigns, hiding them from active views rather than permanently deleting them.
action
HUBSPOT_DELETE_A_MARKETING_EMAILDeletes an existing marketing email, either permanently (default) or by archiving if `archived` is `true`.
action
HUBSPOT_DELETE_CALLING_EXTENSION_SETTINGSPermanently deletes the settings for a calling extension app, specified by its `appid`, rendering it unusable for all connected HubSpot accounts; this operation is irreversible.
action
HUBSPOT_DELETE_CAMPAIGNPermanently deletes a marketing campaign from HubSpot using its `campaignguid`; returns a 204 no content status even if the campaign does not exist.
action
HUBSPOT_DELETE_CONTACT_FOR_GDPR_COMPLIANCEIrreversibly deletes a HubSpot contact for gdpr compliance (identified via `objectid` and `idproperty`); an email `objectid` for a non-existent contact may be blocklisted.
action
HUBSPOT_DELETE_PIPELINE_BY_IDPermanently 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.
action
HUBSPOT_DELETE_PIPELINE_STAGE_BY_IDPermanently deletes a specific pipeline stage for an `objecttype` (e.
action
HUBSPOT_DELETE_SCHEMA_BY_OBJECT_TYPEPermanently deletes a HubSpot custom object schema, specified by its `objecttype`, after all associated crm records have been deleted.
action
HUBSPOT_DELETE_TIMELINE_EVENT_TEMPLATEPermanently and irreversibly deletes a specific timeline event template, identified by its `eventtemplateid`, from the application `appid`.
action
HUBSPOT_DELETE_VIDEO_CONFERENCING_APP_SETTINGSIrreversibly 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.
action
HUBSPOT_DELETE_WORKFLOWPermanently deletes a HubSpot workflow by its id; deleted workflows cannot be restored via the API and the id must exist.
action
HUBSPOT_FETCH_CONTACT_DETAILS_BY_IDDeprecated: use `read crm contact by id` instead.
action
HUBSPOT_FETCH_CONTACT_IDSFetches HubSpot contact ids for a specified `campaignguid` (must be a valid uuid of an existing campaign) and `contacttype`, supporting date filtering and pagination.
action
HUBSPOT_FETCH_IMPORT_ERROR_DETAILSFetches a paginated list of read-only error details for a specific HubSpot crm import, requiring a valid `importid` for a processed import.
action
HUBSPOT_FETCH_OBJECT_DETAILS_BY_ID_OR_PROPERTYDeprecated: use the 'retrieve line item by id' action instead.
action
HUBSPOT_FETCH_RECORDING_SETTINGS_BY_APP_IDFetches call recording settings for a specified, existing HubSpot calling extension app.
action
HUBSPOT_FETCH_REVENUEFetches 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`.
action
HUBSPOT_GDPR_DELETEPermanently 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.
action
HUBSPOT_GET_ACTIVE_IMPORTS_LISTRetrieves a list of currently active import jobs in HubSpot for monitoring ongoing data operations.
action
HUBSPOT_GET_AGGREGATED_STATISTICSRetrieves aggregated statistics for marketing emails, optionally within an iso8601 formatted time range, by email ids, or specific email properties.
action
HUBSPOT_GET_AGGREGATED_STATISTIC_INTERVALSRetrieves aggregated statistics for marketing emails (e.
action
HUBSPOT_GET_ALL_MARKETING_EMAILS_FOR_A_HUB_SPOT_ACCOUNTFetches a list of marketing emails from a HubSpot account, with options for filtering, sorting, pagination, and including performance statistics.
action
HUBSPOT_GET_ALL_WORKFLOWSRetrieves a list of workflow summaries (id, name, type, status) from HubSpot, using the 'limit' parameter for pagination.
action
HUBSPOT_GET_A_PAGE_OF_OWNERSRetrieves a paginated list of crm owners from HubSpot, optionally filtering by email or archived status.
action
HUBSPOT_GET_A_REVISION_OF_A_MARKETING_EMAILRetrieves a specific, previously saved revision of a marketing email using its unique email id and revision id.
action
HUBSPOT_GET_CAMPAIGN_METRICSRetrieves key attribution metrics for an existing marketing campaign, identified by its `campaignguid`, within an optional date range.
action
HUBSPOT_GET_DRAFT_VERSION_OF_A_MARKETING_EMAILRetrieves the draft version of a marketing email by its `emailid`; if no draft exists, returns the published version.
action
HUBSPOT_GET_IMPORT_RECORD_INFORMATIONRetrieves 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.
action
HUBSPOT_GET_MARKETING_EMAILSFetches a list of marketing emails from HubSpot, supporting filtering by creation/update timestamps, pagination, and sorting.
action
HUBSPOT_GET_QUOTE_BY_IDRetrieves a specific HubSpot quote by its unique identifier.
action
HUBSPOT_GET_REVISIONS_OF_A_MARKETING_EMAILRetrieves 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.
action
HUBSPOT_GET_SPECIFIC_EVENT_TEMPLATE_FOR_APPRetrieves detailed information about a specific event template for a given application in HubSpot's crm timeline.
action
HUBSPOT_GET_THE_DETAILS_OF_A_SPECIFIED_MARKETING_EMAILRetrieves detailed information for a specific marketing email in HubSpot using its unique email id, optionally including performance statistics and specific properties.
action
HUBSPOT_GET_THE_VARIATION_OF_A_AN_A_B_MARKETING_EMAILRetrieves the alternate variation of a specified a/b marketing email; the `emailid` must identify an email currently in an a/b test.
action
HUBSPOT_GET_WORKFLOW_BY_IDRetrieves comprehensive details for an existing HubSpot workflow by its unique id; unsupported actions are designated 'unsupported action' in the response.
action
HUBSPOT_GET_WORKFLOW_EMAIL_CAMPAIGNSRetrieves email campaigns associated with a specific HubSpot workflow id.
action
HUBSPOT_INITIATE_DATA_IMPORT_PROCESSCall 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.
action
HUBSPOT_INSTANTIATE_AND_RETURN_NEW_COMPANY_OBJECTDeprecated: creates a new HubSpot crm company object with given properties and associations; use create company object instead.
action
HUBSPOT_LISTRetrieves a paginated list of HubSpot emails, allowing selection of specific properties (with or without history), associated object ids, and filtering by archive status.
action
HUBSPOT_LIST_ALL_EVENT_TEMPLATES_FOR_APPRetrieves all event templates associated with a valid `appid` for an existing application in HubSpot's crm timeline.
action
HUBSPOT_LIST_ASSETSLists assets of a specific `assettype` for a given HubSpot marketing `campaignguid`, optionally including performance metrics for a date range.
action
HUBSPOT_LIST_ASSOCIATION_TYPESLists all valid association types between two specified HubSpot crm object types.
action
HUBSPOT_LIST_CONTACTS_PAGERetrieves a paginated list of HubSpot contacts, optionally specifying properties, historical values, and associations; ensure provided property and association names are valid HubSpot internal names.
action
HUBSPOT_LIST_FEEDBACK_SUBMISSIONS_PAGERetrieves a paginated list of feedback submissions from HubSpot, allowing specification of properties (including history), associated object ids, and filtering by archive status.
action
HUBSPOT_LIST_PAGE_OF_TICKETSRetrieves 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.
action
HUBSPOT_LIST_QUOTES_PAGERetrieves a paginated list of quotes, allowing selection of specific properties, property history, associated object ids, and filtering by archived status.
action
HUBSPOT_MERGE_TWO_COMPANIES_OF_SAME_TYPEMerges two existing company records of the same type in HubSpot crm, where `objectidtomerge` is absorbed into `primaryobjectid`; this operation is irreversible.
action
HUBSPOT_MERGE_TWO_CONTACTS_OF_SAME_TYPEMerges 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.
action
HUBSPOT_MERGE_TWO_DEALS_OF_SAME_TYPEPermanently merges two HubSpot crm deals of the same type, typically to eliminate duplicates or consolidate related sales opportunities.
action
HUBSPOT_MERGE_TWO_EMAILS_WITH_SAME_TYPEMerges two existing, same-type HubSpot crm emails: `objectidtomerge` is absorbed into `primaryobjectid` and then deleted; use for de-duplication, this action is irreversible.
action
HUBSPOT_MERGE_TWO_FEEDBACK_SUBMISSIONSMerges two existing feedback submissions by id, primarily for consolidating duplicates or related feedback; this operation is irreversible, and `primaryobjectid` values take precedence in conflicts.
action
HUBSPOT_MERGE_TWO_LINE_ITEMS_OF_SAME_TYPEMerges two line items, `objectidtomerge` into `primaryobjectid`, which must be of the same type; `objectidtomerge` is absorbed and the operation is irreversible.
action
HUBSPOT_MERGE_TWO_OBJECTS_OF_SAME_TYPEMerges 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.
action
HUBSPOT_MERGE_TWO_PRODUCTS_OF_THE_SAME_TYPETo 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.
action
HUBSPOT_MERGE_TWO_QUOTES_OF_SAME_TYPEMerges two distinct quotes of the same type by consolidating `objectidtomerge` into `primaryobjectid` (e.
action
HUBSPOT_MERGE_TWO_TICKETS_OF_SAME_TYPEMerges two existing HubSpot tickets of the same type, where `objectidtomerge` (which is then deactivated) is absorbed into `primaryobjectid`.
action
HUBSPOT_MODIFY_CALLING_EXTENSION_SETTINGSUpdates settings (e.
action
HUBSPOT_PARTIALLY_UPDATE_CONTACT_USING_CONTACT_IDPartially updates specified properties for an existing HubSpot contact, identified by its valid `contactid`.
action
HUBSPOT_PARTIALLY_UPDATE_CRM_OBJECT_BY_IDPartially updates specified properties of a crm object (e.
action
HUBSPOT_PARTIALLY_UPDATE_DEAL_BY_IDPartially updates specified properties of an existing HubSpot crm deal, identified by its `dealid` or an optional custom unique `idproperty`.
action
HUBSPOT_PARTIALLY_UPDATE_PIPELINE_BY_IDPartially updates a crm pipeline's label, display order, or restores an archived pipeline by setting `archived` to `false`.
action
HUBSPOT_PARTIALLY_UPDATE_PROPERTY_GROUPPartially updates a property group's `displayorder` or `label` for a specified crm `objecttype` in HubSpot.
action
HUBSPOT_PARTIALLY_UPDATE_TICKET_BY_IDModifies 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.
action
HUBSPOT_PARTIAL_UPDATE_COMPANY_OBJECT_BY_IDPartially 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.
action
HUBSPOT_PARTIAL_UPDATE_QUOTE_BY_QUOTE_IDPerforms 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).
action
HUBSPOT_PERMANENTLY_DELETE_COMPANY_FOR_GDPR_COMPLIANCEPermanently 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.
action
HUBSPOT_PERMANENTLY_DELETE_CONTACT_FOR_GDPRIrreversibly deletes a HubSpot contact for gdpr; if deleting by a non-existent email (using idproperty 'email'), the email is blocklisted instead.
action
HUBSPOT_PERMANENTLY_DELETE_CONTACT_FOR_GDPR_COMPLIANCEIrreversibly erases a HubSpot contact and associated data per a gdpr request; if an email is given for a non-existent contact, it's blocklisted.
action
HUBSPOT_PERMANENTLY_DELETE_CONTACT_GDPR_COMPLIANCEPermanently and irreversibly deletes a HubSpot **quote** (not a contact, despite the action's internal naming) to comply with gdpr's 'right to be forgotten'.
action
HUBSPOT_PERMANENTLY_DELETE_CONTACT_VIA_GDPRPermanently deletes a HubSpot contact and all its associated data for gdpr compliance, identifying the contact by its id or another unique property.
action
HUBSPOT_PERMANENTLY_DELETE_DEAL_FOR_GDPR_COMPLIANCEPermanently 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`.
action
HUBSPOT_PERMANENTLY_DELETE_GDPR_CONTACT_AND_CONTENTPermanently and irreversibly deletes an existing HubSpot contact and associated content for gdpr compliance, optionally blocklisting the contact's email.
action
HUBSPOT_PERMANENTLY_DELETE_LINE_ITEMS_FOR_GDPRPermanently deletes a specified line item and its associated content for gdpr compliance; this action is irreversible and cannot be undone.
action
HUBSPOT_PUBLISH_MARKETING_EMAILPublishes or sends a specified HubSpot marketing email that is valid and ready for sending; requires marketing hub enterprise or the transactional email add-on.
action
HUBSPOT_PURGE_SCHEMA_BY_OBJECT_TYPEPermanently and irreversibly deletes the schema for an existing `objecttype` in HubSpot crm; this deprecated endpoint should be used with extreme caution.
action
HUBSPOT_READDeprecated: use `read product by id` instead.
action
HUBSPOT_READ_ALL_PROPERTIESDeprecated: use `read all properties for object type` instead.
action
HUBSPOT_READ_ALL_PROPERTIES_FOR_OBJECT_TYPERetrieves definitions and metadata (not actual values) for properties of a specified HubSpot crm object type (e.
action
HUBSPOT_READ_ALL_PROPERTY_GROUPSRetrieves all property groups for a specified HubSpot crm object type.
action
HUBSPOT_READ_AN_OWNER_BY_GIVEN_ID_OR_USER_ID**deprecated:** please use the `retrieve owner by id or user id` action instead.
action
HUBSPOT_READ_APAGE_OF_OBJECTS_BY_TYPERetrieves a paginated list of objects for a specified and valid HubSpot crm object type (e.
action
HUBSPOT_READ_A_BATCH_OF_CAMPAIGNSRetrieves 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.
action
HUBSPOT_READ_A_BATCH_OF_CRM_OBJECT_PROPERTIESReads definitions (metadata, not values) for a batch of crm object properties for a specified `objecttype`, supporting partial success.
action
HUBSPOT_READ_A_CAMPAIGNRetrieves details for a marketing campaign by `campaignguid`, optionally including specified `properties` and asset metrics if both `startdate` and `enddate` are provided.
action
HUBSPOT_READ_A_CRM_PROPERTY_BY_NAMEReads a specific crm property definition for a given HubSpot object type by its internal name.
action
HUBSPOT_READ_A_PAGE_OF_DEALSRetrieves a paginated list of HubSpot crm deals; use the 'after' token from a previous response's 'paging.
action
HUBSPOT_READ_A_PROPERTYDeprecated: use `read a crm property by name` to read a specific crm property definition for a given HubSpot object type by its internal name.
action
HUBSPOT_READ_A_PROPERTY_GROUPRetrieves 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.
action
HUBSPOT_READ_BATCH_EMAILSRetrieves a batch of HubSpot email objects by their internal ids or values of a specified unique property, allowing targeted property selection, including historical data.
action
HUBSPOT_READ_BATCH_FEEDBACK_SUBMISSIONS_BY_ID_OR_PROPERTYRetrieves up to 100 feedback submissions in a batch using their ids or a specified unique `idproperty`, optionally including specified properties and their history.
action
HUBSPOT_READ_BATCH_OF_CONTACTS_BY_ID_OR_PROPERTIESReads 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.
action
HUBSPOT_READ_BATCH_OF_CRM_OBJECTS_BY_ID_OR_PROPERTY_VALUESReads 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.
action
HUBSPOT_READ_BATCH_OF_LINE_ITEMS_BY_ID_OR_PROPERTY_VALUESRetrieves a batch of HubSpot crm line items by their ids, or optionally by values of a custom unique property defined in `idproperty`.
action
HUBSPOT_READ_BATCH_OF_PRODUCTS_BY_ID_OR_PROPERTYRetrieves 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.
action
HUBSPOT_READ_BATCH_OF_QUOTES_BY_PROPERTY_VALUESEfficiently retrieves a batch of HubSpot crm quotes by their ids (or a specified unique property), optionally including archived quotes, specific properties, and property history.
action
HUBSPOT_READ_BATCH_OF_TICKETS_BY_ID_OR_UNIQUE_VALUESRetrieves 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.
action
HUBSPOT_READ_BUDGETFetches detailed budget (total, spent, remaining) and spend information for a marketing campaign, including an 'order' field for sequencing budget/spend items (0 is oldest).
action
HUBSPOT_READ_CRM_CONTACT_BY_IDRetrieves a HubSpot crm contact by its unique internal HubSpot id, allowing selection of properties, historical values, associated objects, and filtering for archived contacts.
action
HUBSPOT_READ_CRM_OBJECT_BY_IDRetrieves a specific crm object (e.
action
HUBSPOT_READ_FEEDBACK_SUBMISSION_BY_IDReads a HubSpot feedback submission by its id, optionally using a custom unique 'idproperty', and allows specifying properties to return including history and associations.
action
HUBSPOT_READ_PRODUCT_BY_IDRetrieves 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.
action
HUBSPOT_READ_PROPERTY_GROUPS_FOR_OBJECT_TYPERetrieves all property groups in a single call for a specified HubSpot crm object type (e.
action
HUBSPOT_RECYCLE_CONTACT_BY_IDDeprecated: use the `archive contact by id` action to archive a HubSpot crm contact by its id.
action
HUBSPOT_REMOVE_ASSET_ASSOCIATIONDisassociates an asset (form, object list, or external web url) from a HubSpot campaign.
action
HUBSPOT_REMOVE_ASSOCIATION_FROM_SCHEMAPermanently removes a specified association definition (type) from a HubSpot object's schema, preventing future creations of this association type without affecting existing instances.
action
HUBSPOT_REMOVE_DEAL_OBJECT_BY_IDArchives 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.
action
HUBSPOT_REMOVE_TOKEN_FROM_EVENT_TEMPLATERemoves a token from a HubSpot event template, preventing its inclusion in new events created from that template.
action
HUBSPOT_RENDER_EVENT_DETAIL_TEMPLATERenders 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.
action
HUBSPOT_RENDER_EVENT_HEADER_OR_DETAIL_AS_HTMLRenders 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.
action
HUBSPOT_REPLACE_ALL_PROPERTIES_OF_PIPELINEOverwrites an entire crm pipeline (specified by `objecttype` and `pipelineid`) and all its stages with a new definition, returning the updated pipeline.
action
HUBSPOT_REPLACE_PIPELINE_STAGE_PROPERTIESReplaces 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.
action
HUBSPOT_RESET_DRAFTResets 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.
action
HUBSPOT_RESTORE_A_REVISION_OF_A_MARKETING_EMAILRestores a specific, existing, non-active revision of a marketing email to become the new live version for that email.
action
HUBSPOT_RESTORE_EMAIL_REVISIONRestores a specific revision of a marketing email to a draft state, overwriting any existing draft.
action
HUBSPOT_RETRIEVE_ALL_OBJECT_SCHEMASRetrieves all object schema definitions (not data records) for a HubSpot account, supporting retrieval of either active or archived schemas.
action
HUBSPOT_RETRIEVE_ALL_PIPELINESDeprecated: use `retrieve all pipelines for specified object type` instead.
action
HUBSPOT_RETRIEVE_ALL_PIPELINES_FOR_SPECIFIED_OBJECT_TYPERetrieves all pipelines in HubSpot for a specified crm object type, such as deals or tickets.
action
HUBSPOT_RETRIEVE_BATCH_OF_DEALS_BY_IDS_OR_PROPERTY_VALUESRetrieves 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.
action
HUBSPOT_RETRIEVE_CALLING_SETTINGS_FOR_APPRetrieves the read-only calling extension settings for a specific HubSpot app; the app must exist and have calling extensions configured.
action
HUBSPOT_RETRIEVE_COMPANY_OBJECT_BY_IDRetrieves 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.
action
HUBSPOT_RETRIEVE_DEAL_BY_IDFetches a HubSpot crm deal by its id, optionally including specific properties, their history, and associations; use `idproperty` for retrieval with a custom unique property.
action
HUBSPOT_RETRIEVE_EXISTING_OBJECT_SCHEMAFetches 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.
action
HUBSPOT_RETRIEVE_LINE_ITEMS_LISTFetches 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.
action
HUBSPOT_RETRIEVE_LINE_ITEM_BY_IDRetrieves a HubSpot crm line item by its id or a specified unique property (`idproperty`).
action
HUBSPOT_RETRIEVE_OWNERSRetrieves a list of all owners in the HubSpot crm, including their id, first name, last name, email, and user id.
action
HUBSPOT_RETRIEVE_OWNER_BY_ID_OR_USER_IDRetrieves a specific HubSpot crm owner by their id, with options to specify id type (owner or user) and to include archived records.
action
HUBSPOT_RETRIEVE_PAGE_OF_COMPANIESRetrieves a paginated list of companies from HubSpot, using an 'after' cursor from a previous response for subsequent pages.
action
HUBSPOT_RETRIEVE_PAGE_OF_CRM_OWNERSRetrieves a paginated list of crm owners from HubSpot, optionally filtering by email or archived status.
action
HUBSPOT_RETRIEVE_PIPELINE_STAGESFetches all stages for a specified HubSpot crm object type and pipeline id.
action
HUBSPOT_RETRIEVE_PIPELINE_STAGE_BY_IDFetches detailed properties and metadata (e.
action
HUBSPOT_RETRIEVE_TICKET_BY_IDRetrieves 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.
action
HUBSPOT_RETRIEVE_TIMELINE_EVENT_BY_IDSRetrieves 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.
action
HUBSPOT_RETRIEVE_VIDEO_CONFERENCE_SETTINGS_BY_IDRetrieves video conference application settings, such as webhook urls and user/account management configurations, for a specified `appid`.
action
HUBSPOT_RETURN_PIPELINE_BY_IDRetrieves a specific pipeline by its id and crm object type, detailing its stages and properties.
action
HUBSPOT_SEARCH_COMPANY_OBJECTSSearches HubSpot company objects using a text query, complex filter groups (anded within, ored between), sorting, and specific property selection, including custom properties.
action
HUBSPOT_SEARCH_CONTACTS_BY_CRITERIASearches 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.
action
HUBSPOT_SEARCH_CRM_EMAIL_OBJECTSSearches 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.
action
HUBSPOT_SEARCH_CRM_OBJECTS_BY_CRITERIASearches HubSpot crm objects (e.
action
HUBSPOT_SEARCH_DEALS_BY_CRITERIASearches 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.
action
HUBSPOT_SEARCH_FEEDBACK_SUBMISSIONSSearches for feedback submissions in HubSpot crm using text query, filter groups, sorting, and pagination, returning specified properties.
action
HUBSPOT_SEARCH_LINE_ITEMS_BY_CRITERIASearches 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.
action
HUBSPOT_SEARCH_PRODUCTS_BY_CRITERIASearches HubSpot products using text queries, filters, and sorting by sortable properties, with options for pagination and specifying returned properties.
action
HUBSPOT_SEARCH_QUOTES_BY_CRITERIASearches HubSpot crm quotes using a text query, complex filter criteria, sorting, and pagination.
action
HUBSPOT_SEARCH_TICKETS_BY_CRITERIARetrieves HubSpot tickets by applying filters on properties, a full-text query, sort preferences, and pagination, allowing selection of specific fields to be returned.
action
HUBSPOT_SECURE_PRODUCT_SEARCH_BY_CRITERIADeprecated: searches HubSpot products by criteria; use `search products by criteria` instead.
action
HUBSPOT_SET_CALL_RECORDING_SETTINGSConfigures 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.
action
HUBSPOT_UPDATEDeprecated: partially updates an existing HubSpot crm product, identified by `productid` (or a custom unique `idproperty`), by modifying specified `properties`; use 'update product' instead.
action
HUBSPOT_UPDATE_A_BATCH_OF_CAMPAIGNSUpdates properties for up to 50 existing HubSpot marketing campaigns in a single batch operation.
action
HUBSPOT_UPDATE_A_BATCH_OF_CONTACTSUpdates 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.
action
HUBSPOT_UPDATE_A_BATCH_OF_EMAILSUpdates 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).
action
HUBSPOT_UPDATE_A_BATCH_OF_LINE_ITEMSUpdates 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.
action
HUBSPOT_UPDATE_A_MARKETING_EMAILUpdates properties of an existing marketing email identified by its `emailid`; unspecified fields retain their current values.
action
HUBSPOT_UPDATE_BATCH_FEEDBACK_SUBMISSIONSUpdates a batch of HubSpot feedback submissions; property keys must be existing internal HubSpot names and values must be correctly formatted strings.
action
HUBSPOT_UPDATE_BATCH_OF_COMPANIESUpdates 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`.
action
HUBSPOT_UPDATE_BATCH_OF_CRMOBJECTS_TICKETSBatch updates properties for multiple HubSpot crm tickets using a list of inputs, where each input specifies the ticket `id` and the `properties` to modify.
action
HUBSPOT_UPDATE_BATCH_OF_DEALSUpdates properties for multiple existing HubSpot crm deals in a batch; ensure property names are the internal HubSpot names.
action
HUBSPOT_UPDATE_BATCH_OF_OBJECTS_BY_IDOR_PROPERTY_VALUESPerforms a batch update on a valid `objecttype` where properties are writeable and any `idproperty` used is designated unique; updates can be partial.
action
HUBSPOT_UPDATE_BATCH_OF_PRODUCTSUpdates multiple HubSpot product records in a single batch; all properties to be updated must already exist in HubSpot.
action
HUBSPOT_UPDATE_CALLING_APP_RECORDING_SETTINGSUpdates the recording settings, such as the url for retrieving authenticated recordings, for a specific calling extension app identified by its `appid`.
action
HUBSPOT_UPDATE_CAMPAIGNPartially updates specific, writable properties of an existing HubSpot marketing campaign identified by `campaignguid`; an empty string value in `properties` clears a property.
action
HUBSPOT_UPDATE_EXISTING_EVENT_TEMPLATEUpdates 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.
action
HUBSPOT_UPDATE_EXISTING_OBJECT_SCHEMAUpdates 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.
action
HUBSPOT_UPDATE_FEEDBACK_SUBMISSION_BY_IDPartially 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).
action
HUBSPOT_UPDATE_LINE_ITEM_OBJECT_PARTIALLYPartially 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.
action
HUBSPOT_UPDATE_PIPELINE_STAGE_BY_IDSPartially updates a HubSpot crm pipeline stage identified by `objecttype`, `pipelineid`, and `stageid`, requiring `metadata` in the request; unspecified fields are unchanged.
action
HUBSPOT_UPDATE_SPECIFIC_CRM_PROPERTYUpdates 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.
action
HUBSPOT_UPDATE_TOKEN_ON_EVENT_TEMPLATEUpdates the label or options of an existing token within a specified HubSpot crm event template; token name and data type remain unchanged.
action
HUBSPOT_UPDATE_VIDEO_CONFERENCE_APP_SETTINGSUpdates 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.
action
HUBSPOT_CONTACT_CREATED_TRIGGERContact Created Trigger.
trigger
HUBSPOT_DEAL_STAGE_UPDATED_TRIGGERDeal Stage Updated Trigger.
trigger

Details

Installs

More than 1000

Actions

240

Triggers

2

Category

CRM

Website

https://hubspot.com