Hubspot

Learn how to use Hubspot with Composio

Overview

Enum

HUBSPOT

Description

HubSpot is an inbound marketing, sales, and customer service platform integrating CRM, email automation, and analytics to facilitate lead nurturing and seamless customer experiences

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to account-info.security.read,accounting,cms.domains.read,cms.domains.write,crm.export,crm.import,crm.lists.read,crm.lists.write,crm.objects.companies.read,crm.objects.companies.write,crm.objects.contacts.read,crm.objects.contacts.write,crm.objects.deals.read,crm.objects.deals.write,crm.objects.marketing_events.read,crm.objects.marketing_events.write,crm.objects.owners.read,crm.objects.quotes.read,crm.objects.quotes.write,crm.schemas.companies.read,crm.schemas.companies.write,crm.schemas.contacts.read,crm.schemas.contacts.write,oauth,settings.users.read,settings.users.write,tickets,timeline,e-commerce,crm.objects.custom.read,crm.schemas.custom.read,content,sales-email-read
base_url
stringDefaults to https://api.hubapi.com
optional_scopes
stringDefaults to transactional-email automation marketing.campaigns.read
token
stringRequired
base_url
stringDefaults to https://api.hubapi.com

Actions

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.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

associations
array
custom_properties
object
description
string
hs_active
boolean
hs_archived
boolean
hs_cost_of_goods_sold
number
hs_featured
boolean
hs_images
string
hs_product_category
string
hs_product_id
string
hs_product_status
string
hs_product_subcategory
string
hs_product_type
string
hs_recurring_billing_period
string
hs_sku
string
hs_url
string
hs_valid_from
string
hs_valid_through
string
name
string
price
number
quantity
integer
tax_category
string

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

objectType
stringRequired
pipelineId
stringRequired
stageId
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves a paginated list of products from hubspot crm, optionally including specific properties, their history, associated object ids, and filtering by archived status.

Action Parameters

after
string
archived
boolean
associations
array
limit
integerDefaults to 10
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
Partially updates an existing hubspot crm product, identified by `productid` (or a custom unique `idproperty`), by modifying only specified `properties`.

Action Parameters

idProperty
string
productId
stringRequired
properties
objectRequired

Action Response

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

Action Parameters

assetId
stringRequired
assetType
stringRequired
campaignGuid
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

appId
integerRequired
createdAt
string
eventTemplateId
stringRequired
label
stringRequired
name
stringRequired
objectPropertyName
string
options
array
type
stringRequired
updatedAt
string

Action Response

data
object
error
string
successful
boolean
Archives the hubspot email specified by `emailid` by moving it to the recycling bin, making it inaccessible unless restored.

Action Parameters

emailId
stringRequired

Action Response

data
object
error
string
successful
boolean
Archives multiple hubspot crm emails by id; ids must exist as archiving is irreversible.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
Archives a batch of existing, non-archived quotes by their ids; this action is irreversible and useful for managing outdated or irrelevant quotes.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
Archives a batch of companies by their unique ids; targeted companies must exist, not be previously archived, and this api operation is irreversible.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
Archives a batch of existing line items by their unique ids in hubspot crm; this operation is irreversible via the api.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
Archives a batch of existing, non-archived crm objects of a specified `objecttype` by their ids, effectively hiding them from active use.

Action Parameters

inputs
arrayRequired
objectType
stringRequired

Action Response

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

Action Parameters

inputs
arrayRequired
objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
Archives a batch of existing, unarchived hubspot crm tickets by their unique ids.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
Archives a batch of existing, unarchived hubspot products by their ids; this action is irreversible via the api.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

companyId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

contactId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

objectId
stringRequired
objectType
stringRequired

Action Response

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

Action Parameters

feedbackSubmissionId
stringRequired

Action Response

data
object
error
string
successful
boolean
Archives a specific hubspot line item by its id, moving it to a recoverable state.

Action Parameters

lineItemId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

productId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

objectType
stringRequired
propertyName
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

groupName
stringRequired
objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
Archives a hubspot quote object by id to the recycling bin; this is api-irreversible and may need manual restoration.

Action Parameters

quoteId
stringRequired

Action Response

data
object
error
string
successful
boolean
Archives an existing hubspot ticket by its id, moving it to the recycling bin; this is a permanent operation not undoable via the api.

Action Parameters

ticketId
stringRequired

Action Response

data
object
error
string
successful
boolean
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').

Action Parameters

objectType
stringRequired
pipelineId
stringRequired

Action Response

data
object
error
string
successful
boolean
Batch-retrieves hubspot company records by their ids, allowing custom id properties, specific properties to fetch, and historical data.

Action Parameters

archived
boolean
idProperty
string
inputs
arrayRequired
properties
arrayRequired
propertiesWithHistory
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

inputs
arrayRequired

Action Response

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

Action Parameters

importId
integerRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

cloneName
string
id
stringRequired

Action Response

data
object
error
string
successful
boolean
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`.

Action Parameters

appId
integerRequired
height
integer
isReady
boolean
name
stringRequired
supportsCustomObjects
boolean
url
stringRequired
width
integer

Action Response

data
object
error
string
successful
boolean
**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.

Action Parameters

associations
array
custom_properties
object
description
string
hs_active
boolean
hs_archived
boolean
hs_cost_of_goods_sold
number
hs_featured
boolean
hs_images
string
hs_product_category
string
hs_product_id
string
hs_product_status
string
hs_product_subcategory
string
hs_product_type
string
hs_recurring_billing_period
string
hs_sku
string
hs_url
string
hs_valid_from
string
hs_valid_through
string
name
string
price
number
quantity
integer
tax_category
string

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

contentId
stringRequired
variationName
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

displayOrder
integer
label
stringRequired
name
stringRequired
objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

fromObjectTypeId
stringRequired
name
string
objectType
stringRequired
toObjectTypeId
stringRequired

Action Response

data
object
error
string
successful
boolean
Creates up to 50 marketing campaigns in a single batch operation.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
Creates multiple company records in hubspot crm in a single batch operation, processing up to 100 companies per request.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
Deprecated: use the `create batch of contacts` action instead. creates multiple hubspot contact records.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
Creates a new marketing campaign in hubspot with the specified properties, returning the created campaign data including its `campaignguid`.

Action Parameters

properties
objectRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

activeDomain
string
archived
boolean
businessUnitId
string
campaign
string
content__flexAreas
object
content__plainTextVersion
string
content__smartFields
object
content__templatePath
string
content__themeSettingsValues
object
content__widgetContainers
object
content__widgets
object
feedbackSurveyId
string
from__customReplyTo
string
from__fromName
string
from__replyTo
string
language
string
name
stringRequired
publishDate
string
rssData__blogEmailType
string
rssData__blogImageMaxWidth
integer
rssData__blogLayout
string
rssData__hubspotBlogId
string
rssData__maxEntries
integer
rssData__rssEntryTemplate
string
rssData__timing
object
rssData__url
string
rssData__useHeadlineAsSubject
boolean
sendOnPublish
boolean
state
string
subcategory
string
subject
string
subscriptionDetails__officeLocationId
string
subscriptionDetails__preferencesGroupId
string
subscriptionDetails__subscriptionId
string
testing__abSampleSizeDefault
string
testing__abSamplingDefault
string
testing__abStatus
string
testing__abSuccessMetric
string
testing__abTestPercentage
integer
testing__hoursToWait
integer
testing__testId
string
to__contactIds__exclude
array
to__contactIds__include
array
to__contactLists__exclude
array
to__contactLists__include
array
to__limitSendFrequency
boolean
to__suppressGraymail
boolean
webversion__domain
string
webversion__expiresAt
string
webversion__metaDescription
string
webversion__redirectToPageId
string
webversion__redirectToUrl
string
webversion__slug
string
webversion__title
string

Action Response

data
object
error
string
successful
boolean
Creates up to 100 new contact records in hubspot crm, optionally associating them with existing crm objects; ensure associated object ids are valid.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
Creates multiple hubspot line items in a batch, each with specified properties and associations to other existing crm objects.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

inputs
arrayRequired
objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

inputs
arrayRequired
objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
Creates a new company object in hubspot crm with specified properties and associations, returning the new company object.

Action Parameters

about_us
string
address
string
address2
string
annualrevenue
string
associations
array
city
string
country
string
createdate
string
custom_properties
object
description
string
domain
string
facebook_company_page
string
founded_year
string
hs_lastmodifieddate
string
hs_lead_status
string
hs_score
string
hubspot_owner_id
string
industry
string
is_public
string
lifecyclestage
string
linkedin_company_page
string
name
string
notes_last_updated
string
numberofemployees
string
parent_company
string
phone
string
state
string
timezone
string
twitterhandle
string
type
string
website
string
zip
string

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

address
string
annualrevenue
string
associatedcompanyid
string
associatedcompanylastupdated
string
associations
array
city
string
closedate
string
company
string
company_size
string
country
string
createdate
string
currentlyinworkflow
string
custom_properties
object
date_of_birth
string
days_to_close
string
degree
string
email
string
engagements_last_meeting_booked
string
engagements_last_meeting_booked_campaign
string
engagements_last_meeting_booked_medium
string
engagements_last_meeting_booked_source
string
fax
string
field_of_study
string
first_conversion_date
string
first_conversion_event_name
string
first_deal_created_date
string
firstname
string
followercount
string
gender
string
graduation_date
string
hs_additional_emails
string
hs_all_accessible_team_ids
string
hs_all_assigned_business_unit_ids
string
hs_all_contact_vids
string
hs_all_owner_ids
string
hs_all_team_ids
string
hs_analytics_average_page_views
string
hs_analytics_first_referrer
string
hs_analytics_first_timestamp
string
hs_analytics_first_touch_converting_campaign
string
hs_analytics_first_url
string
hs_analytics_first_visit_timestamp
string
hs_analytics_last_referrer
string
hs_analytics_last_timestamp
string
hs_analytics_last_touch_converting_campaign
string
hs_analytics_last_url
string
hs_analytics_last_visit_timestamp
string
hs_analytics_num_event_completions
string
hs_analytics_num_page_views
string
hs_analytics_num_visits
string
hs_analytics_revenue
string
hs_analytics_source
string
hs_analytics_source_data_1
string
hs_analytics_source_data_2
string
hubspot_owner_assigneddate
string
hubspot_owner_id
string
hubspot_team_id
string
hubspotscore
string
industry
string
ip_city
string
ip_country
string
ip_country_code
string
ip_latlon
string
ip_state
string
ip_state_code
string
ip_zipcode
string
job_function
string
jobtitle
string
kloutscoregeneral
string
lastmodifieddate
string
lastname
string
lifecyclestage
string
linkedinbio
string
linkedinconnections
string
marital_status
string
message
string
military_status
string
mobilephone
string
notes_last_contacted
string
notes_last_updated
string
notes_next_activity_date
string
num_associated_deals
string
num_contacted_notes
string
num_conversion_events
string
num_notes
string
num_unique_conversion_events
string
numemployees
string
owneremail
string
ownername
string
phone
string
photo
string
recent_conversion_date
string
recent_conversion_event_name
string
recent_deal_amount
string
recent_deal_close_date
string
relationship_status
string
salutation
string
school
string
seniority
string
start_date
string
state
string
surveymonkeyeventlastupdated
string
total_revenue
string
twitterbio
string
twitterhandle
string
twitterprofilephoto
string
webinareventlastupdated
string
website
string
work_email
string
zip
string

Action Response

data
object
error
string
successful
boolean
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).

Action Parameters

associations
arrayRequired
objectType
stringRequired
properties
objectRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

appId
integerRequired
detailTemplate
string
headerTemplate
string
name
stringRequired
objectType
stringRequired
tokens
arrayRequired

Action Response

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

Action Parameters

associations
arrayRequired
properties
objectRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

associations
arrayRequired
properties
objectRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

amount
string
amount_in_home_currency
string
associations
array
closed_lost_reason
string
closed_won_reason
string
closedate
string
createdate
string
custom_properties
object
days_to_close
string
deal_currency_code
string
dealname
string
dealstage
string
dealtype
string
description
string
engagements_last_meeting_booked
string
engagements_last_meeting_booked_campaign
string
engagements_last_meeting_booked_medium
string
engagements_last_meeting_booked_source
string
hs_acv
string
hs_all_accessible_team_ids
string
hs_all_assigned_business_unit_ids
string
hs_all_owner_ids
string
hs_all_team_ids
string
hs_analytics_source
string
hs_arr
string
hs_campaign
string
hs_closed_amount
string
hs_closed_amount_in_home_currency
string
hs_createdate
string
hs_deal_stage_probability
string
hs_forecast_amount
string
hs_forecast_probability
string
hs_is_closed
string
hs_lastmodifieddate
string
hs_mrr
string
hs_next_step
string
hs_object_id
string
hs_priority
string
hs_projected_amount
string
hs_projected_amount_in_home_currency
string
hs_tcv
string
hubspot_owner_id
string
pipeline
string

Action Response

data
object
error
string
successful
boolean
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).

Action Parameters

associatedObjects
arrayRequired
description
string
labels__plural
string
labels__singular
string
name
stringRequired
primaryDisplayProperty
string
properties
arrayRequired
requiredProperties
arrayRequired
searchableProperties
array
secondaryDisplayProperties
array

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

activeDomain
string
archived
boolean
businessUnitId
string
campaign
string
content__flexAreas
object
content__plainTextVersion
string
content__smartFields
object
content__templatePath
string
content__themeSettingsValues
object
content__widgetContainers
object
content__widgets
object
emailId
stringRequired
from__customReplyTo
string
from__fromName
string
from__replyTo
string
language
string
name
string
publishDate
string
rssData__blogEmailType
string
rssData__blogImageMaxWidth
integer
rssData__blogLayout
string
rssData__hubspotBlogId
string
rssData__maxEntries
integer
rssData__rssEntryTemplate
string
rssData__timing
object
rssData__url
string
rssData__useHeadlineAsSubject
boolean
sendOnPublish
boolean
state
string
subcategory
string
subject
string
subscriptionDetails__officeLocationId
string
subscriptionDetails__preferencesGroupId
string
subscriptionDetails__subscriptionId
string
testing__abSampleSizeDefault
string
testing__abSamplingDefault
string
testing__abStatus
string
testing__abSuccessMetric
string
testing__abTestPercentage
integer
testing__hoursToWait
integer
testing__testId
string
to__contactIds__exclude
array
to__contactIds__include
array
to__contactLists__exclude
array
to__contactLists__include
array
to__limitSendFrequency
boolean
to__suppressGraymail
boolean
webversion__domain
string
webversion__expiresAt
string
webversion__metaDescription
string
webversion__redirectToPageId
string
webversion__redirectToUrl
string
webversion__slug
string
webversion__title
string

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

displayOrder
integerRequired
label
stringRequired
objectType
stringRequired
stages
arrayRequired

Action Response

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

Action Parameters

displayOrder
integerRequired
label
stringRequired
metadata
objectRequired
objectType
stringRequired
pipelineId
stringRequired

Action Response

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

Action Parameters

calculationFormula
string
description
string
displayOrder
integer
externalOptions
boolean
fieldType
stringRequired
formField
boolean
groupName
stringRequired
hasUniqueValue
boolean
hidden
boolean
label
stringRequired
name
stringRequired
objectType
stringRequired
options
array
referencedObjectType
string
type
stringRequired

Action Response

data
object
error
string
successful
boolean
Creates a new quote object in hubspot crm with specified properties and associations.

Action Parameters

associations
arrayRequired
properties
objectRequired

Action Response

data
object
error
string
successful
boolean
Creates a new ticket in hubspot with specified properties and associations; ensure custom property names, associated object ids (`to id`), pipeline ids (`hs pipeline`), and stage ids (`hs pipeline stage`) are valid in your hubspot instance.

Action Parameters

associations
array
closed_date
string
content
string
created_by
string
createdate
string
custom_properties
object
first_agent_reply_date
string
hs_all_accessible_team_ids
array
hs_all_assigned_business_unit_ids
array
hs_all_associated_contact_companies
array
hs_all_associated_contact_emails
array
hs_all_associated_contact_firstnames
array
hs_all_associated_contact_lastnames
array
hs_all_associated_contact_mobilephones
array
hs_all_associated_contact_phones
array
hs_all_conversation_mentions
array
hs_all_owner_ids
array
hs_all_team_ids
array
hs_assigned_team_ids
array
hs_assignment_method
string
hs_auto_generated_from_thread_id
string
hs_conversations_originating_message_id
string
hs_conversations_originating_thread_id
string
hs_created_by_user_id
string
hs_lastcontacted
string
hs_lastmodifieddate
string
hs_pipeline
string
hs_pipeline_stage
string
hs_primary_company
string
hs_tag_ids
array
hs_ticket_category
string
hs_ticket_priority
string
hubspot_owner_id
string
hubspot_team_id
string
last_engagement_date
string
last_reply_date
string
notes_last_contacted
string
notes_last_updated
string
notes_next_activity_date
string
source_type
string
subject
string
time_to_close
string

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

domain
string
email
string
eventTemplateId
stringRequired
id
string
objectId
string
timelineIFrame__headerLabel
string
timelineIFrame__height
integer
timelineIFrame__linkLabel
string
timelineIFrame__url
string
timelineIFrame__width
integer
timestamp
string
tokens
objectRequired
utk
string

Action Response

data
object
error
string
successful
boolean
Creates a new hubspot workflow to automate processes; ensure `enrollmentcriteria` and `actions` use properties relevant to the specified `objecttypeid`.

Action Parameters

actions
array
blockedDates
array
canEnrollFromSalesforce
boolean
customProperties
object
dataSources
array
description
string
enrollmentCriteria
object
flowType
stringDefaults to WORKFLOW
isEnabled
boolean
name
stringRequired
objectTypeId
stringDefaults to 0-1
suppressionListIds
array
timeWindows
array
type
stringDefaults to CONTACT_FLOW
unEnrollmentSetting
object

Action Response

data
object
error
string
successful
boolean
Deprecated: use 'list contacts page' to retrieve a paginated list of hubspot contacts.

Action Parameters

after
string
archived
boolean
associations
array
limit
integerDefaults to 5
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
Archives a batch of up to 50 marketing campaigns, hiding them from active views rather than permanently deleting them.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
Deletes an existing marketing email, either permanently (default) or by archiving if `archived` is `true`.

Action Parameters

archived
boolean
emailId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

appId
integerRequired

Action Response

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

Action Parameters

campaignGuid
stringRequired

Action Response

data
object
error
string
successful
boolean
Irreversibly deletes a hubspot contact for gdpr compliance (identified via `objectid` and `idproperty`); an email `objectid` for a non-existent contact may be blocklisted.

Action Parameters

idProperty
string
objectId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

objectType
stringRequired
pipelineId
stringRequired
validateDealStageUsagesBeforeDelete
boolean
validateReferencesBeforeDelete
boolean

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

objectType
stringRequired
pipelineId
stringRequired
stageId
stringRequired

Action Response

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

Action Parameters

archived
boolean
objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
Permanently and irreversibly deletes a specific timeline event template, identified by its `eventtemplateid`, from the application `appid`.

Action Parameters

appId
integerRequired
eventTemplateId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

appId
integerRequired

Action Response

data
object
error
string
successful
boolean
Permanently deletes a hubspot workflow by its id; deleted workflows cannot be restored via the api and the id must exist.

Action Parameters

workflow_id
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
associations
array
contactId
stringRequired
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
Fetches hubspot contact ids for a specified `campaignguid` (must be a valid uuid of an existing campaign) and `contacttype`, supporting date filtering and pagination.

Action Parameters

after
string
campaignGuid
stringRequired
contactType
stringRequired
endDate
string
limit
integer
startDate
string

Action Response

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

Action Parameters

after
string
importId
integerRequired
limit
integer

Action Response

data
object
error
string
successful
boolean
Deprecated: use the 'retrieve line item by id' action instead.

Action Parameters

archived
boolean
associations
array
idProperty
string
lineItemId
stringRequired
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
Fetches call recording settings for a specified, existing hubspot calling extension app.

Action Parameters

appId
integerRequired

Action Response

data
object
error
string
successful
boolean
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`.

Action Parameters

attributionModel
string
campaignGuid
stringRequired
endDate
string
startDate
string

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

idProperty
string
objectId
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves a list of currently active import jobs in hubspot for monitoring ongoing data operations.

Action Parameters

after
string
before
string
limit
integer

Action Response

data
object
error
string
successful
boolean
Retrieves aggregated statistics for marketing emails, optionally within an iso8601 formatted time range, by email ids, or specific email properties.

Action Parameters

emailIds
array
endTimestamp
string
property
string
startTimestamp
string

Action Response

data
object
error
string
successful
boolean
Retrieves aggregated statistics for marketing emails (e.g., send counts), grouped by specified time intervals within a defined time range.

Action Parameters

emailIds
array
endTimestamp
string
interval
string
startTimestamp
string

Action Response

data
object
error
string
successful
boolean
Fetches a list of marketing emails from a hubspot account, with options for filtering, sorting, pagination, and including performance statistics.

Action Parameters

after
string
archived
boolean
createdAfter
string
createdAt
string
createdBefore
string
includeStats
boolean
includedProperties
array
isPublished
boolean
limit
integer
sort
array
type
string
updatedAfter
string
updatedAt
string
updatedBefore
string

Action Response

data
object
error
string
successful
boolean
Retrieves a list of workflow summaries (id, name, type, status) from hubspot, using the 'limit' parameter for pagination.

Action Parameters

limit
integerDefaults to 100

Action Response

data
object
error
string
successful
boolean
Retrieves a paginated list of crm owners from hubspot, optionally filtering by email or archived status. <<deprecated: use 'retrieve page of crm owners' instead.>>

Action Parameters

after
string
archived
boolean
email
string
limit
integerDefaults to 100

Action Response

data
object
error
string
successful
boolean
Retrieves a specific, previously saved revision of a marketing email using its unique email id and revision id.

Action Parameters

emailId
stringRequired
revisionId
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves key attribution metrics for an existing marketing campaign, identified by its `campaignguid`, within an optional date range.

Action Parameters

campaignGuid
stringRequired
endDate
string
startDate
string

Action Response

data
object
error
string
successful
boolean
Retrieves the draft version of a marketing email by its `emailid`; if no draft exists, returns the published version.

Action Parameters

emailId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

importId
integerRequired

Action Response

data
object
error
string
successful
boolean
Fetches a list of marketing emails from hubspot, supporting filtering by creation/update timestamps, pagination, and sorting.

Action Parameters

after
string
createdAfter
string
createdAt
string
limit
integerDefaults to 20
sort
array
updatedAt
string

Action Response

data
object
error
string
successful
boolean
Retrieves a specific hubspot quote by its unique identifier.

Action Parameters

archived
boolean
associations
array
idProperty
string
properties
array
propertiesWithHistory
array
quoteId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

after
string
before
string
emailId
stringRequired
limit
integer

Action Response

data
object
error
string
successful
boolean
Retrieves detailed information about a specific event template for a given application in hubspot's crm timeline.

Action Parameters

appId
integerRequired
eventTemplateId
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves detailed information for a specific marketing email in hubspot using its unique email id, optionally including performance statistics and specific properties.

Action Parameters

archived
boolean
emailId
stringRequired
includeStats
boolean
includedProperties
array

Action Response

data
object
error
string
successful
boolean
Retrieves the alternate variation of a specified a/b marketing email; the `emailid` must identify an email currently in an a/b test.

Action Parameters

emailId
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves comprehensive details for an existing hubspot workflow by its unique id; unsupported actions are designated 'unsupported action' in the response.

Action Parameters

workflow_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves email campaigns associated with a specific hubspot workflow id.

Action Parameters

limit
integerDefaults to 100
workflow_id
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

files
object
importRequest
string

Action Response

data
object
error
string
successful
boolean
Deprecated: creates a new hubspot crm company object with given properties and associations; use create company object instead.

Action Parameters

about_us
string
address
string
address2
string
annualrevenue
string
associations
array
city
string
country
string
createdate
string
custom_properties
object
description
string
domain
string
facebook_company_page
string
founded_year
string
hs_lastmodifieddate
string
hs_lead_status
string
hs_score
string
hubspot_owner_id
string
industry
string
is_public
string
lifecyclestage
string
linkedin_company_page
string
name
string
notes_last_updated
string
numberofemployees
string
parent_company
string
phone
string
state
string
timezone
string
twitterhandle
string
type
string
website
string
zip
string

Action Response

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

Action Parameters

after
string
archived
boolean
associations
array
limit
integerDefaults to 10
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
Retrieves all event templates associated with a valid `appid` for an existing application in hubspot's crm timeline.

Action Parameters

appId
integerRequired

Action Response

data
object
error
string
successful
boolean
Lists assets of a specific `assettype` for a given hubspot marketing `campaignguid`, optionally including performance metrics for a date range.

Action Parameters

after
string
assetType
stringRequired
campaignGuid
stringRequired
endDate
string
limit
string
startDate
string

Action Response

data
object
error
string
successful
boolean
Lists all valid association types between two specified hubspot crm object types.

Action Parameters

fromObjectType
stringRequired
toObjectType
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

after
string
archived
boolean
associations
array
limit
integerDefaults to 5
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
Retrieves a paginated list of feedback submissions from hubspot, allowing specification of properties (including history), associated object ids, and filtering by archive status.

Action Parameters

after
string
archived
boolean
associations
array
limit
integerDefaults to 10
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

after
string
archived
boolean
associations
array
limit
integerDefaults to 10
properties
array
propertiesWithHistory
array

Action Response

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

Action Parameters

after
string
archived
boolean
associations
array
limit
integerDefaults to 10
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
Merges two existing company records of the same type in hubspot crm, where `objectidtomerge` is absorbed into `primaryobjectid`; this operation is irreversible.

Action Parameters

objectIdToMerge
stringRequired
primaryObjectId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

objectIdToMerge
stringRequired
primaryObjectId
stringRequired

Action Response

data
object
error
string
successful
boolean
Permanently merges two hubspot crm deals of the same type, typically to eliminate duplicates or consolidate related sales opportunities.

Action Parameters

objectIdToMerge
stringRequired
primaryObjectId
stringRequired

Action Response

data
object
error
string
successful
boolean
Merges two existing, same-type hubspot crm emails: `objectidtomerge` is absorbed into `primaryobjectid` and then deleted; use for de-duplication, this action is irreversible.

Action Parameters

objectIdToMerge
stringRequired
primaryObjectId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

objectIdToMerge
stringRequired
primaryObjectId
stringRequired

Action Response

data
object
error
string
successful
boolean
Merges two line items, `objectidtomerge` into `primaryobjectid`, which must be of the same type; `objectidtomerge` is absorbed and the operation is irreversible.

Action Parameters

objectIdToMerge
stringRequired
primaryObjectId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

objectIdToMerge
stringRequired
objectType
stringRequired
primaryObjectId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

objectIdToMerge
stringRequired
primaryObjectId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

objectIdToMerge
stringRequired
primaryObjectId
stringRequired

Action Response

data
object
error
string
successful
boolean
Merges two existing hubspot tickets of the same type, where `objectidtomerge` (which is then deactivated) is absorbed into `primaryobjectid`.

Action Parameters

objectIdToMerge
stringRequired
primaryObjectId
stringRequired

Action Response

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

Action Parameters

appId
integerRequired
height
integer
isReady
boolean
name
string
supportsCustomObjects
boolean
url
string
width
integer

Action Response

data
object
error
string
successful
boolean
Partially updates specified properties for an existing hubspot contact, identified by its valid `contactid`.

Action Parameters

contactId
stringRequired
properties
objectRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

idProperty
string
objectId
stringRequired
objectType
stringRequired
properties
objectRequired

Action Response

data
object
error
string
successful
boolean
Partially updates specified properties of an existing hubspot crm deal, identified by its `dealid` or an optional custom unique `idproperty`.

Action Parameters

dealId
stringRequired
idProperty
string
properties
objectRequired

Action Response

data
object
error
string
successful
boolean
Partially updates a crm pipeline's label, display order, or restores an archived pipeline by setting `archived` to `false`.

Action Parameters

archived
boolean
displayOrder
integer
label
string
objectType
stringRequired
pipelineId
stringRequired
validateDealStageUsagesBeforeDelete
boolean
validateReferencesBeforeDelete
boolean

Action Response

data
object
error
string
successful
boolean
Partially updates a property group's `displayorder` or `label` for a specified crm `objecttype` in hubspot.

Action Parameters

displayOrder
integer
groupName
stringRequired
label
string
objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

idProperty
string
properties
objectRequired
ticketId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

companyId
stringRequired
idProperty
string
properties
objectRequired

Action Response

data
object
error
string
successful
boolean
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).

Action Parameters

idProperty
string
properties
objectRequired
quoteId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

idProperty
string
objectId
stringRequired

Action Response

data
object
error
string
successful
boolean
Irreversibly deletes a hubspot contact for gdpr; if deleting by a non-existent email (using idproperty 'email'), the email is blocklisted instead.

Action Parameters

idProperty
string
objectId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

idProperty
string
objectId
stringRequired

Action Response

data
object
error
string
successful
boolean
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'.

Action Parameters

idProperty
string
objectId
stringRequired

Action Response

data
object
error
string
successful
boolean
Permanently deletes a hubspot contact and all its associated data for gdpr compliance, identifying the contact by its id or another unique property.

Action Parameters

idProperty
string
objectId
stringRequired
objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
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`.

Action Parameters

idProperty
string
objectId
stringRequired

Action Response

data
object
error
string
successful
boolean
Permanently and irreversibly deletes an existing hubspot contact and associated content for gdpr compliance, optionally blocklisting the contact's email.

Action Parameters

idProperty
string
objectId
stringRequired

Action Response

data
object
error
string
successful
boolean
Permanently deletes a specified line item and its associated content for gdpr compliance; this action is irreversible and cannot be undone.

Action Parameters

idProperty
string
objectId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

email_id
stringRequired

Action Response

data
object
error
string
successful
boolean
Permanently and irreversibly deletes the schema for an existing `objecttype` in hubspot crm; this deprecated endpoint should be used with extreme caution.

Action Parameters

objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
associations
array
idProperty
string
productId
stringRequired
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
Deprecated: use `read all properties for object type` instead. retrieves property definitions for a specified hubspot crm object type.

Action Parameters

archived
boolean
objectType
stringRequired
properties
string

Action Response

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

Action Parameters

archived
boolean
objectType
stringRequired
properties
string

Action Response

data
object
error
string
successful
boolean
Retrieves all property groups for a specified hubspot crm object type. <<DEPRECATED use read_property_groups_for_object_type>>

Action Parameters

objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
**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.

Action Parameters

archived
boolean
idProperty
stringDefaults to id
ownerId
integerRequired

Action Response

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

Action Parameters

after
string
archived
boolean
associations
array
limit
integerDefaults to 10
objectType
stringRequired
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

endDate
string
inputs
arrayRequired
properties
array
startDate
string

Action Response

data
object
error
string
successful
boolean
Reads definitions (metadata, not values) for a batch of crm object properties for a specified `objecttype`, supporting partial success.

Action Parameters

archived
booleanRequired
inputs
arrayRequired
objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves details for a marketing campaign by `campaignguid`, optionally including specified `properties` and asset metrics if both `startdate` and `enddate` are provided.

Action Parameters

campaignGuid
stringRequired
endDate
string
properties
array
startDate
string

Action Response

data
object
error
string
successful
boolean
Reads a specific crm property definition for a given hubspot object type by its internal name.

Action Parameters

archived
boolean
objectType
stringRequired
properties
string
propertyName
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves a paginated list of hubspot crm deals; use the 'after' token from a previous response's 'paging.next.after' for subsequent pages.

Action Parameters

after
string
archived
boolean
associations
array
limit
integerDefaults to 10
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
objectType
stringRequired
properties
string
propertyName
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

groupName
stringRequired
objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
idProperty
string
inputs
arrayRequired
properties
arrayRequired
propertiesWithHistory
arrayRequired

Action Response

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

Action Parameters

archived
boolean
idProperty
string
inputs
arrayRequired
properties
arrayRequired
propertiesWithHistory
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
idProperty
string
inputs
arrayRequired
properties
arrayRequired
propertiesWithHistory
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
idProperty
string
inputs
arrayRequired
objectType
stringRequired
properties
arrayRequired
propertiesWithHistory
arrayRequired

Action Response

data
object
error
string
successful
boolean
Retrieves a batch of hubspot crm line items by their ids, or optionally by values of a custom unique property defined in `idproperty`.

Action Parameters

archived
boolean
idProperty
string
inputs
arrayRequired
properties
arrayRequired
propertiesWithHistory
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
idProperty
string
inputs
arrayRequired
properties
arrayRequired
propertiesWithHistory
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
idProperty
string
inputs
arrayRequired
properties
arrayRequired
propertiesWithHistory
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
idProperty
string
inputs
arrayRequired
properties
arrayRequired
propertiesWithHistory
arrayRequired

Action Response

data
object
error
string
successful
boolean
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).

Action Parameters

campaignGuid
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves a hubspot crm contact by its unique internal hubspot id, allowing selection of properties, historical values, associated objects, and filtering for archived contacts.

Action Parameters

archived
boolean
associations
array
contactId
stringRequired
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
associations
array
idProperty
string
objectId
stringRequired
objectType
stringRequired
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
Reads a hubspot feedback submission by its id, optionally using a custom unique 'idproperty', and allows specifying properties to return including history and associations.

Action Parameters

archived
boolean
associations
array
feedbackSubmissionId
stringRequired
idProperty
string
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
associations
array
idProperty
string
productId
stringRequired
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
Deprecated: use the `archive contact by id` action to archive a hubspot crm contact by its id.

Action Parameters

contactId
stringRequired

Action Response

data
object
error
string
successful
boolean
Disassociates an asset (form, object list, or external web url) from a hubspot campaign.

Action Parameters

assetId
stringRequired
assetType
stringRequired
campaignGuid
stringRequired

Action Response

data
object
error
string
successful
boolean
Permanently removes a specified association definition (type) from a hubspot object's schema, preventing future creations of this association type without affecting existing instances.

Action Parameters

associationIdentifier
stringRequired
objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

dealId
stringRequired

Action Response

data
object
error
string
successful
boolean
Removes a token from a hubspot event template, preventing its inclusion in new events created from that template.

Action Parameters

appId
integerRequired
eventTemplateId
stringRequired
tokenName
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

eventId
stringRequired
eventTemplateId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

detail
boolean
eventId
stringRequired
eventTemplateId
stringRequired

Action Response

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

Action Parameters

displayOrder
integerRequired
label
stringRequired
objectType
stringRequired
pipelineId
stringRequired
stages
arrayRequired
validateDealStageUsagesBeforeDelete
boolean
validateReferencesBeforeDelete
boolean

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

displayOrder
integerRequired
label
stringRequired
metadata
objectRequired
objectType
stringRequired
pipelineId
stringRequired
stageId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

emailId
stringRequired

Action Response

data
object
error
string
successful
boolean
Restores a specific, existing, non-active revision of a marketing email to become the new live version for that email.

Action Parameters

emailId
stringRequired
revisionId
stringRequired

Action Response

data
object
error
string
successful
boolean
Restores a specific revision of a marketing email to a draft state, overwriting any existing draft.

Action Parameters

emailId
stringRequired
revisionId
integerRequired

Action Response

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

Action Parameters

archived
boolean

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves all pipelines in hubspot for a specified crm object type, such as deals or tickets.

Action Parameters

objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
idProperty
string
inputs
arrayRequired
properties
arrayRequired
propertiesWithHistory
arrayRequired

Action Response

data
object
error
string
successful
boolean
Retrieves the read-only calling extension settings for a specific hubspot app; the app must exist and have calling extensions configured.

Action Parameters

appId
integerRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
associations
array
companyId
stringRequired
idProperty
string
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
associations
array
dealId
stringRequired
idProperty
string
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

after
string
archived
boolean
associations
array
limit
integerDefaults to 10
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
Retrieves a hubspot crm line item by its id or a specified unique property (`idproperty`).

Action Parameters

archived
boolean
associations
array
idProperty
string
lineItemId
stringRequired
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
Retrieves a list of all owners in the hubspot crm, including their id, first name, last name, email, and user id.

Action Parameters

Action Response

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

Action Parameters

archived
boolean
idProperty
stringDefaults to id
ownerId
integerRequired

Action Response

data
object
error
string
successful
boolean
Retrieves a paginated list of companies from hubspot, using an 'after' cursor from a previous response for subsequent pages.

Action Parameters

after
string
archived
boolean
associations
array
limit
integerDefaults to 5
properties
array
propertiesWithHistory
array

Action Response

data
object
error
string
successful
boolean
Retrieves a paginated list of crm owners from hubspot, optionally filtering by email or archived status.

Action Parameters

after
string
archived
boolean
email
string
limit
integerDefaults to 100

Action Response

data
object
error
string
successful
boolean
Fetches all stages for a specified hubspot crm object type and pipeline id.

Action Parameters

objectType
stringRequired
pipelineId
stringRequired

Action Response

data
object
error
string
successful
boolean
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`.

Action Parameters

objectType
stringRequired
pipelineId
stringRequired
stageId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

archived
boolean
associations
array
idProperty
string
properties
array
propertiesWithHistory
array
ticketId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

eventId
stringRequired
eventTemplateId
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves video conference application settings, such as webhook urls and user/account management configurations, for a specified `appid`.

Action Parameters

appId
integerRequired

Action Response

data
object
error
string
successful
boolean
Retrieves a specific pipeline by its id and crm object type, detailing its stages and properties.

Action Parameters

objectType
stringRequired
pipelineId
stringRequired

Action Response

data
object
error
string
successful
boolean
Searches hubspot company objects using a text query, complex filter groups (anded within, ored between), sorting, and specific property selection, including custom properties.

Action Parameters

after
string
custom_properties
array
filterGroups
array
limit
integerDefaults to 5
properties
array
query
string
sorts
array

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

after
string
custom_properties
array
filterGroups
array
limit
integerDefaults to 5
properties
array
query
string
sorts
array

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

after
stringRequired
filterGroups
arrayRequired
limit
integerRequired
properties
arrayRequired
query
string
sorts
arrayRequired

Action Response

data
object
error
string
successful
boolean
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`.

Action Parameters

after
stringRequired
filterGroups
arrayRequired
limit
integerRequired
objectType
stringRequired
properties
arrayRequired
query
string
sorts
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

after
string
custom_properties
array
filterGroups
array
limit
integerDefaults to 5
properties
array
query
string
sorts
array

Action Response

data
object
error
string
successful
boolean
Searches for feedback submissions in hubspot crm using text query, filter groups, sorting, and pagination, returning specified properties.

Action Parameters

after
stringRequired
filterGroups
arrayRequired
limit
integerRequired
properties
arrayRequired
query
string
sorts
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

after
stringRequired
filterGroups
arrayRequired
limit
integerRequired
properties
arrayRequired
query
string
sorts
arrayRequired

Action Response

data
object
error
string
successful
boolean
Searches hubspot products using text queries, filters, and sorting by sortable properties, with options for pagination and specifying returned properties.

Action Parameters

after
string
custom_properties
array
filterGroups
array
limit
integerDefaults to 5
properties
array
query
string
sorts
array

Action Response

data
object
error
string
successful
boolean
Searches hubspot crm quotes using a text query, complex filter criteria, sorting, and pagination.

Action Parameters

after
stringRequired
filterGroups
arrayRequired
limit
integerRequired
properties
arrayRequired
query
string
sorts
arrayRequired

Action Response

data
object
error
string
successful
boolean
Retrieves hubspot tickets by applying filters on properties, a full-text query, sort preferences, and pagination, allowing selection of specific fields to be returned.

Action Parameters

after
string
custom_properties
array
filterGroups
array
limit
integerDefaults to 5
properties
array
query
string
sorts
array

Action Response

data
object
error
string
successful
boolean
Deprecated: searches hubspot products by criteria; use `search products by criteria` instead.

Action Parameters

after
string
custom_properties
array
filterGroups
array
limit
integerDefaults to 5
properties
array
query
string
sorts
array

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

appId
integerRequired
urlToRetrieveAuthedRecording
stringRequired

Action Response

data
object
error
string
successful
boolean
Deprecated: partially updates an existing hubspot crm product, identified by `productid` (or a custom unique `idproperty`), by modifying specified `properties`; use 'update product' instead.

Action Parameters

idProperty
string
productId
stringRequired
properties
objectRequired

Action Response

data
object
error
string
successful
boolean
Updates properties for up to 50 existing hubspot marketing campaigns in a single batch operation.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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').

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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).

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
Updates properties of an existing marketing email identified by its `emailid`; unspecified fields retain their current values.

Action Parameters

activeDomain
string
archived
boolean
businessUnitId
string
campaign
string
content__flexAreas
object
content__plainTextVersion
string
content__smartFields
object
content__templatePath
string
content__themeSettingsValues
object
content__widgetContainers
object
content__widgets
object
emailId
stringRequired
from__customReplyTo
string
from__fromName
string
from__replyTo
string
language
string
name
string
publishDate
string
rssData__blogEmailType
string
rssData__blogImageMaxWidth
integer
rssData__blogLayout
string
rssData__hubspotBlogId
string
rssData__maxEntries
integer
rssData__rssEntryTemplate
string
rssData__timing
object
rssData__url
string
rssData__useHeadlineAsSubject
boolean
sendOnPublish
boolean
state
string
subcategory
string
subject
string
subscriptionDetails__officeLocationId
string
subscriptionDetails__preferencesGroupId
string
subscriptionDetails__subscriptionId
string
testing__abSampleSizeDefault
string
testing__abSamplingDefault
string
testing__abStatus
string
testing__abSuccessMetric
string
testing__abTestPercentage
integer
testing__hoursToWait
integer
testing__testId
string
to__contactIds__exclude
array
to__contactIds__include
array
to__contactLists__exclude
array
to__contactLists__include
array
to__limitSendFrequency
boolean
to__suppressGraymail
boolean
webversion__domain
string
webversion__expiresAt
string
webversion__metaDescription
string
webversion__redirectToPageId
string
webversion__redirectToUrl
string
webversion__slug
string
webversion__title
string

Action Response

data
object
error
string
successful
boolean
Updates a batch of hubspot feedback submissions; property keys must be existing internal hubspot names and values must be correctly formatted strings.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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`.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
Updates properties for multiple existing hubspot crm deals in a batch; ensure property names are the internal hubspot names.

Action Parameters

inputs
arrayRequired

Action Response

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

Action Parameters

inputs
arrayRequired
objectType
stringRequired

Action Response

data
object
error
string
successful
boolean
Updates multiple hubspot product records in a single batch; all properties to be updated must already exist in hubspot.

Action Parameters

inputs
arrayRequired

Action Response

data
object
error
string
successful
boolean
Updates the recording settings, such as the url for retrieving authenticated recordings, for a specific calling extension app identified by its `appid`.

Action Parameters

appId
integerRequired
urlToRetrieveAuthedRecording
string

Action Response

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

Action Parameters

campaignGuid
stringRequired
properties
objectRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

appId
integerRequired
detailTemplate
string
eventTemplateId
stringRequired
headerTemplate
string
id
stringRequired
name
stringRequired
tokens
arrayRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

description
string
labels__plural
string
labels__singular
string
objectType
stringRequired
primaryDisplayProperty
string
requiredProperties
array
restorable
boolean
searchableProperties
array
secondaryDisplayProperties
array

Action Response

data
object
error
string
successful
boolean
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).

Action Parameters

feedbackSubmissionId
stringRequired
idProperty
string
properties
objectRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

idProperty
string
lineItemId
stringRequired
properties
objectRequired

Action Response

data
object
error
string
successful
boolean
Partially updates a hubspot crm pipeline stage identified by `objecttype`, `pipelineid`, and `stageid`, requiring `metadata` in the request; unspecified fields are unchanged.

Action Parameters

archived
boolean
displayOrder
integer
label
string
metadata
objectRequired
objectType
stringRequired
pipelineId
stringRequired
stageId
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

calculationFormula
string
description
string
displayOrder
integer
fieldType
string
formField
boolean
groupName
string
hidden
boolean
label
string
objectType
stringRequired
options
array
propertyName
stringRequired
type
string

Action Response

data
object
error
string
successful
boolean
Updates the label or options of an existing token within a specified hubspot crm event template; token name and data type remain unchanged.

Action Parameters

appId
integerRequired
eventTemplateId
stringRequired
label
stringRequired
objectPropertyName
string
options
array
tokenName
stringRequired

Action Response

data
object
error
string
successful
boolean
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.

Action Parameters

appId
integerRequired
createMeetingUrl
stringRequired
deleteMeetingUrl
string
fetchAccountsUri
string
updateMeetingUrl
string
userVerifyUrl
string

Action Response

data
object
error
string
successful
boolean