253 things your agent can do in 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.

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.

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.

Fetch recording settings by app ID

Fetches call recording settings for a specified, existing hubspot calling extension app.

Fetch revenue

Fetches a revenue attribution report for a specified, existing marketing campaign, optionally using a specific attribution model and date range; if both start and end dates are given, `enddate` must…

Get active imports list

Retrieves a list of currently active import jobs in hubspot for monitoring ongoing data operations.

Get aggregated statistics

Retrieves aggregated statistics for marketing emails, optionally within an iso8601 formatted time range, by email ids, or specific email properties.

Get aggregated statistic intervals

Retrieves aggregated statistics for marketing emails (e.g., send counts), grouped by specified time intervals within a defined time range.

Get all marketing emails for a HubSpot account

Fetches a list of marketing emails from a hubspot account, with options for filtering, sorting, pagination, and including performance statistics.

Get all workflows

Retrieves a list of workflow summaries (id, name, type, status) from hubspot, using the 'limit' parameter for pagination.

Get campaign

Retrieves a hubspot campaign by its id.

Get campaigns

Retrieves multiple hubspot campaigns.

Get campaign metrics

Retrieves key attribution metrics for an existing marketing campaign, identified by its `campaignguid`, within an optional date range.

Get emails

Retrieves multiple hubspot emails by their ids.

Get Marketing Emails

Fetches a list of marketing emails from hubspot, supporting filtering by creation/update timestamps, pagination, and sorting.

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.

Get product

Retrieves a hubspot product by its id.

Get products

Retrieves multiple hubspot products by their ids.

Get quote by id

Retrieves a specific hubspot quote by its unique identifier.

Get ticket

Retrieves a hubspot ticket by its id.

Get tickets

Retrieves multiple hubspot tickets by their ids.

Get workflow by ID

Retrieves comprehensive details for an existing hubspot workflow by its unique id; unsupported actions are designated 'unsupported action' in the response.

Get company

Retrieves a hubspot company by its id.

Get contact IDs

Gets hubspot contact ids for a specified campaign and contact interaction type.

Get deal

Retrieves a hubspot deal by its id.

Get deals

Retrieves multiple hubspot deals by their ids.

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.

List companies

Retrieves a paginated list of hubspot companies.

List contacts

Retrieves a paginated list of hubspot contacts.

List deals

Retrieves a paginated list of hubspot deals.

Read contact

Retrieves a hubspot contact by its id.

Read contacts

Reads multiple hubspot contacts by their ids.

Search companies

Searches for hubspot companies using flexible criteria and filters.

Search deals

Searches for hubspot deals using flexible criteria and filters.

List Emails

Retrieves a paginated list of hubspot emails, allowing selection of specific properties (with or without history), associated object ids, and filtering by archive status.

List assets

Lists assets of a specific `assettype` for a given hubspot marketing `campaignguid`, optionally including performance metrics for a date range.

List association types

Lists all valid association types between two specified hubspot crm object types.

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

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.

List quotes page

Retrieves a paginated list of quotes, allowing selection of specific properties, property history, associated object ids, and filtering by archived status.

List tickets

Retrieves a paginated list of hubspot tickets.

Read all properties for object type

Retrieves definitions and metadata (not actual values) for properties of a specified hubspot crm object type (e.g., 'contacts', 'companies', 'deals', or custom objects).

Read a page of objects by type

Retrieves a paginated list of objects for a specified and valid hubspot crm object type (e.g., 'contacts', 'companies', 'deals', or custom id).

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

Read a CRM property by name

Reads a specific crm property definition for a given hubspot object type by its internal name.

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.

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.

Read batch feedback submissions by id or property

Retrieves up to 100 feedback submissions in a batch using their ids or a specified unique `idproperty`, optionally including specified properties and their history.

Read batch of 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 a…

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…

Read batch of line items by id or property values

Retrieves a batch of hubspot crm line items by their ids, or optionally by values of a custom unique property defined in `idproperty`.

Read batch of quotes by property values

Efficiently retrieves a batch of hubspot crm quotes by their ids (or a specified unique property), optionally including archived quotes, specific properties, and property history.

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

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.

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.

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.

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.

Retrieve all object schemas

Retrieves all object schema definitions (not data records) for a hubspot account, supporting retrieval of either active or archived schemas.

Retrieve all pipelines for specified object type

Retrieves all pipelines in hubspot for a specified crm object type, such as deals or tickets.

Retrieve a 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…

Retrieve calling settings for app

Retrieves the read-only calling extension settings for a specific hubspot app; the app must exist and have calling extensions configured.

Retrieve 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 id…

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.

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.

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

Retrieve line item by id

Retrieves a hubspot crm line item by its id or a specified unique property (`idproperty`).

Retrieve owners

Retrieves a list of all owners in the hubspot crm, including their id, first name, last name, email, and user id.

Retrieve owner by ID or user ID

Retrieves a specific hubspot crm owner by their id, with options to specify id type (owner or user) and to include archived records.

Retrieve page of companies

Retrieves a paginated list of companies from hubspot, using an 'after' cursor from a previous response for subsequent pages.

Retrieve page of crm owners

Retrieves a paginated list of crm owners from hubspot, optionally filtering by email or archived status.

Retrieve pipeline stages

Fetches all stages for a specified hubspot crm object type and pipeline id.

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…

Retrieve video conference settings by id

Retrieves video conference application settings, such as webhook urls and user/account management configurations, for a specified `appid`.

Search campaigns

Searches for hubspot campaigns.

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

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.

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

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

Search emails

Searches for hubspot emails using flexible criteria and filters.

Search feedback submissions

Searches for feedback submissions in hubspot crm using text query, filter groups, sorting, and pagination, returning specified properties.

Search line items by criteria

Searches hubspot line items using criteria including filters, sorting, and pagination; `after` must be a valid cursor from a previous response, and `sorts`/`properties` must refer to valid line item…

Search products

Searches for hubspot products using flexible criteria and filters.

Search quotes by criteria

Searches hubspot crm quotes using a text query, complex filter criteria, sorting, and pagination.

Search tickets

Searches for hubspot tickets using flexible criteria and filters.

Add asset association

Associates an existing asset ('form', 'object list', or 'external web url') with a specified hubspot marketing campaign.

Archive email

Archives the hubspot email specified by `emailid` by moving it to the recycling bin, making it inaccessible unless restored.

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.

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.

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.

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.

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

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.

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.

Archive batch of properties

Archives a batch of properties by their internal names for a specified hubspot crm object type; this operation is idempotent and safe to retry.

Archive company

Archives an existing company in hubspot crm by its `companyid`, moving it to a recycling bin from which it can be restored, rather than permanently deleting it.

Archive contact 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.

Archive a 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.

Archive emails

Archives multiple hubspot emails by their ids.

Archive feedback submission

Archives an existing, non-archived feedback submission in hubspot crm by its id, moving it to the recycling bin (not permanently deleting it).

Archive line item by id

Archives a specific hubspot line item by its id, moving it to a recoverable state.

Archive product

Archives a hubspot product by its id.

Archive products

Archives multiple hubspot products by their ids.

Archive property by object type and name

Archives a specified crm property by its object type and name, moving it to the recycling bin; note that some default hubspot properties cannot be archived.

Archive property group

Archives a hubspot property group, making it inactive and hidden (not permanently deleted, allowing potential restoration) with immediate effect on its crm visibility and usability.

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.

Archive ticket

Archives a hubspot ticket by its id.

Archive tickets

Archives multiple hubspot tickets by their ids.

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.

Cancel active import

Cancels an active hubspot data import job using its `importid`; this action is irreversible, and any data already processed will remain.

Create A/B 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.

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

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 `fromobj…

Create a batch of companies

Creates multiple company records in hubspot crm in a single batch operation, processing up to 100 companies per request.

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.

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.

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.

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.

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.

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

Create campaign

Creates a new hubspot campaign.

Create campaigns

Creates multiple hubspot campaigns in a single batch operation.

Create company

Creates a new hubspot company.

Create contact

Creates a new hubspot contact.

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

Create deal

Creates a new hubspot deal.

Create emails

Creates multiple hubspot emails in a single batch operation.

Create feedback submission

Creates a new hubspot feedback submission to record customer feedback (e.g., survey responses, support interactions), optionally associating it with crm objects.

Create line item

Creates a new hubspot line item.

Create line items

Creates multiple hubspot line items in a single batch operation.

Create 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 configu…

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

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

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…

Create pipeline stage

Creates a new stage in a specified hubspot crm pipeline for a given object type, such as 'deals' or 'tickets'.

Create product

Creates a new hubspot product.

Create products

Creates multiple hubspot products in a single batch operation.

Create property for specified object type

Creates a new custom property for a specified hubspot crm object type; ensure `groupname` refers to an existing property group for the `objecttype`.

Create quote object

Creates a new quote object in hubspot crm with specified properties and associations.

Create ticket

Creates a new hubspot ticket.

Create tickets

Creates multiple hubspot tickets in a batch, each with its own properties and associations; `inputs` list must not be empty, each item needs `properties`, and associations/custom properties must be v…

Create workflow

Creates a new hubspot workflow to automate processes; ensure `enrollmentcriteria` and `actions` use properties relevant to the specified `objecttypeid`.

Archive a batch of campaigns

Archives a batch of up to 50 marketing campaigns, hiding them from active views rather than permanently deleting them.

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.

Delete campaign

Permanently deletes a marketing campaign from hubspot using its `campaignguid`; returns a 204 no content status even if the campaign does not exist.

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

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.

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

Delete schema by object type

Permanently deletes a hubspot custom object schema, specified by its `objecttype`, after all associated crm records have been deleted.

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…

Delete workflow

Permanently deletes a hubspot workflow by its id; deleted workflows cannot be restored via the api and the id must exist.

Fetch import error details

Fetches a paginated list of read-only error details for a specific hubspot crm import, requiring a valid `importid` for a processed import.

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.

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

Archive companies

Archives multiple hubspot companies by their ids.

Archive contact

Archives a hubspot contact by its id.

Archive contacts

Archives multiple hubspot contacts by their ids.

Archive deals

Archives multiple hubspot deals by their ids.

Create companies

Creates multiple new hubspot companies in a single batch operation.

Create contacts

Creates multiple new hubspot contacts in a single batch operation.

Create deals

Creates multiple deals in hubspot crm; ensure any associated object ids, deal stages, and pipeline ids specified are valid and exist within the hubspot account.

Remove deal

Removes a hubspot deal by its id.

Update companies

Updates multiple hubspot companies in a single batch operation.

Update company

Updates properties for an existing hubspot company.

Update contact

Updates properties for an existing hubspot contact.

Update contacts

Updates multiple hubspot contacts in a single batch operation.

Update deal

Updates properties for an existing hubspot deal.

Update deals

Updates multiple hubspot deals in a single batch operation.

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

Partially update contact

Partially updates specified properties for an existing hubspot contact, identified by its valid `contactid`.

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.

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

Partially update pipeline by id

Partially updates a crm pipeline's label, display order, or restores an archived pipeline by setting `archived` to `false`.

Partially update property group

Partially updates a property group's `displayorder` or `label` for a specified crm `objecttype` in hubspot.

Partially 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 int…

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…

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.

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.

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.

Permanently delete quote for 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'.

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.

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…

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.

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.

Remove asset association

Disassociates an asset (form, object list, or external web url) from a hubspot campaign.

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.

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…

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

Update a batch of campaigns

Updates properties for up to 50 existing hubspot marketing campaigns in a single batch operation.

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').

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

Update batch feedback submissions

Updates a batch of hubspot feedback submissions; property keys must be existing internal hubspot names and values must be correctly formatted strings.

Update batch of 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`.

Update a batch of deals

Updates properties for multiple existing hubspot crm deals in a batch; ensure property names are the internal hubspot names.

Update a batch of objects by id or property values

Performs a batch update on a valid `objecttype` where properties are writeable and any `idproperty` used is designated unique; updates can be partial.

Update calling app recording settings

Updates the recording settings, such as the url for retrieving authenticated recordings, for a specific calling extension app identified by its `appid`.

Update campaign

Partially updates specific, writable properties of an existing hubspot marketing campaign identified by `campaignguid`; an empty string value in `properties` clears a property.

Update emails

Updates multiple hubspot emails in a single batch operation.

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 `ob…

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 `idproper…

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…

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.

Update product

Updates properties for an existing hubspot product.

Update products

Updates multiple hubspot products in a single batch operation.

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

Update ticket

Updates properties for an existing hubspot ticket.

Update tickets

Updates multiple hubspot tickets in a single batch operation.

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…

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.

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` fo…

Create email

Creates a new hubspot email.

Delete a marketing email

Deletes an existing marketing email, either permanently (default) or by archiving if `archived` is `true`.

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.

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.

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.

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.

Get the variation of 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.

Get workflow email campaigns

Retrieves email campaigns associated with a specific hubspot workflow id.

Publish or send a 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.

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.

Restore a revision of a marketing email to draft state

Restores a specific revision of a marketing email to a draft state, overwriting any existing draft.

Update a marketing email

Updates properties of an existing marketing email identified by its `emailid`; unspecified fields retain their current values.

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.

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…

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…

Delete timeline event template

Permanently and irreversibly deletes a specific timeline event template, identified by its `eventtemplateid`, from the application `appid`.

Get specific event template for app

Retrieves detailed information about a specific event template for a given application in hubspot's crm timeline.

List all event templates for app

Retrieves all event templates associated with a valid `appid` for an existing application in hubspot's crm timeline.

Remove token from event template

Removes a token from a hubspot event template, preventing its inclusion in new events created from that template.

Render event detail template

Renders detailed information for a specific hubspot crm timeline event using a predefined event template, ignoring `extradata` references in the template not present in event data.

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.

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

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` i…

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.

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…

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

Merge contacts

Merges two hubspot contacts into one.

Merge deals

Merges two hubspot deals into one.

Merge emails

Merges two hubspot emails into one.

Merge products

Merges two hubspot products into one.

Merge tickets

Merges two hubspot tickets into one.

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.

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

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.

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.

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.

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

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.

Modify calling extension settings

Updates settings (e.g., display name, ui url/dimensions, feature flags) for an existing calling extension app, identified by `appid`.

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.

Replace all properties of pipeline

Overwrites an entire crm pipeline (specified by `objecttype` and `pipelineid`) and all its stages with a new definition, returning the updated pipeline.

Replace pipeline stage properties

Replaces all properties of a specified pipeline stage; the new `label` must be unique within the pipeline, and if `objecttype` is 'deals', the `metadata` must include a 'probability' key.

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.

Return pipeline by id

Retrieves a specific pipeline by its id and crm object type, detailing its stages and properties.