Hubspot | Composio Docs

Overview

SLUG

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

OAuth2

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

full

stringDefaults to https://api.hubapi.com

optional_scopes

stringDefaults to transactional-email automation marketing.campaigns.read

bearer_token

string

Bearer Token

full

stringDefaults to https://api.hubapi.com

token

stringRequired

Tools

Create batch of tickets

SLUG: HUBSPOT_CREATE_BATCH_OF_TICKET

Creates multiple hubspot tickets in a batch, each with its own properties and associations; `inputs` list must not be empty, each item needs `properties`, and associations/custom properties must be validly defined using internal names for custom fields and iso 8601 for dates.

Action Parameters

inputs

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create product batch

SLUG: HUBSPOT_CREATE_PRODUCT_BATCH

Creates multiple products in hubspot crm in a batch, allowing unique properties and associations per product; ensure `associationcategory` and `associationtypeid` are valid, and `to  id` refers to an existing crm object id when specifying associations.

Action Parameters

inputs

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create product object

SLUG: HUBSPOT_CREATE_PRODUCT_OBJECT

Creates a new product in hubspot with specified properties and optional associations; ensure `hs sku` is unique if provided, custom properties are pre-defined in hubspot, and any association `to id` and `associationtypeid` are valid.

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

objectRequired

error

string

successful

booleanRequired

Get pipeline stage audit

SLUG: HUBSPOT_GET_PIPELINE_STAGE_AUDIT

Retrieves a reverse chronological list of all mutations (changes) for a specific pipeline stage; the associated pipeline id is inferred from the api path and is not a direct input.

Action Parameters

objectType

stringRequired

pipelineId

stringRequired

stageId

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

List products with paging

SLUG: HUBSPOT_LIST_PRODUCTS_WITH_PAGING

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

Action Parameters

after

string

archived

boolean

associations

array

limit

integerDefaults to 10

properties

array

propertiesWithHistory

array

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update product

SLUG: HUBSPOT_UPDATE_PRODUCT

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

objectRequired

error

string

successful

booleanRequired

Add asset association

SLUG: HUBSPOT_ADD_ASSET_ASSOCIATION

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

objectRequired

error

string

successful

booleanRequired

Add token to event template

SLUG: HUBSPOT_ADD_TOKEN_TO_EVENT_TEMPLATE

Adds a new custom data token to an existing event template for a specified hubspot application, optionally populating a crm object property if objectpropertyname is provided.

Action Parameters

appId

integerRequired

createdAt

string

eventTemplateId

stringRequired

label

stringRequired

name

stringRequired

objectPropertyName

string

options

array

type

stringRequired

updatedAt

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Archive email

SLUG: HUBSPOT_ARCHIVE

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

objectRequired

error

string

successful

booleanRequired

Archive a batch of emails by ID

SLUG: HUBSPOT_ARCHIVE_A_BATCH_OF_EMAILS_BY_ID

Archives multiple hubspot crm emails by id; ids must exist as archiving is irreversible.

Action Parameters

inputs

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Archive a batch of quotes by id

SLUG: HUBSPOT_ARCHIVE_A_BATCH_OF_QUOTES_BY_ID

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

Action Parameters

inputs

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Archive batch of companies by id

SLUG: HUBSPOT_ARCHIVE_BATCH_OF_COMPANIES_BY_ID

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

Action Parameters

inputs

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Archive batch of contacts by id

SLUG: HUBSPOT_ARCHIVE_BATCH_OF_CONTACTS_BY_ID

Archives a batch of existing contacts by their hubspot crm ids, rendering them inactive; this action is irreversible via the api and requires manual restoration or a separate unarchive endpoint.

Action Parameters

inputs

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Archive batch of deals by id

SLUG: HUBSPOT_ARCHIVE_BATCH_OF_DEALS_BY_ID

Archives a batch of existing deals by their unique hubspot ids, removing them from active views and reports (soft delete); archived deals may be restorable.

Action Parameters

inputs

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Archive batch of feedback submissions by id

SLUG: HUBSPOT_ARCHIVE_BATCH_OF_FEEDBACK_SUBMISSIONS_BY_ID

Asynchronously archives a batch of hubspot feedback submissions using their unique ids, which must correspond to valid and existing submissions; the operation is queued, and submissions are moved from active views without being deleted.

Action Parameters

inputs

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Archive batch of line items by id

SLUG: HUBSPOT_ARCHIVE_BATCH_OF_LINE_ITEMS_BY_ID

Archives a batch of existing line items by their unique ids in hubspot crm; this operation is irreversible via the api.

Action Parameters

inputs

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Archive batch of objects by id

SLUG: HUBSPOT_ARCHIVE_BATCH_OF_OBJECTS_BY_ID

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

Action Parameters

inputs

arrayRequired

objectType

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Archive batch of properties

SLUG: HUBSPOT_ARCHIVE_BATCH_OF_PROPERTIES

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

Action Parameters

inputs

arrayRequired

objectType

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Archive batch of tickets by id

SLUG: HUBSPOT_ARCHIVE_BATCH_OF_TICKETS_BY_ID

Archives a batch of existing, unarchived hubspot crm tickets by their unique ids.

Action Parameters

inputs

arrayRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Archive batch products by id

SLUG: HUBSPOT_ARCHIVE_BATCH_PRODUCTS_BY_ID

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

objectRequired

error

string

successful

booleanRequired