Skip to main content

HubSpot Connector

HubSpot Manage records and associations in the HubSpot CRM platform

Connections

HubSpot OAuth 2.0

Authenticate requests to Hubspot using OAuth 2.0.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
Authorize URLThe OAuth 2.0 Authorization URL for HubSpot. You can include optional scopes here.https://app.hubspot.com/oauth/authorize
ScopesA space-delimited set of one or more scopes to get the user's permission to access.
Client IDProvide the Client Id you received from the HubSpot Developer Console.
Client SecretProvide the Client Secret you received from the HubSpot Developer Console.
App IDProvide the App ID from the HubSpot Developer Console. Required for Webhooks.
Developer API KeyProvide the Developer API Key from the HubSpot Developer Console. Required for Webhooks.

Private App Access Token

Authenticate requests to Hubspot using a private app access token.

InputCommentsDefault
Access TokenAn access token generated when you create a private app. For testing purposes only - use OAuth 2.0 for production integrations.

Triggers

Event Type Subscription

Get notified when a HubSpot event happens.

InputCommentsDefault
Connection
Event TypesEvents to listen for. Make sure to have the right permissions.
Overwrite Webhook SettingsHubSpot only permits one Target URL per App ID. If there's an existing webhook configuration for the current one, this execution will fail unless this toggle is enabled.false

New and Updated Custom Records

Checks for new and updated custom records.

InputCommentsDefault
Show New RecordsShow new records.true
Show Updated RecordsShow updated records.true
Connection
Object TypeThe type of custom object to search for.
Search PropertiesInclude properties such as filters and sorts, or specify the properties to be returned. If empty, only the default properties will be returned. For more information, see https://developers.hubspot.com/docs/api/crm/search.
Search LimitThe number of records to return. The maximum value is 200.10
Fetch AllTurn this ON to get more than 200 results. Note that this can be a large amount of data.false
TimeoutThe maximum time a client will await a request

New and Updated Records

Checks for new and updated records.

InputCommentsDefault
Show New RecordsShow new records.true
Show Updated RecordsShow updated records.true
Connection
Search EndpointThe endpoint to search for objects or engagements. For Custom objects don't forget to fill the Object Type input.
Search PropertiesInclude properties such as filters and sorts, or specify the properties to be returned. If empty, only the default properties will be returned. For more information, see https://developers.hubspot.com/docs/api/crm/search.
Search LimitThe number of records to return. The maximum value is 200.10
Fetch AllTurn this ON to get more than 200 results. Note that this can be a large amount of data.false
TimeoutThe maximum time a client will await a request

Webhook

Receive and validate webhook requests from HubSpot for webhooks you configure.

InputCommentsDefault
Connection

Actions

Archive Association

Remove the associations between two provided objects

InputCommentsDefault
From Object TypeThe type of the "from" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
To Object TypeThe type of the "to" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
From IdProvide a value for the unique identifier of the first object
To IdProvide a value for the unique identifier of the second object
Type Of AssociationProvide a value for the type of association to perform. You can get the set of available values for this input by making a step using the "List Association Types"
TimeoutThe maximum time a client will await a request
Connection

Archive Batch Contacts

Archive a batch of contacts by ID

InputCommentsDefault
Contact IdsA list of contact IDs.
TimeoutThe maximum time a client will await a request
Connection

Archive Batch Engagement

Archives a batch of selected engagements by their IDs.

InputCommentsDefault
Connection
Engagement ObjectSelect an engagement object.
Engagement IdsA list of engagement IDs.
TimeoutThe maximum time a client will await a request

Cancel Import

Cancels an active import.

InputCommentsDefault
Connection
Import IdProvide the unique identifier of the import.
TimeoutThe maximum time a client will await a request

Create Association

Create an association between the objects identified in the step

InputCommentsDefault
From Object TypeThe type of the "from" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
To Object TypeThe type of the "to" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
From IdProvide a value for the unique identifier of the first object
To IdProvide a value for the unique identifier of the second object
Type Of AssociationProvide a value for the type of association to perform. You can get the set of available values for this input by making a step using the "List Association Types"
TimeoutThe maximum time a client will await a request
Connection

Create Batch Contacts

Create a batch of contacts

InputCommentsDefault
Connection
Batch ContactsAn array of contact objects to create. See https://developers.hubspot.com/docs/api/crm/contacts for properties.
TimeoutThe maximum time a client will await a request

Create Batch Engagement

Creates a batch of selected engagements.

InputCommentsDefault
Connection
Engagement ObjectSelect an engagement object.
Batch EngagementsAn array of engagements.
TimeoutThe maximum time a client will await a request

Create Company

Create a new company

InputCommentsDefault
Company NameProvide a string value for the name of the company
IndustryProvide a string value for the industry of the company
PhoneProvide a value for the phone number of the company.
DescriptionProvide the description of the object.
DomainProvide a string value for the domain of the company
CityProvide a string value for the city of the company
StateProvide a string value for the state of the company
ValuesThe names of the fields and their values to use when creating/updating a record.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
TimeoutThe maximum time a client will await a request
Connection

Create Contact

Create a new contact

InputCommentsDefault
First NameProvide a string value for the first name of the contact
Last NameProvide a string value for the last name of the contact
PhoneProvide a value for the phone number.
CompanyProvide a string value for the company of the contact
EmailProvide a string value for the email of the contact. Getting contacts by email performs a search function and will return a successful output even when no results are found.
WebsiteProvide a string value for the website.
ValuesThe names of the fields and their values to use when creating/updating a record.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
TimeoutThe maximum time a client will await a request
Connection

Create Custom Object

Creates new custom object schema

InputCommentsDefault
Connection
Singular LabelThe word for one object. (There's no way to change this later.)
Plural LabelThe word for multiple objects. (There's no way to change this later.)
Required PropertiesThe names of properties that should be required when creating an object of this type.["000xxx"]
Searchable PropertiesNames of properties that will be indexed for this object type in by HubSpot's product search.["000xxx"]
Secondary Display PropertiesThe names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.["000xxx"]
PropertiesProperties defined for this object type.
Associated ObjectsAssociations defined for this object type.["000xxx"]
NameA unique name for this object. For internal use only.
TimeoutThe maximum time a client will await a request
ValuesThe names of the fields and their values to use when creating/updating a record.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.

Create Deal

Create a new deal

InputCommentsDefault
AmountProvide a string value for the amount.
Close DateProvide a date representing when the sale will close.
Deal NameProvide a string value for the name of the deal
Owner IdProvide a string value for the owner of the resource
PipelineProvide a string value for which pipeline to interact with.
Deal StageProvide a value for the stage of the deal. Deal stages allow you to categorize and track the progress of the deals that you are working on.
PriorityProvide a string value for priority of the deal.
Deal TypeProvide a string value for the type of deal. By default, categorize your deal as either a New Business or Existing Business. The picklist of values for this property is configurable through HubSpot
ValuesThe names of the fields and their values to use when creating/updating a record.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
TimeoutThe maximum time a client will await a request
Connection

Create Engagement

Create a communication, email, call, meeting, note, postal mail or task engagement in HubSpot CRM.

InputCommentsDefault
Connection
Engagement ObjectSelect an engagement object.
AssociationsTo create and associate a task with existing records.
PropertiesA properties object, attributes depend on the engagement type. For possible properties for each engagement type go to https://developers.hubspot.com/docs/api/crm/tasks.
TimeoutThe maximum time a client will await a request

Create Line Item

Create a new line item

InputCommentsDefault
NameProvide a string value for the name of the line item.
Product IdProvide the unique identifier of the product.
Recurring Billing FrequencyProvide the billing frequency of the product. Specify the integer of months in between a P and M in the following format: P{integer}M
Recurring Billing Monthly RateProvide a string value for the quantity of product in the line item.
QuantityProvide a string value for the quantity of product in the line item.
PriceProvide the price of the product.
ValuesThe names of the fields and their values to use when creating/updating a record.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
TimeoutThe maximum time a client will await a request
Connection

Create Product

Create a new product

InputCommentsDefault
Product NameProvide the name of the product.
DescriptionProvide the description of the object.
Product SKUProvide the SKU of the product.
PriceProvide the price of the product.
Recurring Billing FrequencyProvide the billing frequency of the product. Specify the integer of months in between a P and M in the following format: P{integer}M
Unit CostProvide the unit cost of the product.
ValuesThe names of the fields and their values to use when creating/updating a record.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
TimeoutThe maximum time a client will await a request
Connection

Create Webhook

Create a webhook in HubSpot

InputCommentsDefault
Connection
Event TypeType of event to listen for. Can be one of create, delete, deletedForPrivacy, or propertyChange.
Property NameThe internal name of the property to monitor for changes. Only applies when eventType is propertyChange.
ActiveDetermines if the subscription is active or paused. Defaults to false.false
TimeoutThe maximum time a client will await a request

Delete all Instanced Webhooks

Delete all webhooks created by this instance in HubSpot

InputCommentsDefault
Connection
TimeoutThe maximum time a client will await a request

Delete Company

Delete an existing company by Id

InputCommentsDefault
Company IdProvide a value for the unique identifier of the company.
TimeoutThe maximum time a client will await a request
Connection

Delete Contact

Delete a contact by Id

InputCommentsDefault
Contact IdProvide a string value for the unique identifier of the contact.
TimeoutThe maximum time a client will await a request
Connection

Delete Custom Object

Removes custom object schema

InputCommentsDefault
Connection
Object TypeProvide a string value for the type of object
TimeoutThe maximum time a client will await a request
Return Archived ResultsWhether to return only results that have been archived.false

Delete Deal

Delete a deal by its Id

InputCommentsDefault
Deal IdProvide the unique identifier of the deal
TimeoutThe maximum time a client will await a request
Connection

Delete Engagement

Deletes an engagement by its ID.

InputCommentsDefault
Connection
Engagement ObjectSelect an engagement object.
Engagement IdThe unique identifier of the engagement. A taskId, meetingId, etc.
TimeoutThe maximum time a client will await a request

Delete Line Item

Delete an existing line item by Id

InputCommentsDefault
Line Item IdProvide the unique identifier of the line item.
TimeoutThe maximum time a client will await a request
Connection

Delete Product

Delete a product by Id

InputCommentsDefault
Product IdProvide the unique identifier of the product.
TimeoutThe maximum time a client will await a request
Connection

Delete Webhook

Delete a webhook by ID in HubSpot

InputCommentsDefault
Connection
Subscription IDThe ID of the subscription to delete
TimeoutThe maximum time a client will await a request

Export CRM Data

Begins exporting CRM data for the portal as specified in the request body.

InputCommentsDefault
Connection
Schema TypeSchema type for the export.VIEW
FormatThe format of the export file.CSV
Export NameThe name of the export.
Object PropertiesA list of the properties you want included in your export.
Object TypeThe name or ID of the object you're exporting. For standard objects, you can use the object's name (e.g., CONTACT), but for custom objects, you must use the objectTypeId value, you can find this value in the response of the List Custom Objects action.
LanguageThe language of the export file.
List Id (Only and required for PublicExportListRequest)The ILS List ID of the list to export.
Public CRM Search Request (Only for PublicExportViewRequest)Indicates which data should be exported based on certain property values and search queries.
Associated Object TypeThe name or ID of an associated object to include in the export. If you include an associated object, the export will contain the associated record IDs of that object and the records' primary display property value.
TimeoutThe maximum time a client will await a request

Get an Import

Get a complete summary of an import record, including any updates.

InputCommentsDefault
Connection
Import IdProvide the unique identifier of the import.
TimeoutThe maximum time a client will await a request

Get Batch Contacts

Read a batch of contacts by internal ID, or unique property values.

InputCommentsDefault
Connection
Properties With HistoryA list of properties to read by.
PropertyA list of properties to read by.
Id PropertyAn ID property to search by
Contact IdsA list of contact IDs.
Return Archived ResultsWhether to return only results that have been archived.false
TimeoutThe maximum time a client will await a request

Get Company

Retrieve the information or metadata of a company by Id, domain, or name

InputCommentsDefault
Company IdProvide a value for the unique identifier of the company.
Company NameProvide a string value for the name of the company
DomainProvide a string value for the domain of the company
Additional Properties To ReturnFor each item, provide a property you would like to be returned in the response.
Associations ListFor each item, provide an object type to retrieve the associated Ids for.
Return Archived ResultsWhether to return only results that have been archived.false
TimeoutThe maximum time a client will await a request
Connection

Get Contact

Get the information and metadata of a contact by Id or Email

InputCommentsDefault
Contact IdProvide a string value for the unique identifier of the contact.
EmailProvide a string value for the email of the contact. Getting contacts by email performs a search function and will return a successful output even when no results are found.
Additional Properties To ReturnFor each item, provide a property you would like to be returned in the response.
Associations ListFor each item, provide an object type to retrieve the associated Ids for.
Return Archived ResultsWhether to return only results that have been archived.false
TimeoutThe maximum time a client will await a request
Connection

Get Current User

Return information about the current session's user.

InputCommentsDefault
TimeoutThe maximum time a client will await a request
Connection

Get Custom Object

Retrieves a specific custom object

InputCommentsDefault
Connection
TimeoutThe maximum time a client will await a request
Object TypeProvide a string value for the type of object

Get Deal

Retrieve information and metadata about a deal by its Id or name

InputCommentsDefault
Deal IdProvide the unique identifier of the deal
Deal NameProvide a string value for the name of the deal
Additional Properties To ReturnFor each item, provide a property you would like to be returned in the response.
Associations ListFor each item, provide an object type to retrieve the associated Ids for.
Return Archived ResultsWhether to return only results that have been archived.false
TimeoutThe maximum time a client will await a request
Connection

Get Engagement

Get a communication, email, call, meeting, note, postal mail or task engagement object from HubSpot CRM.

InputCommentsDefault
Connection
Engagement ObjectSelect an engagement object.
Engagement IdThe unique identifier of the engagement. A taskId, meetingId, etc.
Properties To ReturnProperties to be returned in the response. If the specified property is not present on the requested object, it will be ignored.
Property With History To ReturnA property to be returned along with it's history of previous values. If the specified property is not present on the requested object, it will be ignored.
AssociationsList of object types to retrieve associated IDs for. If the specified association do not exist, it will be ignored.
Return Archived ResultsWhether to return only results that have been archived.false
Id PropertyThe name of a property whose values are unique for this object type.
TimeoutThe maximum time a client will await a request

Get Line Item

Retrieve the information and metadata of a line item by Id

InputCommentsDefault
Line Item IdProvide the unique identifier of the line item.
NameProvide a string value for the name of the line item.
Additional Properties To ReturnFor each item, provide a property you would like to be returned in the response.
Associations ListFor each item, provide an object type to retrieve the associated Ids for.
Return Archived ResultsWhether to return only results that have been archived.false
TimeoutThe maximum time a client will await a request
Connection

Get Product

Retrieve the information and metadata of a product by Id or name

InputCommentsDefault
Product IdProvide the unique identifier of the product.
Product NameProvide the name of the product.
Additional Properties To ReturnFor each item, provide a property you would like to be returned in the response.
Associations ListFor each item, provide an object type to retrieve the associated Ids for.
Return Archived ResultsWhether to return only results that have been archived.false
TimeoutThe maximum time a client will await a request
Connection

Import CRM Data

Import CRM records and activities into your HubSpot account, such as contacts, companies, and notes.

InputCommentsDefault
Connection
NameThe name of the import.
FilesAn array that contains your import file information. For more information, see https://developers.hubspot.com/docs/api/crm/imports.
Data CSV FileThe CSV file to import, this should be binary data from a previous step. Key name should be the file name and the value should be the binary data.
Import OperationsAn optional field used to indicate whether the import should create and update, only create, or only update records for a certain object or activity. Include the objectTypeId for the object/activity and whether you want to UPSERT (create and update), CREATE, or UPDATE records. For objectTypeId's, check https://developers.hubspot.com/docs/api/crm/understanding-the-crm#object-type-id
Date FormatThe format for dates included in the file. By default, this is set to MONTH_DAY_YEAR, but you can also use DAY_MONTH_YEAR or YEAR_MONTH_DAY.MONTH_DAY_YEAR
Marketable Contact ImportWhether the contacts being imported are marketable. If not provided, the default value is true.true
Create Contact List From ImportAn optional field to create a static list of the contacts from your import. To create a list from your file, use the value true.false
TimeoutThe maximum time a client will await a request

List Active Imports

Returns a paged list of active imports for this account.

InputCommentsDefault
Connection
TimeoutThe maximum time a client will await a request

List Association Types

Retrieve a list of all association types available between two objects

InputCommentsDefault
Connection
From Object TypeThe type of the "from" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
To Object TypeThe type of the "to" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
TimeoutThe maximum time a client will await a request

List Companies

Retrieve a list of all companies

InputCommentsDefault
Connection
Additional Properties To ReturnFor each item, provide a property you would like to be returned in the response.
Associations ListFor each item, provide an object type to retrieve the associated Ids for.
Return Archived ResultsWhether to return only results that have been archived.false
TimeoutThe maximum time a client will await a request
Fetch AllFetch all records.false
LimitProvide a number for the maximum amount of items that will be returned by the search.
Start AfterSpecify the pagination token that's returned by a previous request to retrieve the next page of results

List Contacts

Retrieve a list of all contacts

InputCommentsDefault
Connection
Additional Properties To ReturnFor each item, provide a property you would like to be returned in the response.
Associations ListFor each item, provide an object type to retrieve the associated Ids for.
Return Archived ResultsWhether to return only results that have been archived.false
TimeoutThe maximum time a client will await a request
Fetch AllFetch all records.false
LimitProvide a number for the maximum amount of items that will be returned by the search.
Start AfterSpecify the pagination token that's returned by a previous request to retrieve the next page of results

List Custom Objects

Retrieve all custom objects

InputCommentsDefault
Connection
TimeoutThe maximum time a client will await a request
Return Archived ResultsWhether to return only results that have been archived.false
Additional Properties To ReturnFor each item, provide a property you would like to be returned in the response.

List Deals

Retrieve a list of all deals

InputCommentsDefault
Connection
Return Archived ResultsWhether to return only results that have been archived.false
Additional Properties To ReturnFor each item, provide a property you would like to be returned in the response.
Associations ListFor each item, provide an object type to retrieve the associated Ids for.
TimeoutThe maximum time a client will await a request
Fetch AllFetch all records.false
LimitProvide a number for the maximum amount of items that will be returned by the search.
Start AfterSpecify the pagination token that's returned by a previous request to retrieve the next page of results

List Engagements

List engagement objects from HubSpot CRM, including communications, emails, calls, meetings, notes, postal mail, and tasks.

InputCommentsDefault
Connection
Engagement ObjectSelect an engagement object.
Properties To ReturnProperties to be returned in the response. If the specified property is not present on the requested object, it will be ignored.
TimeoutThe maximum time a client will await a request

List Line Items

Retrieve a list of all line items

InputCommentsDefault
Connection
Return Archived ResultsWhether to return only results that have been archived.false
Additional Properties To ReturnFor each item, provide a property you would like to be returned in the response.
Associations ListFor each item, provide an object type to retrieve the associated Ids for.
TimeoutThe maximum time a client will await a request
Fetch AllFetch all records.false
LimitProvide a number for the maximum amount of items that will be returned by the search.
Start AfterSpecify the pagination token that's returned by a previous request to retrieve the next page of results

List Products

Retrieve a list of all products

InputCommentsDefault
Connection
Additional Properties To ReturnFor each item, provide a property you would like to be returned in the response.
Associations ListFor each item, provide an object type to retrieve the associated Ids for.
Return Archived ResultsWhether to return only results that have been archived.false
TimeoutThe maximum time a client will await a request
Fetch AllFetch all records.false
LimitProvide a number for the maximum amount of items that will be returned by the search.
Start AfterSpecify the pagination token that's returned by a previous request to retrieve the next page of results

List Properties

Retrieve a list of all configured object properties.

InputCommentsDefault
Connection
Object TypeProvide a string value for the type of object
TimeoutThe maximum time a client will await a request

List Webhooks

List all webhooks for a server

InputCommentsDefault
Connection
TimeoutThe maximum time a client will await a request

Raw Request

Send raw HTTP request to HubSpot

InputCommentsDefault
Connection
URLInput the path only (/crm/v3/objects/deals), The base URL is already included (https://api.hubapi.com). For example, to connect to https://api.hubapi.com/crm/v3/objects/deals, only /crm/v3/objects/deals is entered in this field.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Read Association

Get the Ids of the objects associated with those specified in the step

InputCommentsDefault
From Object TypeThe type of the "from" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
To Object TypeThe type of the "to" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
To IdProvide a value for the unique identifier of the second object
TimeoutThe maximum time a client will await a request
Connection

Use the search endpoints to filter, sort, and search objects, records, and engagements across your CRM.

InputCommentsDefault
Connection
Search EndpointThe endpoint to search for objects or engagements. For Custom objects don't forget to fill the Object Type input.
Search PropertiesInclude properties such as filters and sorts, or specify the properties to be returned. If empty, only the default properties will be returned. For more information, see https://developers.hubspot.com/docs/api/crm/search.
Object TypeThe type of custom object to search for. Required for the Custom objects search endpoint.
Search LimitThe number of records to return. The maximum value is 200.10
Fetch AllTurn this ON to get more than 200 results. Note that this can be a large amount of data.false
TimeoutThe maximum time a client will await a request

Search Deals

Returns a list of deals that match the given properties

InputCommentsDefault
Property NameProvide a string value for the property you would like to search on. Please ensure the spelling and capitalization are correct for the property you want to use.
ValueProvide a string value corresponding to the given property name
OperatorProvide a string value for the operator used to search on.
LimitProvide a number for the maximum amount of items that will be returned by the search.
Start AfterSpecify the pagination token that's returned by a previous request to retrieve the next page of results
TimeoutThe maximum time a client will await a request
Connection

Update Batch Contacts

Update a batch of contacts

InputCommentsDefault
Connection
Batch ContactsAn array of contact objects to update. See https://developers.hubspot.com/docs/api/crm/contacts for properties.
TimeoutThe maximum time a client will await a request

Update Batch Engagement

Updates a batch of selected engagements.

InputCommentsDefault
Connection
Engagement ObjectSelect an engagement object.
Batch EngagementsAn array of engagement objects to update. Each engagement object must contain the required properties for the specified engagement type. See https://developers.hubspot.com/docs/api/crm/tasks for more information.
TimeoutThe maximum time a client will await a request

Update Company

Update the information and metadata of an existing company

InputCommentsDefault
Company IdProvide a value for the unique identifier of the company.
Company NameProvide a string value for the name of the company
IndustryProvide a string value for the industry of the company
DescriptionProvide the description of the object.
PhoneProvide a value for the phone number of the company.
DomainProvide a string value for the domain of the company
CityProvide a string value for the city of the company
StateProvide a string value for the state of the company
ValuesThe names of the fields and their values to use when creating/updating a record.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
TimeoutThe maximum time a client will await a request
Connection

Update Contact

Update the information and metadata of an existing contact

InputCommentsDefault
Contact IdProvide a string value for the unique identifier of the contact.
First NameProvide a string value for the first name of the contact
Last NameProvide a string value for the last name of the contact
CompanyProvide a string value for the company of the contact
EmailProvide a string value for the email of the contact
PhoneProvide a value for the phone number of the contact
WebsiteProvide a string value for the website of the contact
ValuesThe names of the fields and their values to use when creating/updating a record.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
TimeoutThe maximum time a client will await a request
Connection

Update Custom Object

Updates an object's schema

InputCommentsDefault
Connection
Fully qualified name or object type ID of your schema.Provide a string value for the type of object
Singular LabelThe word for one object. (There's no way to change this later.)
Plural LabelThe word for multiple objects. (There's no way to change this later.)
Required PropertiesThe names of properties that should be required when creating an object of this type.["000xxx"]
Searchable PropertiesNames of properties that will be indexed for this object type in by HubSpot's product search.["000xxx"]
TimeoutThe maximum time a client will await a request
ValuesThe names of the fields and their values to use when creating/updating a record.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.

Update Deal

Update the information or metadata of an existing deal

InputCommentsDefault
Deal IdProvide the unique identifier of the deal
AmountProvide a string value for the amount.
Close DateProvide a date representing when the sale will close.
Deal NameProvide a string value for the name of the deal
Owner IdProvide a string value for the owner of the resource
PipelineProvide a string value for which pipeline to interact with.
Deal StageProvide a value for the stage of the deal. Deal stages allow you to categorize and track the progress of the deals that you are working on.
PriorityProvide a string value for priority of the deal.
Deal TypeProvide a string value for the type of deal. By default, categorize your deal as either a New Business or Existing Business. The picklist of values for this property is configurable through HubSpot
ValuesThe names of the fields and their values to use when creating/updating a record.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
TimeoutThe maximum time a client will await a request
Connection

Update Engagement

Update a communication, email, call, meeting, note, postal mail or task engagement in HubSpot CRM.

InputCommentsDefault
Connection
Engagement ObjectSelect an engagement object.
Engagement IdThe unique identifier of the engagement. A taskId, meetingId, etc.
PropertiesA properties object to update, attributes depend on the engagement type. For possible properties for each engagement type go to https://developers.hubspot.com/docs/api/crm/tasks.
Id PropertyThe name of a property whose values are unique for this object type.
TimeoutThe maximum time a client will await a request

Update Line Item

Update an the information and metadata of an existing line item

InputCommentsDefault
Line Item IdProvide the unique identifier of the line item.
NameProvide a string value for the name of the line item.
Product IdProvide the unique identifier of the product.
Recurring Billing FrequencyProvide the billing frequency of the product. Specify the integer of months in between a P and M in the following format: P{integer}M
Recurring Billing Monthly RateProvide a string value for the quantity of product in the line item.
QuantityProvide a string value for the quantity of product in the line item.
PriceProvide the price of the product.
ValuesThe names of the fields and their values to use when creating/updating a record.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
TimeoutThe maximum time a client will await a request
Connection

Update Product

Update the information and metadata of an existing product

InputCommentsDefault
Product IdProvide the unique identifier of the product.
Product NameProvide the name of the product.
DescriptionProvide the description of the object.
Product SKUProvide the SKU of the product.
PriceProvide the price of the product.
Recurring Billing FrequencyProvide the billing frequency of the product. Specify the integer of months in between a P and M in the following format: P{integer}M
Unit CostProvide the unit cost of the product.
ValuesThe names of the fields and their values to use when creating/updating a record.
Dynamic FieldsA field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
TimeoutThe maximum time a client will await a request
Connection

Validate Connection

Returns a boolean value that specifies whether the provided Connection is valid

InputCommentsDefault
TimeoutThe maximum time a client will await a request
Connection