Hubspot API Integration Vol.2

Suggest Edits

These are the list of integration use cases supported by Knit for Hubspot API as part of the CRM category

Create a Product

ID: post_create_a_product
Operation: write
Entities: property, association, product
Summary: This API endpoint allows you to create a product with specified properties and associations in the HubSpot CRM. The request requires authentication via a Bearer token and must include the product properties such as name, price, and SKU in the request body. The response returns the created product's details, including its ID, creation timestamp, and properties. The API adheres to standard rate limits and requires the 'e-commerce' scope for access.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Quote

ID: post_create_a_quote
Operation: write
Entities: property, association, quote
Summary: This API endpoint allows you to create a quote with specified properties and associations. It requires authorization via a Bearer token and accepts a JSON body containing 'associations' and 'properties'. The 'associations' parameter is an array of objects that define the types and target object IDs for associations. The 'properties' parameter is an object containing key-value pairs for the quote's properties. Upon successful creation, the API returns a 201 status code along with the created quote's details, including its ID, creation timestamp, and properties with history. In case of errors, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Ticket

ID: post_create_a_ticket
Operation: write
Entities: property, association, ticket
Summary: This API endpoint allows you to create a ticket with specified properties and associations in HubSpot. The request requires authentication via a Bearer token and must include a JSON body with 'associations' and 'properties'. The 'associations' field is an array of objects that define the types and target object IDs for associations. The 'properties' field is an object containing key-value pairs for ticket properties. Upon successful creation, the API returns a 201 status code along with the ticket's details, including its ID, creation timestamp, and properties. If there is an error, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create an Association Between Object Types

ID: post_create_association
Operation: write
Entities: association, schema, object type
Summary: This API endpoint creates a new association between a primary schema's object type and another object type. The request requires the 'content-type' header to be set to 'application/json'. The path parameter 'objectType' is required to specify the fully qualified name or object type ID of your schema. The body of the request must include 'fromObjectTypeId' (ID of the primary object type), 'name' (a unique name for the association), and 'toObjectTypeId' (ID of the target object type). Upon successful creation, the response includes details such as 'createdAt', 'fromObjectTypeId', 'name', 'id', 'toObjectTypeId', and 'updatedAt'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Calls

ID: post_create_batch_of_calls
Operation: write
Entities: property, association, call
Summary: This API endpoint allows you to create a batch of calls in HubSpot. It requires authentication via OAuth or private apps. The request body must include an array of call objects, each with associations and properties. The associations define the relationships of the call with other objects, while properties define the call's attributes. The response includes timestamps for when the operation was requested, started, and completed, as well as the results of the batch operation, including the created calls and their properties. The API returns a status of the operation, which can be 'PENDING', 'COMPLETED', or 'ERROR'.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Carts

ID: post_create_batch_of_carts
Operation: write
Entities: cart, association, property
Summary: This API endpoint allows you to create a batch of carts in HubSpot. It requires authentication via OAuth or private apps. The request body must include an array of cart objects, each containing properties such as 'hs_cart_name', 'hs_currency_code', and 'hs_external_cart_id'. Associations can also be specified for each cart. The response will include details about the creation status of each cart, including timestamps and properties. The API supports standard rate limits and requires the 'crm.objects.carts.write' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Communications

ID: post_create_batch_of_communications
Operation: write
Entities: property, association, communication
Summary: This API endpoint allows you to create a batch of communications in HubSpot. It requires authentication via a Bearer token and accepts a JSON body containing an array of communication objects. Each communication object can have associations and properties. The response includes timestamps for when the operation was requested, started, and completed, as well as details about each communication created, including its properties and history. The API supports OAuth and requires the 'crm.objects.contacts.write' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Companies

ID: post_create_batch_of_companies
Operation: write
Entities: property, association, company
Summary: This API endpoint allows you to create a batch of companies in HubSpot. It requires the 'crm.objects.companies.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of company objects, each with optional associations and properties. The response will include timestamps for when the operation was requested, started, and completed, as well as details about each company created, including their properties and history. The status of the operation is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Contacts

ID: post_create_batch_of_contacts
Operation: write
Entities: property, association, contact
Summary: This API endpoint allows you to create a batch of contacts in HubSpot. It requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of contact objects, each with optional associations and properties. The response will include timestamps for when the operation was requested, started, and completed, as well as details about the created contacts, including their properties and history. The status of the operation will also be provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of CRM Objects

ID: post_create_batch_of_crm_objects
Operation: write
Entities: property, association, object
Summary: This API endpoint allows you to create a batch of CRM objects in HubSpot. You need to specify the object type as a path parameter. The request body should contain an array of objects to be created, each with its properties and associations. The API requires authentication via a Bearer token. The response includes timestamps for when the request was made, started, and completed, along with the status of the operation and details of the created objects. The API supports various scopes for different CRM object types.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Discounts

ID: post_create_batch_of_discounts
Operation: write
Entities: discount, association, property
Summary: This API endpoint allows the creation of a batch of discounts in the CRM system. It requires authentication via a Bearer token and accepts a JSON body containing an array of discount objects. Each discount object can have associations and properties. The response includes timestamps for when the operation was requested, started, and completed, along with the results of the operation, including the properties and history of each created discount. The API supports standard and granular scopes for e-commerce and CRM objects line items write access.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Emails

ID: post_create_batch_of_emails
Operation: write
Entities: contact, email
Summary: This API endpoint allows you to create a batch of emails in HubSpot. It requires authorization via a Bearer token and accepts a JSON body containing an array of email objects. Each email object can have associations and properties. The response includes timestamps for when the operation was requested, started, and completed, as well as details about the created emails, including their properties and history. The API supports standard and granular scopes and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Leads

ID: post_create_batch_of_leads
Operation: write
Entities: lead, association, property
Summary: This API endpoint allows you to create a batch of leads in HubSpot. It requires the 'crm.objects.leads.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of lead objects, each with optional associations and properties. The response will include timestamps for when the operation was requested, started, and completed, as well as details about each lead created, including their properties and history. The status of the operation will be indicated in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Line Items

ID: post_create_batch_of_line_items
Operation: write
Entities: property, association, line item
Summary: This API endpoint allows you to create a batch of line items in HubSpot. It requires authentication via a Bearer token and accepts a JSON body containing an array of line items. Each line item can have associations and properties. The response includes timestamps for when the operation was requested, started, and completed, as well as details about each created line item, including its properties and history. The API supports standard and granular scopes for e-commerce and line item writing, respectively.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Meetings

ID: post_create_batch_of_meetings
Operation: write
Entities: property, association, meeting
Summary: This API endpoint allows the creation of a batch of meetings in HubSpot. It requires authorization via a Bearer token and accepts a JSON body containing an array of meeting objects. Each meeting object can have associations and properties. The response includes timestamps for when the operation was requested, started, and completed, along with the results of the created meetings. The API supports standard rate limits and requires the 'crm.objects.contacts.write' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Notes

ID: post_create_batch_of_notes
Operation: write
Entities: property, association, note
Summary: This API endpoint allows you to create a batch of notes in HubSpot. It requires authentication via a Bearer token and accepts a JSON body containing an array of note objects. Each note object can have associations and properties. The response includes timestamps for when the operation was requested, started, and completed, as well as details about each note created, including its properties and history. The API supports OAuth and requires the 'crm.objects.contacts.write' scope. It adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Orders

ID: post_create_batch_of_orders
Operation: write
Entities: property, association, order
Summary: This API endpoint allows you to create a batch of orders in HubSpot. It requires authentication via OAuth and the 'crm.objects.orders.write' scope. The request body must include an array of order objects, each containing associations and properties. The response will include timestamps for when the operation was requested, started, and completed, as well as details about each order created. If errors occur, they will be detailed in the response, including error categories, messages, and context.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Postal Mail

ID: post_create_batch_of_postal_mail
Operation: write
Entities: property, association, postal mail
Summary: This API endpoint allows you to create a batch of postal mail objects in HubSpot. It requires authentication via OAuth and the 'crm.objects.contacts.write' scope. The request body must include an array of postal mail objects, each with associations and properties. The response includes timestamps for when the request was completed, started, and requested, as well as details about each postal mail object created, including its properties and history. The API returns a status of 'PENDING' upon successful creation.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Products

ID: post_create_batch_of_products
Operation: write
Entities: property, association, product
Summary: This API endpoint allows you to create a batch of products in HubSpot. It requires an authorization bearer token and a content-type header set to application/json. The request body must include an array of product objects, each containing associations and properties. The associations define relationships with other objects, while properties define the product's attributes such as name, price, and SKU. The response includes timestamps for when the operation was requested, started, and completed, along with the status of the operation and details of each created product.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Properties

ID: post_create_batch_of_properties
Operation: write
Entities: property, option, modification metadata
Summary: This API endpoint allows you to create a batch of properties for a specified object type in HubSpot. The request requires authentication via a Bearer token and the object type as a path parameter. The body of the request should contain an array of property objects, each with attributes such as 'hidden', 'displayOrder', 'description', 'label', 'type', 'formField', 'groupName', 'referencedObjectType', 'name', 'options', 'calculationFormula', 'hasUniqueValue', 'fieldType', and 'externalOptions'. The response will include details about the created properties, including their creation and update timestamps, and their status. The API supports standard and granular scopes and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Quotes

ID: post_create_batch_of_quotes
Operation: write
Entities: property, association, quote
Summary: This API endpoint allows the creation of a batch of quotes in HubSpot. It requires authentication via OAuth or private apps. The request body must include an array of quote objects, each containing associations and properties. The associations define the relationships of the quote with other objects, while properties define the attributes of the quote. The response includes timestamps for the request, start, and completion of the operation, links related to the operation, and the results for each quote created. The status of the operation is also provided. The API adheres to standard API rate limits and requires specific scopes for access.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Tasks

ID: post_create_batch_of_tasks
Operation: write
Entities: property, association, task
Summary: This API endpoint allows you to create a batch of tasks in HubSpot. It requires authorization via a Bearer token and accepts a JSON body containing an array of task objects. Each task object can have associations and properties. The response includes timestamps for when the operation was requested, started, and completed, as well as details about each created task, including its properties and history. The API supports OAuth and private apps, and requires the 'crm.objects.contacts.write' scope. The response can vary based on the operation's success, with HTTP 201 indicating successful creation and HTTP 207 indicating multiple statuses.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Taxes

ID: post_create_batch_of_taxes
Operation: write
Entities: property, tax, association
Summary: This API endpoint allows you to create a batch of tax objects in HubSpot. It requires authentication via OAuth and the 'crm.objects.line_items.write' scope. The request body must include an array of tax objects, each with associations and properties. The response will include timestamps for when the request was made, started, and completed, as well as details about each created tax object, including its properties and history. The status of the operation is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Batch of Tickets

ID: post_create_batch_of_tickets
Operation: write
Entities: property, association, ticket
Summary: This API endpoint allows you to create a batch of tickets in HubSpot. It requires authentication via a Bearer token and accepts a JSON body containing an array of ticket objects. Each ticket object can have associations and properties. The response includes timestamps for when the operation was requested, started, and completed, as well as details about each created ticket, including its properties and history. The API adheres to standard rate limits and requires the 'tickets' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Call with Given Properties

ID: post_create_call_with_given_properties
Operation: write
Entities: property, association, call
Summary: This API endpoint allows you to create a call with specified properties and associations in HubSpot. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request includes 'associations', which is an array of objects defining the types and target ID of the association, and 'properties', which is an object containing additional properties of the call. Upon successful creation, the API returns a 201 status code along with the details of the created call, including its ID, creation timestamp, and properties. If there is an error, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Contact in HubSpot CRM

ID: post_create_contact_in_hubspot_crm
Operation: write
Entities: property, association, contact
Summary: This API endpoint allows you to create a contact in HubSpot CRM with specified properties and associations. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request includes 'associations' and 'properties'. Associations are defined as an array of objects, each containing types and a target object ID. Properties are defined as an object with additional properties. Upon successful creation, the API returns a 201 status code with the contact's details, including its ID, creation timestamp, and properties with history. In case of errors, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create CRM Object

ID: post_create_crm_object
Operation: write
Entities: property, association, object
Summary: This API endpoint allows you to create a CRM object with specified properties and associations. The request requires a path parameter 'objectType' to specify the type of CRM object to create. The request body includes 'associations' and 'properties' to define the relationships and attributes of the object. The response returns the created object, including its ID, creation timestamp, and properties with history. The API requires authentication via a Bearer token and supports various scopes for access control. In case of errors, detailed error messages and context are provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create Default Associations

ID: post_create_default_associations
Operation: write
Entities: association, scope, object type
Summary: The Create Default Associations API allows you to create the default (most generic) association type between two object types in HubSpot. It requires authentication via a Bearer token and supports various scopes for access. The API accepts path parameters 'fromObjectType' and 'toObjectType' to specify the types of objects being associated. The request body must include an array of 'inputs', each containing 'from' and 'to' objects with their respective IDs. The response includes timestamps for the request, start, and completion of the operation, along with any errors encountered. The results array provides details of the associations created, and any errors are detailed in the errors array.
Input Fields: Input Fields
Output Fields: Output Fields

Create Email with Given Properties

ID: post_create_email_with_given_properties
Operation: write
Entities: property, association, email
Summary: This API endpoint allows you to create an email with specified properties and associations. The request requires authorization via a Bearer token and must include a JSON body with 'associations' and 'properties'. The 'associations' field is an array of objects that define the types and target ID of the associations. The 'properties' field is an object containing key-value pairs for the email properties. Upon successful creation, the API returns a 201 status code along with the created email's details, including its ID, creation timestamp, and properties with history. In case of errors, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create Event Template for App

ID: post_create_event_template_for_app
Operation: write
Entities: CRM object, token, event template
Summary: This API endpoint allows developers to create an event template for their app. Event templates define the structure for a custom timeline event, including formatted copy for its heading and details, as well as any custom property definitions. The API requires the app ID as a path parameter and the developer's API key as a query parameter. The request body must include the detail template, name, tokens, header template, and object type. The response includes the created event template's ID, object type, creation and update timestamps, name, header template, detail template, and tokens.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Fee with Given Properties

ID: post_create_fee_with_given_properties
Operation: write
Entities: property, association, fee
Summary: This API endpoint allows you to create a fee with specified properties and associations. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request includes 'associations', which is an array of objects defining the types and target object IDs, and 'properties', which is an object containing key-value pairs for the fee's properties. Upon successful creation, the API returns a 201 status code along with the created fee's details, including its ID, creation timestamp, and properties with history. In case of errors, a detailed error message is provided with context and remediation steps.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Folder in HubSpot CRM

ID: post_create_folder_in_hubspot_crm
Operation: write
Entities: user, scope, folder
Summary: This API creates a folder in the HubSpot CRM. It requires authorization via a Bearer token and accepts JSON input specifying the name of the folder and optionally the parent folder ID. The response includes details of the created folder such as its ID, name, creation timestamp, and other metadata. If the parent folder ID is not specified, the folder is created in the root directory. The API requires 'crm.lists.write' and 'crm.lists.read' scopes and is subject to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Create Line Item

ID: post_create_line_item
Operation: write
Entities: property, association, line item
Summary: This API endpoint allows you to create a line item with specified properties and associations in HubSpot. The request requires authorization via a Bearer token and must include a JSON body with 'associations' and 'properties'. The 'associations' field is an array of objects that define the association types and the associated object ID. The 'properties' field is an object containing key-value pairs for the line item's properties. Upon successful creation, the API returns a 201 status code along with the created line item's details, including its ID, properties, and timestamps. If there is an error, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create List

ID: post_create_list
Operation: write
Entities: list, property, filter
Summary: The Create List API allows users to create a new list with a specified object list definition. It requires the 'crm.lists.write' scope and adheres to standard API rate limits. The request body must include the 'objectTypeId', 'processingType', and 'name' parameters, while 'customProperties', 'listFolderId', and 'filterBranch' are optional. The response includes details about the created list, such as its processing type, object type ID, list ID, creation time, and more. In case of errors, detailed error messages and context are provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create Multiple Timeline Events

ID: post_create_multiple_timeline_events
Operation: write
Entities: template, contact, event
Summary: This API endpoint allows the creation of multiple timeline events in batches based on an event template. The events are immutable once created and can update object properties if configured. The request requires an array of event objects, each containing details such as email, tokens, extra data, timeline iframe details, and an event template ID. The response includes the status of the batch operation, timestamps, and details of each created event.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New Card for HubSpot CRM

ID: post_create_new_card
Operation: write
Entities: account, contact, card
Summary: This API endpoint allows developers to create a new card for HubSpot CRM. The card becomes active when the app is installed. The request requires a developer API key and includes parameters such as the app ID, card configuration details, and display properties. The response includes details about the created card, such as its title, fetch configuration, display properties, and actions. The API supports custom user actions and allows specifying CRM object types where the card should be displayed.
Input Fields: Input Fields
Output Fields: Output Fields

Create a New CRM Object Schema

ID: post_create_new_crm_object_schema
Operation: write
Entities: property, association, object schema
Summary: This API endpoint allows you to create a new CRM object schema in HubSpot. You can define a new object type, its properties, and associations. The request body includes parameters such as 'secondaryDisplayProperties', 'requiredProperties', 'searchableProperties', 'primaryDisplayProperty', 'name', 'description', 'associatedObjects', 'properties', and 'labels'. The response returns the entire object schema, including its object type ID, properties, and associations. The response also includes metadata such as creation and update timestamps, user IDs, and property details.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Note in HubSpot CRM

ID: post_create_note_in_hubspot_crm
Operation: write
Entities: property, association, note
Summary: This API endpoint allows you to create a note in HubSpot CRM with specified properties and associations. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request includes an array of associations and a properties object. The response returns a copy of the created note object, including its ID, creation timestamp, and properties with history. If there is an error, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Replace Deal Splits for Deals

ID: post_create_or_replace_deal_splits
Operation: write
Entities: deal, split, owner
Summary: This API endpoint allows you to create or replace deal splits for deals with the provided IDs. The deal split percentages for each deal must sum up to 1.0 (100%) and can have up to 8 decimal places. The request requires an authorization bearer token and a content-type header set to application/json. The body of the request should contain an array of inputs, each with an array of splits specifying the percentage and ownerId, and the deal id. The response includes timestamps for when the operation was requested, started, and completed, along with the results of the operation, which include details about each split such as creation and update timestamps, archived status, and properties. The status of the operation is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Calls by Unique Property Values

ID: post_create_or_update_batch_calls
Operation: write
Entities: property, call, error
Summary: This API endpoint allows you to create or update a batch of call records in the CRM by specifying unique property values. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request should contain an array of call records, each identified by a unique property specified by the idProperty parameter. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of each call record processed.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Communications by Unique Property Values

ID: post_create_or_update_batch_communications
Operation: write
Entities: property, contact, communication
Summary: This API endpoint allows you to create or update a batch of communication records identified by a unique property value specified by the idProperty query parameter. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request should contain an array of inputs, each with an idProperty, id, and additional properties. The response includes timestamps for when the operation was requested, started, and completed, as well as details of the results and any errors encountered. The API requires the crm.objects.contacts.write scope and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Contacts by Unique Property Values

ID: post_create_or_update_batch_contacts
Operation: write
Entities: property, contact, error
Summary: This API endpoint allows you to create or update a batch of contact records in HubSpot CRM by specifying unique property values. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request should contain an array of contact records, each with an idProperty indicating the unique property, an id, and a set of properties. The response includes timestamps for when the operation was requested, started, and completed, as well as the results of the operation, including the created or updated contacts and their properties. The status of the operation is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Discounts by Unique Property Values

ID: post_create_or_update_batch_discounts
Operation: write
Entities: discount, error, property
Summary: This API endpoint allows you to create or update a batch of discount records in the CRM system by specifying unique property values. The request requires an authorization token and a content-type header. The body of the request should contain an array of discount objects, each identified by a unique property specified by the 'idProperty' field. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of each discount record processed. The API supports standard and granular scopes for e-commerce and CRM objects line items write operations.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Emails by Unique Property Values

ID: post_create_or_update_batch_emails
Operation: write
Entities: property, email, error
Summary: This API endpoint allows you to create or update a batch of email records identified by a unique property value specified by the idProperty query parameter. The request requires authorization via a Bearer token and the content type must be set to application/json. The body of the request should contain an array of email records, each with a unique idProperty, id, and a set of properties. The response will include timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of each email record processed.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Line Items by Unique Property Values

ID: post_create_or_update_batch_line_items
Operation: write
Entities: property, line item, error
Summary: This API endpoint allows you to create or update a batch of line items in the CRM by specifying unique property values. The request requires an authorization token and a content-type header. The body of the request should contain an array of line items, each with a unique idProperty, an id, and a set of properties. The response will include timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of each line item processed. The API supports standard and granular scopes for e-commerce and CRM objects, and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Meetings by Unique Property Values

ID: post_create_or_update_batch_meetings
Operation: write
Entities: property, meeting, error
Summary: This API endpoint allows you to create or update a batch of meeting records in HubSpot CRM by specifying unique property values. The request requires an authorization bearer token and a content-type header set to application/json. The body of the request should contain an array of meeting records, each identified by a unique property specified by the 'idProperty' field. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of each meeting record processed.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Notes by Unique Property Values

ID: post_create_or_update_batch_notes
Operation: write
Entities: property, error, note
Summary: This API endpoint allows you to create or update a batch of notes in the CRM system by specifying unique property values. The request requires an authorization bearer token and a content-type header set to application/json. The body of the request should contain an array of inputs, each with an idProperty, id, and additional properties. The idProperty is a unique identifier for the note. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of the notes processed.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of CRM Objects by Unique Property Values

ID: post_create_or_update_batch_objects
Operation: write
Entities: property, scope, object
Summary: This API endpoint allows you to create or update a batch of CRM objects identified by a unique property value specified by the idProperty query parameter. The endpoint requires authentication via a Bearer token and supports various scopes for access control. The request body must include an array of objects with their unique idProperty, id, and properties. The response provides details about the operation's completion, including timestamps, links, and results for each object processed. The API supports standard API rate limits and returns detailed error information in case of validation errors.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Carts by Unique Property Values

ID: post_create_or_update_batch_of_carts
Operation: write
Entities: cart
Summary: This API endpoint allows you to create or update a batch of cart records in HubSpot CRM by specifying unique property values. The unique property is defined by the 'idProperty' query parameter. The request requires authentication via a Bearer token and the content type must be 'application/json'. The request body should include an array of cart objects, each with a unique 'idProperty', 'id', and a set of properties such as 'hs_cart_name', 'hs_currency_code', and 'hs_external_cart_id'. The response will include timestamps for when the operation was requested, started, and completed, along with the status of the operation and details of the cart records processed.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Companies by Unique Property Values

ID: post_create_or_update_batch_of_companies
Operation: write
Entities: property, company, error
Summary: This API endpoint allows you to create or update a batch of company records in HubSpot CRM by specifying unique property values. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request should contain an array of company records, each identified by a unique property specified by the 'idProperty' field. The response includes timestamps for when the operation was requested, started, and completed, as well as details about each company record processed, including creation and update timestamps, properties, and status.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Deals by Unique Property Values

ID: post_create_or_update_batch_of_deals
Operation: write
Entities: property, deal, error
Summary: This API endpoint allows you to create or update a batch of deals in HubSpot CRM by specifying unique property values. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request should contain an array of deal objects, each with an idProperty, id, and properties. The idProperty is a unique identifier for the object. The response includes timestamps for when the operation was requested, started, and completed, as well as the results of the operation, including the properties and history of each deal. The status of the operation is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Fees by Unique Property Values

ID: post_create_or_update_batch_of_fees
Operation: write
Entities: property, fee, error
Summary: This API endpoint allows you to create or update a batch of fee records identified by a unique property value specified by the idProperty query parameter. The request requires authorization via a Bearer token and the content type must be set to application/json. The body of the request should contain an array of inputs, each with an idProperty, id, and properties. The response will include timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of each record processed. The API supports standard e-commerce and granular CRM scopes, and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Leads by Unique Property Values

ID: post_create_or_update_batch_of_leads
Operation: write
Entities: lead, error, property
Summary: This API endpoint allows you to create or update a batch of leads in the CRM system by specifying unique property values. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request should contain an array of lead objects, each with a unique idProperty, id, and a set of properties. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of each lead processed. The API supports OAuth and requires the 'crm.objects.leads.write' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Products by Unique Property Values

ID: post_create_or_update_batch_of_products
Operation: write
Entities: property, error, product
Summary: This API endpoint allows you to create or update a batch of product records in the CRM system by specifying unique property values. The request requires an array of product records, each identified by a unique property specified by the 'idProperty' parameter. The request body must include the 'inputs' array containing objects with 'idProperty', 'id', and 'properties'. The response provides details about the operation, including timestamps, links, and the status of each product record processed. The API supports standard e-commerce scopes and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Quotes by Unique Property Values

ID: post_create_or_update_batch_of_quotes
Operation: write
Entities: property, error, quote
Summary: This API endpoint allows you to create or update a batch of quotes identified by a unique property value specified by the idProperty query parameter. The request requires an array of quote objects, each containing an idProperty, id, and additional properties. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of each quote processed. The API requires authentication via a Bearer token and supports standard and granular scopes for e-commerce and CRM objects.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Taxes by Unique Property Values

ID: post_create_or_update_batch_of_taxes
Operation: write
Entities: property, tax, error
Summary: This API endpoint allows you to create or update a batch of tax records identified by a unique property value specified by the idProperty query parameter. The request requires authorization via a Bearer token and a content-type of application/json. The body of the request should contain an array of objects, each with an idProperty, id, and properties. The response includes timestamps for when the operation was requested, started, and completed, as well as the results of the operation, including the properties and history of each object. The status of the operation is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Tickets by Unique Property Values

ID: post_create_or_update_batch_of_tickets
Operation: write
Entities: property, ticket, error
Summary: This API endpoint allows you to create or update a batch of tickets in the CRM system by specifying unique property values. The request requires an authorization token and a content-type header. The body of the request should contain an array of inputs, each with an idProperty, id, and additional properties. The response will include timestamps for when the operation was requested, started, and completed, as well as details about the created or updated tickets, including their properties and history. The status of the operation is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Orders by Unique Property Values

ID: post_create_or_update_batch_orders
Operation: write
Entities: order
Summary: This API endpoint allows you to create or update a batch of orders identified by unique property values. The unique property is specified by the 'idProperty' query parameter. The request requires authentication via a Bearer token and the content type must be 'application/json'. The request body should contain an array of order objects, each with an 'idProperty', 'id', and 'properties'. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of each order processed. The API supports standard rate limits and requires the 'crm.objects.orders.write' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Postal Mail by Unique Property Values

ID: post_create_or_update_batch_postal_mail
Operation: write
Entities: property, postal mail, error
Summary: This API endpoint allows you to create or update a batch of postal mail records identified by a unique property value specified by the idProperty query parameter. The request requires an authorization bearer token and a content-type header set to application/json. The body of the request should contain an array of objects, each with an idProperty, id, and properties. The response includes timestamps for when the operation was requested, started, and completed, as well as the results of the operation, including the properties and history of each object. The status of the operation is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create or Update a Batch of Tasks by Unique Property Values

ID: post_create_or_update_batch_tasks
Operation: write
Entities: link, error, task
Summary: This API endpoint allows you to create or update a batch of tasks in HubSpot CRM by specifying unique property values. The tasks are identified by a unique property value provided in the 'idProperty' field. The request body must include an array of task objects, each containing 'idProperty', 'id', and 'properties'. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of each task processed. The API requires authorization via a Bearer token and supports OAuth and private apps.
Input Fields: Input Fields
Output Fields: Output Fields

Create Order

ID: post_create_order
Operation: write
Entities: property, association, order
Summary: This API endpoint allows you to create an order with specified properties and associations. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request should include an array of associations, each with a category and type ID, and a target object ID. Additionally, you can specify properties for the order as key-value pairs. Upon successful creation, the API returns a 201 status code along with the order's ID, creation timestamp, and other details. If there is an error, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Pipeline Stage

ID: post_create_pipeline_stage
Operation: write
Entities: metadata, stage, pipeline
Summary: This API endpoint allows you to create a new stage associated with a specified pipeline in HubSpot. The endpoint requires the objectType and pipelineId as path parameters. The request body must include the displayOrder and label for the new stage, and optionally metadata such as probability for deals or ticketState for tickets. The response returns the entire stage object, including its unique ID, creation date, and other metadata. The API requires authorization via a Bearer token and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Create Postal Mail

ID: post_create_postal_mail
Operation: write
Entities: postal mail
Summary: This API endpoint allows you to create a postal mail object in the CRM system. It requires authentication via a Bearer token and accepts a JSON body with associations and properties. The associations array can include multiple association types and target objects. The properties object can include various key-value pairs representing the postal mail's attributes. Upon successful creation, the API returns a 201 status code along with the created postal mail object, including its ID, creation timestamp, and properties with history. If there is an error, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Property for a Specified Object Type

ID: post_create_property_for_specified_object_type
Operation: write
Entities: property, user, object type
Summary: This API endpoint allows you to create a new property for a specified object type in HubSpot. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The objectType path parameter specifies the type of object for which the property is being created. The request body includes various parameters such as hidden, displayOrder, description, label, type, groupName, name, fieldType, formField, referencedObjectType, options, calculationFormula, hasUniqueValue, and externalOptions. The response returns details about the created property, including its ID, visibility, metadata, display order, description, label, type, group name, options, and timestamps for creation and updates.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Property Group

ID: post_create_property_group
Operation: write
Entities: scope, error, property group
Summary: This API creates a new property group for a specified object type in HubSpot. It requires authentication via a Bearer token and accepts a JSON body with the parameters 'name', 'displayOrder', and 'label'. The 'name' is the internal name used for referencing the property group, 'displayOrder' determines the order of display, and 'label' is a human-readable label. The response includes the details of the created property group, including whether it is archived, its name, display order, and label.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Single Timeline Event

ID: post_create_single_timeline_event
Operation: write
Entities: template, contact, event
Summary: This API endpoint creates a single timeline event based on a specified event template. The event is immutable once created and may update object properties if configured. The request requires an event template ID and a CRM object identifier, with optional parameters for additional data, iframe details, domain, tokens, and contact information. The response includes the event's unique ID, associated object type, and other details. Errors are returned with detailed context and remediation steps.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Task in HubSpot CRM

ID: post_create_task_in_hubspot_crm
Operation: write
Entities: property, association, task
Summary: This API endpoint allows you to create a task in HubSpot CRM with specified properties and associations. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request includes 'associations' and 'properties'. Associations are defined as an array of objects, each containing 'types' and 'to' fields. Properties are defined as an object with additional properties. Upon successful creation, the API returns a 201 status code with details of the created task, including its ID, creation timestamp, and properties. If there is an error, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create a Tax Object

ID: post_create_tax_object
Operation: write
Entities: property, tax, association
Summary: This API endpoint allows you to create a tax object with specified properties and associations. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request includes an array of associations and a properties object with additional properties. Upon successful creation, the API returns a copy of the tax object, including its ID, creation timestamp, and other details. The response also includes properties with history, showing changes over time. If there is an error, a detailed error message with context and remediation steps is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Create User Defined Association Definition

ID: post_create_user_defined_association_definition
Operation: write
Entities: label, association definition, category
Summary: This API endpoint allows the creation of a user-defined association definition between two object types in HubSpot. The request requires authorization via a Bearer token and must include the content type as 'application/json'. The path parameters 'fromObjectType' and 'toObjectType' specify the object types involved in the association. The request body must include 'inverseLabel', 'name', and 'label' to define the association. The response returns an array of results with each result containing 'typeId', 'label', and 'category' of the association.
Input Fields: Input Fields
Output Fields: Output Fields

Delete Specific Association Labels

ID: post_delete_specific_association_labels
Operation: write
Entities: label, association, object
Summary: This API endpoint allows for batch deletion of specific association labels between objects in HubSpot. It requires authentication via a bearer token and supports various scopes for access. The request includes path parameters for the object types involved, and a body containing details of the associations to be deleted. The response is typically a 204 No Content on success, but may include detailed error information if something goes wrong.
Input Fields: Input Fields
Output Fields: Output Fields

GDPR Delete Contact

ID: post_gdpr_delete_contact
Operation: write
Entities: GDPR, content, contact
Summary: The GDPR Delete Contact API permanently deletes a contact and all associated content to comply with GDPR regulations. It allows identifying the contact by a unique property, such as an email address, using the 'idProperty' parameter. If the email address is not found, it is added to a blocklist to prevent future use. The API requires 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a JSON body with 'idProperty' and 'objectId'. A successful request returns a 204 No Content response. In case of errors, a detailed error object is returned with information about the error category, message, and context.
Input Fields: Input Fields
Output Fields: Output Fields

Generate High Usage Report for User

ID: post_generate_high_usage_report_for_user
Operation: write
Entities: usage report, error, user
Summary: This API endpoint generates a high usage report for a specified user. It requires a valid OAuth token with appropriate scopes for authorization. The userId is a path parameter that specifies the user for whom the report is generated. The response includes the user's email, userId, and enqueue time details. In case of errors, a detailed error object is returned with information about the error category, message, and context.
Input Fields: Input Fields
Output Fields: Output Fields

Mark Recording as Ready for Transcription

ID: post_mark_recording_as_ready_for_transcription
Operation: write
Entities: recording, call, transcription
Summary: This API marks a call recording as ready for transcription by specifying the call using its engagement ID. It requires the 'crm.schemas.contacts.write' or 'crm.objects.contacts.write' scopes for authentication. The request must include the engagement ID in the body and the authorization bearer token in the headers. A successful request returns a 204 No Content response. In case of errors, a detailed error object is returned with information such as subCategory, context, correlationId, links, message, category, and errors array.
Input Fields: Input Fields
Output Fields: Output Fields

Merge Two Companies with Same Type

ID: post_merge_two_companies_with_same_type
Operation: write
Entities: property, company, error
Summary: This API endpoint allows you to merge two companies of the same type in HubSpot. It requires the IDs of the two companies: 'objectIdToMerge' for the company to be merged and 'primaryObjectId' for the primary company that will remain after the merge. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. Upon successful merging, the API returns details of the merged company, including creation and update timestamps, properties, and history. If an error occurs, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Merge Two Contacts with Same Type

ID: post_merge_two_contacts_with_same_type
Operation: write
Entities: property, contact, error
Summary: This API endpoint merges two contacts of the same type in HubSpot. It requires the IDs of the contact to be merged and the primary contact. The request must include an authorization bearer token and specify the content type as JSON. Upon successful merging, it returns details of the merged contact including creation and update timestamps, properties, and history of changes. If an error occurs, it provides detailed error information including missing scopes, invalid property names, and a correlation ID for support.
Input Fields: Input Fields
Output Fields: Output Fields

Merge Two Deals with Same Type

ID: post_merge_two_deals_with_same_type
Operation: write
Entities: property, deal, error
Summary: This API endpoint merges two deals of the same type in HubSpot. It requires the IDs of the two deals: 'objectIdToMerge' for the deal to be merged and 'primaryObjectId' for the primary deal. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. Upon successful merging, the API returns details of the merged deal, including creation and update timestamps, properties, and history. In case of an error, a detailed error message is provided with context and remediation steps.
Input Fields: Input Fields
Output Fields: Output Fields

Merge Two Tickets with Same Type

ID: post_merge_two_tickets_with_same_type
Operation: write
Entities: ticket
Summary: This API endpoint allows you to merge two tickets of the same type in the CRM system. It requires the IDs of the two tickets: 'objectIdToMerge' for the ticket to be merged and 'primaryObjectId' for the primary ticket. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. Upon successful merging, the response includes details of the merged ticket such as creation and update timestamps, properties, and history of changes. In case of an error, a detailed error message with context and remediation steps is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Calls by Internal ID or Unique Property Values

ID: post_read_batch_calls
Operation: read
Entities: property, call, error
Summary: This API endpoint allows you to read a batch of calls by their internal ID or unique property values. It requires the 'crm.objects.contacts.read' scope and adheres to standard API rate limits. The request can include optional query parameters such as 'archived' to filter archived results. The request body can include 'propertiesWithHistory', 'idProperty', 'inputs', and 'properties' to specify the details of the calls to be retrieved. The response includes timestamps for completion, request, and start, along with links, results, and status. Each result contains details such as creation and update timestamps, archived status, properties with history, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Commerce Payments by Internal ID or Unique Property Values

ID: post_read_batch_commerce_payments
Operation: read
Entities: property, commerce payment, error
Summary: This API endpoint allows you to read a batch of commerce payments by their internal ID or unique property values. It requires authorization via a Bearer token and accepts various parameters in the request body, including 'propertiesWithHistory', 'idProperty', 'inputs', and 'properties'. The 'archived' query parameter can be used to filter results based on their archived status. The response includes timestamps for when the operation was requested, started, and completed, as well as details about each payment, such as creation and update times, properties, and archival status.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Communications by Internal ID or Unique Property Values

ID: post_read_batch_communications
Operation: read
Entities: contact, communication
Summary: This API endpoint allows you to read a batch of communications by internal ID or unique property values. It requires the 'crm.objects.contacts.read' scope and adheres to standard API rate limits. The request can include optional query parameters such as 'archived' to filter results based on their archived status. The request body can include 'propertiesWithHistory', 'idProperty', 'inputs', and 'properties' to specify the details of the communications to be read. The response includes timestamps for when the operation was requested, started, and completed, as well as the results of the operation, which include details about each communication such as creation and update timestamps, properties, and archival status.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Contacts by Internal ID or Unique Property Values

ID: post_read_batch_contacts
Operation: read
Entities: property, contact, error
Summary: This API endpoint allows you to read a batch of contacts by their internal ID or unique property values. It requires authentication via OAuth or private apps. The request can include properties with history, a unique property name, and a list of contact IDs. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of the contacts retrieved. The API supports filtering by archived status and returns detailed information about each contact, including their properties and history.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of CRM Objects by Internal ID or Unique Property Values

ID: post_read_batch_crm_objects
Operation: read
Entities: property, object, history
Summary: This API endpoint allows you to read a batch of CRM objects by their internal ID or unique property values. It requires authentication via a bearer token and supports various scopes for access control. The request can specify the object type as a path parameter and can include optional query parameters such as 'archived' to filter results. The request body can include arrays of properties with history, unique property names, and object IDs to retrieve specific data. The response includes timestamps for the operation, links, and detailed results for each object, including their properties and history.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Deal Split Objects by Deal Object Internal ID

ID: post_read_batch_deal_split_objects
Operation: read
Entities: deal, error, split
Summary: This API endpoint allows you to read a batch of deal split objects by their associated deal object internal ID. It requires the 'crm.dealsplits.read_write' scope for authentication. The request is made via a POST method to the specified URL with a JSON body containing an array of deal object internal IDs. The response includes timestamps for when the request was made, started, and completed, along with the results of the operation, which include details about each split object such as creation time, archival status, properties, and history. The status of the operation is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Discounts by Internal ID or Unique Property Values

ID: post_read_batch_discounts
Operation: read
Entities: discount, error, property
Summary: This API endpoint allows you to read a batch of discounts by their internal ID or unique property values. It requires authentication via OAuth or private apps. The request can include properties with history, an ID property, inputs with discount IDs, and specific properties to retrieve. The response includes timestamps for when the operation was requested, started, and completed, as well as details about each discount, including creation and update timestamps, properties, and archival status. The API supports standard and granular scopes for e-commerce and CRM objects line items read.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Emails by Internal ID or Unique Property Values

ID: post_read_batch_emails
Operation: read
Entities: property, email, error
Summary: This API endpoint allows you to read a batch of emails by their internal ID or unique property values. It requires authentication via a Bearer token and supports both private apps and OAuth. The request can include properties with history, a unique ID property, and a list of inputs with IDs. The response includes timestamps for when the request was completed, started, and requested, along with links and results containing details about each email, such as creation and update timestamps, properties, and archived status. The API supports filtering by archived status through a query parameter.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Feedback Submissions by Internal ID or Unique Property Values

ID: post_read_batch_feedback_submissions
Operation: read
Entities: id, feedback submission, property
Summary: This API endpoint allows you to read a batch of feedback submissions by their internal ID or unique property values. It requires authorization via a Bearer token and accepts a JSON body with optional parameters such as 'propertiesWithHistory', 'idProperty', 'inputs', and 'properties'. The 'archived' query parameter can be used to filter results based on their archived status. The response includes timestamps for when the operation was requested, started, and completed, as well as detailed information about each feedback submission, including its properties and history.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Goal Targets by Internal ID or Unique Property Values

ID: post_read_batch_goal_targets
Operation: read
Entities: property, error, goal target
Summary: This API endpoint allows you to read a batch of goal targets by their internal ID or unique property values. It requires authentication via a Bearer token and supports OAuth. The request can include properties with history, an ID property, and a list of inputs with IDs. You can also specify properties to be returned. The 'archived' query parameter determines whether only archived results are returned, with a default value of false. The response includes timestamps for when the operation was requested, started, and completed, as well as links and results with detailed properties and history. The status of the operation is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Invoices by Internal ID or Unique Property Values

ID: post_read_batch_invoices
Operation: read
Entities: property, invoice, error
Summary: This API endpoint allows you to read a batch of invoices by their internal ID or unique property values. It requires authentication via OAuth or private apps and the 'crm.objects.invoices.read' scope. The request can include optional parameters such as 'propertiesWithHistory', 'idProperty', 'inputs', and 'properties' in the body, and 'archived' as a query parameter to filter archived results. The response includes timestamps for when the operation was requested, started, and completed, as well as details about each invoice, including its properties and history. The API adheres to standard rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Line Items by Internal ID or Unique Property Values

ID: post_read_batch_line_items
Operation: read
Entities: property, line item, error
Summary: This API endpoint allows you to read a batch of line items by their internal ID or unique property values. It requires authentication via OAuth or private apps. The request can include properties with history, an ID property, inputs with IDs, and other properties. The 'archived' query parameter can be used to filter results based on their archived status. The response includes timestamps for when the operation was requested, started, and completed, as well as links, results with detailed properties, and the status of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Meetings by Internal ID or Unique Property Values

ID: post_read_batch_meetings
Operation: read
Entities: property, meeting, error
Summary: This API endpoint allows you to read a batch of meetings by their internal ID or unique property values. It requires authentication via OAuth or private apps. The request can include optional parameters such as 'propertiesWithHistory', 'idProperty', 'inputs', and 'properties' in the body, and 'archived' as a query parameter to filter archived meetings. The response includes timestamps for when the operation was requested, started, and completed, as well as details about each meeting, including its properties and history. The API supports standard rate limits and requires the 'crm.objects.contacts.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Notes by Internal ID or Unique Property Values

ID: post_read_batch_notes
Operation: read
Entities: property, error, note
Summary: This API endpoint allows you to read a batch of notes by their internal ID or unique property values. It requires authentication via a Bearer token and supports OAuth. The request can include optional query parameters such as 'archived' to filter results based on their archived status. The body of the request can include arrays of 'propertiesWithHistory', 'idProperty', 'inputs', and 'properties'. The response includes timestamps for when the request was completed, started, and requested, as well as links and results containing details about each note, such as creation and update timestamps, properties, and archived status. The API adheres to standard rate limits and requires the 'crm.objects.contacts.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Carts by Internal ID or Unique Property Values

ID: post_read_batch_of_carts
Operation: read
Entities: cart, error, property
Summary: This API endpoint allows you to read a batch of carts by their internal ID or unique property values. It requires authentication via OAuth or private apps and the 'crm.objects.carts.read' scope. The request can include properties with history, a unique ID property, and an array of inputs with cart IDs. The response includes details about the operation's completion, links, and results with cart properties and history. The API supports filtering by archived status with a default value of false.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Companies by Internal ID or Unique Property Values

ID: post_read_batch_of_companies
Operation: read
Entities: property, company, error
Summary: This API endpoint allows you to read a batch of companies by their internal ID or unique property values. It requires authentication via OAuth or private apps. The request can include optional query parameters such as 'archived' to filter results based on their archived status. The request body can include arrays of 'propertiesWithHistory', 'idProperty', 'inputs', and 'properties' to specify which properties and IDs to retrieve. The response includes timestamps for when the request was completed, started, and requested, as well as links and results containing company details such as creation time, archived status, properties with history, and more. The API supports standard rate limits and requires the 'crm.objects.companies.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Deals by Internal ID or Unique Property Values

ID: post_read_batch_of_deals
Operation: read
Entities: property, deal, error
Summary: This API endpoint allows you to read a batch of deals by their internal ID or unique property values. It requires authentication via OAuth or private apps and the 'crm.objects.deals.read' scope. The request can include properties with history, a unique property name, and a list of deal IDs. The response includes timestamps for when the operation was requested, started, and completed, as well as details about each deal, including its properties and history. The 'archived' query parameter can be used to filter results to only include archived deals.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Fees by Internal ID or Unique Property Values

ID: post_read_batch_of_fees
Operation: read
Entities: property, fee, error
Summary: This API endpoint allows you to read a batch of fees by internal ID or unique property values. It requires authorization via a Bearer token and accepts various parameters in the request body, including 'propertiesWithHistory', 'idProperty', 'inputs', and 'properties'. The 'archived' query parameter can be used to filter results based on their archived status. The response includes timestamps for when the operation was requested, started, and completed, as well as links and results detailing the properties and history of the fees. The status of the operation is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Leads by Internal ID or Unique Property Values

ID: post_read_batch_of_leads
Operation: read
Entities: lead, error, property
Summary: This API endpoint allows you to read a batch of leads by their internal ID or unique property values. It requires the 'crm.objects.leads.read' scope and adheres to standard API rate limits. The request can include headers for authorization and content type, a query parameter to filter archived results, and a body with properties, idProperty, inputs, and propertiesWithHistory. The response includes timestamps for the operation, links, results with lead details, and the status of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Products by Internal ID or Unique Property Values

ID: post_read_batch_of_products
Operation: read
Entities: property, error, product
Summary: This API endpoint allows you to read a batch of products by their internal ID or unique property values. It requires authorization via a Bearer token and accepts various parameters in the request body, including 'propertiesWithHistory', 'idProperty', 'inputs', and 'properties'. The 'archived' query parameter can be used to filter results based on their archived status. The response includes timestamps for when the operation was requested, started, and completed, as well as detailed information about each product, including its properties and history. The API supports standard e-commerce scopes and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Properties

ID: post_read_batch_of_properties
Operation: read
Entities: property, option, object type
Summary: This API endpoint allows you to read a batch of properties for a specified object type in HubSpot. It requires authentication via a Bearer token and supports various scopes for access. The request includes a path parameter 'objectType' to specify the type of object, and a body parameter 'inputs' which is an array of property names to be read. The response includes details about each property, such as its creation and modification metadata, display order, description, label, type, and options. The API supports standard rate limits and returns a detailed response including timestamps and status of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Quotes by Internal ID or Unique Property Values

ID: post_read_batch_of_quotes
Operation: read
Entities: property, error, quote
Summary: This API endpoint allows you to read a batch of quotes by their internal ID or unique property values. It requires authentication via a Bearer token and supports both private apps and OAuth. The request can include properties with history, an ID property, inputs with IDs, and additional properties. The 'archived' query parameter can be used to filter results based on their archived status. The response includes timestamps for when the operation was requested, started, and completed, as well as details about each quote, including its properties and history. The status of the operation is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Taxes by Internal ID or Unique Property Values

ID: post_read_batch_of_taxes
Operation: read
Entities: property, tax, error
Summary: This API endpoint allows users to read a batch of tax objects by their internal ID or unique property values. It requires authentication via OAuth and the 'crm.objects.line_items.read' scope. The request can include optional query parameters such as 'archived' to filter archived results. The request body can specify 'propertiesWithHistory', 'idProperty', 'inputs', and 'properties' to customize the response. The response includes timestamps for when the operation was requested, started, and completed, as well as details about the tax objects, including their properties and history. The API adheres to standard rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Orders by Internal ID or Unique Property Values

ID: post_read_batch_orders
Operation: read
Entities: property, order, error
Summary: This API endpoint allows you to read a batch of orders by their internal ID or unique property values. It requires authentication via OAuth and the 'crm.objects.orders.read' scope. The request can include properties with history, a unique property name, and a list of order IDs. The response includes details about the orders, such as creation and update timestamps, properties, and archival status. The API supports filtering by archived status through a query parameter. The response can return multiple statuses, including successful operations and errors with detailed context.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Postal Mail by Internal ID or Unique Property Values

ID: post_read_batch_postal_mail
Operation: read
Entities: property, postal mail, error
Summary: This API endpoint allows you to read a batch of postal mail records by their internal ID or unique property values. It requires the 'crm.objects.contacts.read' scope and adheres to standard API rate limits. The request can include optional query parameters such as 'archived' to filter archived results. The body can include 'propertiesWithHistory', 'idProperty', 'inputs', and 'properties' to specify the data to be retrieved. The response includes timestamps for the request, start, and completion of the operation, links, results with detailed properties, and the status of the operation.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Subscriptions by Internal ID or Unique Property Values

ID: post_read_batch_subscriptions
Operation: read
Entities: property, error, subscription
Summary: This API endpoint allows you to read a batch of subscriptions by their internal ID or unique property values. It requires the 'crm.objects.subscriptions.read' scope and adheres to standard API rate limits. The request can include properties with history, a unique ID property, and an array of inputs specifying subscription IDs. The 'archived' query parameter can be used to filter results based on their archived status. The response includes timestamps for when the operation was requested, started, and completed, as well as detailed information about each subscription, including its properties and history.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Tasks by Internal ID or Unique Property Values

ID: post_read_batch_tasks
Operation: read
Entities: property, task, error
Summary: This API endpoint allows you to read a batch of tasks by their internal ID or unique property values. It requires authorization via a Bearer token and supports OAuth. The request can include properties with history, a unique ID property, and an array of inputs specifying task IDs. The response includes timestamps for completion, request, and start, links, task results with properties and history, and the status of the request. The API supports filtering by archived status and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Read a Batch of Tickets by Internal ID or Unique Property Values

ID: post_read_batch_tickets
Operation: read
Entities: property, ticket, error
Summary: This API endpoint allows you to read a batch of tickets by their internal ID or unique property values. It requires authentication via a Bearer token and supports OAuth. The request can include properties with history, a unique ID property, and a list of inputs containing ticket IDs. The 'archived' query parameter can be used to filter results based on their archived status. The response includes timestamps for when the operation was requested, started, and completed, as well as links, results with ticket details, and the operation status.
Input Fields: Input Fields
Output Fields: Output Fields

Register Calling App for Recording

ID: post_register_calling_app_for_recording
Operation: write
Entities: error, recording, app
Summary: This API endpoint registers a calling extension app with an external URL that HubSpot will use to retrieve call recordings. It requires the app ID as a path parameter and the developer API key as a query parameter. The request body must include the 'urlToRetrieveAuthedRecording', which is the URL HubSpot will use to access the recordings. The response will confirm the URL or provide detailed error information if the request fails.
Input Fields: Input Fields
Output Fields: Output Fields

Search Calls in CRM

ID: post_search_calls_in_crm
Operation: read
Entities: property, call, filter group
Summary: The Search Calls in CRM API allows users to search for call records within the CRM system. It requires authorization via a Bearer token and accepts various optional parameters in the request body, such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The 'filterGroups' parameter can include multiple filters with properties like 'highValue', 'propertyName', 'values', 'value', and 'operator'. The API returns a response containing the total number of results, paging information, and a list of call results with details such as creation and update timestamps, properties, and archived status. In case of errors, the response includes detailed error information with categories, messages, and context.
Input Fields: Input Fields
Output Fields: Output Fields

Search Carts in CRM

ID: post_search_carts_in_crm
Operation: read
Entities: cart, property, filter group
Summary: The Search Carts in CRM API allows users to search for carts within the CRM system using various filters and sorting options. The API requires authorization via a Bearer token and accepts a JSON body with parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and an array of cart results with details like creation and update timestamps, properties, and history. The API is exempt from the per-ten-second API call limit and requires the 'crm.objects.carts.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Search Commerce Payments

ID: post_search_commerce_payments
Operation: read
Entities: property, commerce payment, filter group
Summary: The Search Commerce Payments API allows users to search for commerce payment objects in the CRM. It requires authorization via a Bearer token and supports various query parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and a list of results with details such as creation and update timestamps, properties, and archived status. The API is exempt from the per-ten-second API call limit and requires the 'crm.objects.commercepayments.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Search Communications in CRM

ID: post_search_communications_in_crm
Operation: read
Entities: property, communication, filter
Summary: This API endpoint allows users to search for communications within the CRM. It requires authorization via a Bearer token and accepts various optional parameters in the request body, such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The 'filterGroups' parameter can include multiple filters with properties like 'highValue', 'propertyName', 'values', 'value', and 'operator'. The response includes the total number of results, paging information, and a list of communication objects with details such as creation and update timestamps, properties, and history.
Input Fields: Input Fields
Output Fields: Output Fields

Search Companies in CRM

ID: post_search_companies_in_crm
Operation: read
Entities: property, company, filter
Summary: This API endpoint allows you to search for companies in the CRM. It requires authentication via a Bearer token and supports various query parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and an array of company results with details such as creation and update timestamps, properties, and archived status. The API is exempt from the per-ten-second API call limit and requires the 'crm.objects.companies.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Search Contacts in CRM

ID: post_search_contacts_in_crm
Operation: read
Entities: property, contact, filter group
Summary: The Search Contacts in CRM API allows users to search for contacts within the CRM system using various filters and query parameters. The API requires authorization via a Bearer token and accepts a JSON body with parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and an array of contact results with details such as creation and update timestamps, properties, and archived status. The API is exempt from the per-ten-second API call limit and requires the 'crm.objects.contacts.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Search CRM Notes

ID: post_search_crm_notes
Operation: read
Entities: property, note, filter
Summary: The Search CRM Notes API allows users to search for notes within the CRM system. It requires authorization via a Bearer token and accepts various search parameters in the request body, such as query, limit, after, sorts, properties, and filterGroups. The response includes the total number of results, paging information, and an array of note results with details like creation and update timestamps, properties, and archived status. The API is exempt from the per-ten-second API call limit and requires the 'crm.objects.contacts.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Search CRM Objects

ID: post_search_crm_objects
Operation: read
Entities: property, object, filter
Summary: The Search CRM Objects API allows you to search for CRM objects of a specified type using various filters and parameters. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The path parameter 'objectType' specifies the type of CRM object to search. The request body can include a search query, limit, paging cursor, sorting options, properties to include, and filter groups with specific filters. The response includes the total number of results, paging information, and an array of results with details such as creation and update timestamps, properties, and history. The API is exempt from the per-ten-second API call limit and requires specific scopes for access.
Input Fields: Input Fields
Output Fields: Output Fields

Search CRM Tasks

ID: post_search_crm_tasks
Operation: read
Entities: property, task, filter
Summary: The Search CRM Tasks API allows users to search for tasks within the CRM system. It requires authentication via a Bearer token and supports various query parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, pagination details, and an array of task objects with properties like 'createdAt', 'archived', 'propertiesWithHistory', and more. The API is exempt from the per-ten-second API call limit and requires the 'crm.objects.contacts.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Search CRM Tickets

ID: post_search_crm_tickets
Operation: read
Entities: property, ticket, filter group
Summary: The Search CRM Tickets API allows users to search for tickets within the CRM system using various filters and sorting options. The request requires authentication via a Bearer token and accepts parameters such as query, limit, after, sorts, properties, and filterGroups in the request body. The response includes the total number of results, paging information, and a list of ticket results with details such as creation and update timestamps, properties, and archived status.
Input Fields: Input Fields
Output Fields: Output Fields

Search Deals in CRM

ID: post_search_deals_in_crm
Operation: read
Entities: property, deal, filter group
Summary: The Search Deals in CRM API allows users to search for deals within the CRM system using various parameters. The API requires authorization via a Bearer token and accepts a JSON body with optional parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and an array of deal results with details such as creation and update timestamps, properties, and archived status. The API is exempt from the per-ten-second API call limit and requires the 'crm.objects.deals.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Search Discounts in CRM

ID: post_search_discounts_in_crm
Operation: read
Entities: discount, property, filter group
Summary: The Search Discounts in CRM API allows users to search for discount objects within the CRM system. It requires authentication via a Bearer token and supports various query parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and a list of discount results with details such as creation and update timestamps, properties, and archived status. The API is exempt from the per-ten-second API call limit and requires specific scopes for access.
Input Fields: Input Fields
Output Fields: Output Fields

Search Emails in CRM

ID: post_search_emails_in_crm
Operation: read
Entities: contact, email
Summary: The Search Emails in CRM API allows users to search for emails within the CRM system using various filters and criteria. The API requires authorization via a Bearer token and accepts a JSON body with parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and an array of email results with details such as creation and update timestamps, properties, and archived status. The API is exempt from the per-ten-second API call limit and requires specific scopes for access.
Input Fields: Input Fields
Output Fields: Output Fields

Search Feedback Submissions

ID: post_search_feedback_submissions
Operation: read
Entities: property, feedback submission, filter group
Summary: The Search Feedback Submissions API allows users to search for feedback submissions in the CRM. It requires authorization via a Bearer token and accepts a JSON body with parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and an array of feedback submission results with details like creation and update timestamps, properties, and archived status. The API is exempt from the per-ten-second API call limit.
Input Fields: Input Fields
Output Fields: Output Fields

Search Fees in CRM

ID: post_search_fees_in_crm
Operation: read
Entities: property, fee, filter group
Summary: The Search Fees in CRM API allows users to search for fees within the CRM system using various filters and sorting options. The API requires authorization via a Bearer token and accepts a JSON body with parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and a list of results with details such as creation and update timestamps, properties, and archived status. The API is exempt from the per-ten-second API call limit and requires specific scopes for access.
Input Fields: Input Fields
Output Fields: Output Fields

Search Goal Targets

ID: post_search_goal_targets
Operation: read
Entities: property, goal target, filter
Summary: The Search Goal Targets API allows users to search for goal targets within the CRM. It requires authentication via a Bearer token and supports various search parameters such as query, limit, after, sorts, properties, and filterGroups. The response includes the total number of results, paging information, and a list of goal targets with their properties and history. The API is exempt from the per-ten-second API call limit and requires the 'crm.objects.goals.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Search Invoices in CRM

ID: post_search_invoices_in_crm
Operation: read
Entities: property, invoice, filter group
Summary: The Search Invoices in CRM API allows users to search for invoices within the CRM system using various filters and sorting options. The API requires an authorization header with a Bearer token and accepts a JSON body with parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and an array of invoice results with details like creation and update timestamps, properties, and archived status.
Input Fields: Input Fields
Output Fields: Output Fields

Search Leads in CRM

ID: post_search_leads_in_crm
Operation: read
Entities: lead, property, filter group
Summary: The Search Leads in CRM API allows users to search for leads within the CRM system using various filters and criteria. The API requires authentication via a Bearer token and accepts a JSON body with parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and an array of lead results with details such as creation and update timestamps, properties, and archived status. The API is exempt from the per-ten-second API call limit and requires the 'crm.objects.leads.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Search Line Items in CRM

ID: post_search_line_items_in_crm
Operation: read
Entities: property, line item, filter group
Summary: The 'Search Line Items in CRM' API allows users to search for line items within the CRM system. It requires authorization via a Bearer token and accepts various parameters in the request body, such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and a list of line items with their properties and history. The API is exempt from the per-ten-second API call limit and requires specific scopes for access.
Input Fields: Input Fields
Output Fields: Output Fields

Search Lists by Name or Page Through All Lists

ID: post_search_lists_by_name_or_page_through_all_lists
Operation: read
Entities: list, property, user
Summary: This API endpoint allows users to search for lists by name or page through all lists by providing an empty query value. It requires the 'crm.lists.read' scope and adheres to standard API rate limits. The request body can include parameters such as 'listIds' to filter by list ID, 'offset' for pagination, 'query' to search by list name, 'count' to specify the number of lists to return, 'processingTypes' to filter by processing type, 'additionalProperties' to include extra list properties, and 'sort' to determine the order of results. The response includes the total number of matching lists, an offset for pagination, and details of each list such as processing type, object type, and additional properties. If there are more results to page through, 'hasMore' will be true.
Input Fields: Input Fields
Output Fields: Output Fields

Search Meetings in CRM

ID: post_search_meetings_in_crm
Operation: read
Entities: property, meeting, filter
Summary: This API endpoint allows you to search for meetings in the CRM system. It requires authorization via a Bearer token and accepts various optional parameters in the request body, such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The 'filterGroups' parameter can include multiple filters with properties like 'highValue', 'propertyName', 'values', 'value', and 'operator'. The response includes the total number of results, paging information, and a list of meeting results with details such as creation and update timestamps, archived status, and meeting properties. In case of errors, detailed error information is provided, including error category, message, and context.
Input Fields: Input Fields
Output Fields: Output Fields

Search Orders in CRM

ID: post_search_orders_in_crm
Operation: read
Entities: property, order, filter group
Summary: The Search Orders in CRM API allows users to search for orders within the CRM system using various parameters. The API requires authentication via a Bearer token and accepts a JSON body with optional parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and an array of order results with details such as creation and update timestamps, properties, and archived status. The API is exempt from the per-ten-second API call limit and requires the 'crm.objects.orders.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Search Postal Mail Objects in CRM

ID: post_search_postal_mail_objects
Operation: read
Entities: postal mail, filter group, sort
Summary: This API endpoint allows you to search for postal mail objects in the CRM. It requires authorization via a Bearer token and accepts various parameters in the request body, such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and an array of result objects with details like creation and update timestamps, properties, and archived status. The API is exempt from the per-ten-second API call limit and requires the 'crm.objects.contacts.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Search Products in CRM

ID: post_search_products_in_crm
Operation: read
Entities: property, filter group, product
Summary: The Search Products in CRM API allows users to search for products within the CRM system using various filters and sorting options. The API requires authorization via a Bearer token and accepts a JSON body with parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, pagination details, and an array of product results with their properties and history. The API is exempt from the per-ten-second API call limit and requires the 'e-commerce' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Search Quotes in CRM

ID: post_search_quotes_in_crm
Operation: read
Entities: property, quote, filter
Summary: The Search Quotes in CRM API allows users to search for quotes within the CRM system using various parameters. The request can include a search query, limit, pagination cursor, sorting criteria, properties to include, and filter groups. The response includes the total number of results, paging information, and a list of quote results with details such as creation and update timestamps, properties, and archived status. The API requires authorization via a Bearer token and is exempt from the per-ten-second API call limit.
Input Fields: Input Fields
Output Fields: Output Fields

Search Subscriptions in CRM

ID: post_search_subscriptions_in_crm
Operation: read
Entities: property, subscription, filter group
Summary: This API endpoint allows you to search for subscriptions within the CRM. It requires authorization via a Bearer token and accepts various parameters in the request body, such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The 'filterGroups' parameter can contain multiple filters with attributes like 'highValue', 'propertyName', 'values', 'value', and 'operator'. The response includes the total number of results, paging information, and a list of subscription results with details such as creation and update timestamps, properties, and archived status. The API is exempt from the per-ten-second API call limit and requires the 'crm.objects.subscriptions.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Search Taxes in CRM

ID: post_search_taxes_in_crm
Operation: read
Entities: tax
Summary: The Search Taxes in CRM API allows users to search for tax objects within the CRM system. It requires authentication via a Bearer token and supports various query parameters such as 'query', 'limit', 'after', 'sorts', 'properties', and 'filterGroups'. The response includes the total number of results, paging information, and a list of tax objects with details such as creation and update timestamps, properties, and archived status. The API is exempt from the per-ten-second API call limit and requires the 'crm.objects.line_items.read' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Start a New Import

ID: post_start_a_new_import
Operation: write
Entities: import request, file, metadata
Summary: The 'Start a New Import' API begins importing data from specified file resources. It uploads the corresponding files and uses the import request object to convert rows in the files to objects. The API requires the 'crm.import' scope and adheres to standard API rate limits. The request body must include a list of files in binary format and a JSON formatted import request detailing metadata such as the import name and column mappings. The successful response includes details about the import, such as the import template, creation time, metadata counters, file IDs, object lists, import source, name, state, ID, opt-out status, and update time. Errors are detailed with specific categories, context, correlation ID, and links to documentation.
Input Fields: Input Fields
Output Fields: Output Fields

Start an Export of CRM Data

ID: post_start_an_export_of_crm_data
Operation: write
Entities: CRM data, error, export
Summary: This API endpoint starts an export of CRM data for the specified portal. It requires an authorization bearer token and a content-type header set to application/json. The request body must include details such as exportType, format, exportName, objectProperties, associatedObjectType, objectType, language, and publicCrmSearchRequest. The response returns a 202 status code with an ID of the export and related links. In case of errors, a detailed error message with context and links to documentation is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Translate Legacy List Id to Modern List Id in Batch

ID: post_translate_legacy_list_id_to_modern_list_id_in_batch
Operation: write
Entities: list
Summary: This API translates a batch of legacy list IDs to modern list IDs, allowing for a maximum of 10,000 IDs per request. It requires the 'crm.lists.read' scope and adheres to standard API rate limits. The request must include headers for 'accept', 'content-type', and 'authorization', and the body should contain an array of legacy list IDs. The response provides a mapping of legacy list IDs to modern list IDs and lists any legacy IDs that could not be found. This API is temporary and will expire on May 30th, 2025.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Calls by Internal ID or Unique Property Values

ID: post_update_batch_calls
Operation: write
Entities: property, call, error
Summary: This API endpoint allows you to update a batch of call objects in HubSpot by their internal ID or unique property values. The request requires authentication via a Bearer token and expects a JSON body containing an array of call objects to be updated. Each call object must specify an 'idProperty' and 'id', along with the properties to be updated. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of the updated call objects. The API supports OAuth and private apps, and requires the 'crm.objects.contacts.write' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Communications by Internal ID or Unique Property Values

ID: post_update_batch_communications
Operation: write
Entities: property, error, communication
Summary: This API endpoint allows you to update a batch of communications by their internal ID or unique property values. It requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request must include an authorization header with a Bearer token and a content-type header set to 'application/json'. The body of the request should contain an array of objects, each specifying an 'idProperty' (the name of a unique property), an 'id' (either the object ID or the unique property value), and a 'properties' object with the properties to be updated. The response includes timestamps for when the request was completed, started, and requested, as well as links and results for each updated object. The results include details such as creation and update timestamps, archived status, and properties with history. The status of the operation is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Contacts by Internal ID or Unique Property Values

ID: post_update_batch_contacts
Operation: write
Entities: property, contact, error
Summary: This API endpoint allows you to update a batch of contacts in HubSpot by their internal ID or unique property values. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request should contain an array of contact objects, each with an idProperty, id, and properties to be updated. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of the updated contacts. The API requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of CRM Objects

ID: post_update_batch_crm_objects
Operation: write
Entities: property, scope, object
Summary: This API endpoint allows you to update a batch of CRM objects by their internal ID or unique property values. You need to provide the object type as a path parameter and an array of objects to update in the request body. Each object in the array should include the unique property name, the ID or unique property value, and the properties to update. The response includes timestamps for when the operation was requested, started, and completed, as well as the results of the update operation, including the updated properties and their history.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Discounts by Internal ID or Unique Property Values

ID: post_update_batch_discounts
Operation: write
Entities: discount, error, property
Summary: This API endpoint allows you to update a batch of discounts by their internal ID or unique property values. It requires authorization via a Bearer token and accepts a JSON body containing an array of discount objects to update. Each object must specify an 'idProperty' and 'id', along with the properties to update. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of each updated discount. The API supports standard and granular scopes for e-commerce and CRM objects line items write access.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Emails by Internal ID or Unique Property Values

ID: post_update_batch_emails
Operation: write
Entities: property, email, error
Summary: This API endpoint allows you to update a batch of emails by their internal ID or unique property values. It requires authentication via a Bearer token and accepts a JSON body containing an array of email objects to update. Each email object must specify an 'idProperty' and 'id', along with the properties to update. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of each email updated. The API supports standard and granular scopes and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Line Items by Internal ID or Unique Property Values

ID: post_update_batch_line_items
Operation: write
Entities: property, line item, error
Summary: This API endpoint allows you to update a batch of line items in the CRM by using either their internal ID or unique property values. The request requires authorization via a Bearer token and must include a JSON body with an array of line items to update. Each line item must specify an 'idProperty' and 'id', along with the properties to update. The response provides timestamps for the request, start, and completion of the operation, along with the status and details of each updated line item. The API supports standard and granular scopes for e-commerce and CRM line item writing.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Meetings by Internal ID or Unique Property Values

ID: post_update_batch_meetings
Operation: write
Entities: property, meeting, error
Summary: This API endpoint allows you to update a batch of meetings by their internal ID or unique property values. It requires authentication via OAuth and the 'crm.objects.contacts.write' scope. The request body must include an array of meeting objects, each with an 'idProperty', 'id', and 'properties' to be updated. The response includes timestamps for when the request was made, started, and completed, as well as the status of the operation and details of each meeting updated. The API adheres to standard rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Notes by Internal ID or Unique Property Values

ID: post_update_batch_notes
Operation: write
Entities: property, error, note
Summary: This API endpoint allows you to update a batch of notes in HubSpot by specifying either the internal ID or unique property values. The request requires authentication via a Bearer token and accepts a JSON body containing an array of note objects to be updated. Each note object must include an 'idProperty' indicating the unique property name, an 'id' which can be the object ID or the unique property value, and a 'properties' object containing the properties to be updated. The response provides details about the operation, including timestamps, links, and the status of each note update. The API supports standard rate limits and requires the 'crm.objects.contacts.write' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Carts by Internal ID or Unique Property Values

ID: post_update_batch_of_carts
Operation: write
Entities: cart, error, property
Summary: This API endpoint allows you to update a batch of carts by their internal ID or unique property values. It requires the 'crm.objects.carts.write' scope for authorization. The request body must include an array of cart objects, each with an 'idProperty', 'id', and 'properties' to be updated. The properties include 'hs_cart_name', 'hs_currency_code', and 'hs_external_cart_id'. The response provides timestamps for when the operation was requested, started, and completed, along with the status and results of the update operation. The results include details about each cart, such as creation and update timestamps, properties, and history of property changes.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Companies by Internal ID or Unique Property Values

ID: post_update_batch_of_companies
Operation: write
Entities: property, company, error
Summary: This API endpoint allows you to update a batch of companies in HubSpot by their internal ID or unique property values. The request requires an authorization bearer token and a content-type header set to application/json. The body of the request should contain an array of company objects, each with an idProperty, id, and properties to update. The response includes timestamps for when the operation was requested, started, and completed, as well as the results of the update operation, including the properties and their history. The status of the operation is also provided.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Deals by Internal ID or Unique Property Values

ID: post_update_batch_of_deals
Operation: write
Entities: property, deal, error
Summary: This API endpoint allows you to update a batch of deals in HubSpot by specifying either the internal ID or unique property values. The request requires authentication via a Bearer token and the content type must be set to application/json. The body of the request should contain an array of deal objects, each with an idProperty, id, and properties to be updated. The response will include timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of the updated deals. The API supports standard rate limits and requires the 'crm.objects.deals.write' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Fees by Internal ID or Unique Property Values

ID: post_update_batch_of_fees
Operation: write
Entities: property, fee, error
Summary: This API endpoint allows you to update a batch of fees by their internal ID or unique property values. It requires authentication via OAuth or private apps and is subject to standard API rate limits. The request body must include an array of inputs, each containing an idProperty, id, and properties to be updated. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of each fee updated. Errors are returned with detailed context and remediation steps.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Leads by Internal ID or Unique Property Values

ID: post_update_batch_of_leads
Operation: write
Entities: lead, error, property
Summary: This API endpoint allows you to update a batch of leads in the CRM by using either their internal ID or unique property values. The request requires authentication via a Bearer token and the content type must be set to application/json. The body of the request should contain an array of lead objects, each with an idProperty, id, and properties to be updated. The response will include timestamps for when the request was made, started, and completed, as well as the status of the operation and details of the updated leads. The API supports OAuth and requires the 'crm.objects.leads.write' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Quotes by Internal ID or Unique Property Values

ID: post_update_batch_of_quotes
Operation: write
Entities: property, error, quote
Summary: This API endpoint allows you to update a batch of quotes by their internal ID or unique property values. It requires authorization via a Bearer token and accepts a JSON body containing an array of quote objects to be updated. Each quote object must include an 'idProperty' which is the name of a unique property, an 'id' which can be the object ID or the unique property value, and a 'properties' object containing the properties to be updated. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of the updated quotes.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Taxes by Internal ID or Unique Property Values

ID: post_update_batch_of_taxes
Operation: write
Entities: property, tax, error
Summary: This API endpoint allows you to update a batch of tax objects by their internal ID or unique property values. The request requires authentication via a Bearer token and must include the 'crm.objects.line_items.write' scope. The input consists of an array of tax objects, each with a unique 'idProperty', an 'id', and a set of 'properties' to update. The response provides timestamps for when the operation was requested, started, and completed, along with the results for each tax object, including their properties and history. The status of the operation is also included in the response.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Orders by Internal ID or Unique Property Values

ID: post_update_batch_orders
Operation: write
Entities: property, order, error
Summary: This API endpoint allows you to update a batch of orders by their internal ID or unique property values. It requires the 'crm.objects.orders.write' scope and adheres to standard API rate limits. The request body must include an array of order objects, each containing an 'idProperty', 'id', and 'properties' to be updated. The response provides timestamps for the request, start, and completion of the operation, along with the results of each order update, including their properties and history. The status of the operation is also returned.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Postal Mail by Internal ID or Unique Property Values

ID: post_update_batch_postal_mail
Operation: write
Entities: property, postal mail, error
Summary: This API endpoint allows you to update a batch of postal mail objects by their internal ID or unique property values. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request should contain an array of objects, each with an idProperty, id, and properties to be updated. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of the updated objects. The API supports OAuth authentication and requires the 'crm.objects.contacts.write' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Products by Internal ID or Unique Property Values

ID: post_update_batch_products
Operation: write
Entities: property, error, product
Summary: This API endpoint allows you to update a batch of products in the CRM by their internal ID or unique property values. It requires an authorization bearer token and content-type header. The request body must include an array of product objects, each with an 'idProperty', 'id', and 'properties' to be updated. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of each product updated. The API supports standard e-commerce scopes and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Tasks by Internal ID or Unique Property Values

ID: post_update_batch_tasks
Operation: write
Entities: property, task
Summary: This API endpoint allows you to update a batch of tasks by their internal ID or unique property values. It requires the 'crm.objects.contacts.write' scope and adheres to standard API rate limits. The request body must include an array of task objects, each containing an 'idProperty', 'id', and 'properties' to be updated. The response provides timestamps for when the operation was requested, started, and completed, along with the status and results of the update operation. In case of errors, detailed error messages and context are provided.
Input Fields: Input Fields
Output Fields: Output Fields

Update a Batch of Tickets by Internal ID or Unique Property Values

ID: post_update_batch_tickets
Operation: write
Entities: property, ticket, error
Summary: This API endpoint allows you to update a batch of tickets in HubSpot by their internal ID or unique property values. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The body of the request should contain an array of ticket objects, each with an idProperty, id, and properties to be updated. The response includes timestamps for when the operation was requested, started, and completed, as well as the status of the operation and details of the updated tickets. The API supports standard API rate limits and requires the 'tickets' scope.
Input Fields: Input Fields
Output Fields: Output Fields

Add All Records from a Source List to a Destination List

ID: put_add_all_records_from_source_list_to_destination_list
Operation: write
Entities: list, membership, record
Summary: This API endpoint allows you to add all records from a source list to a destination list in HubSpot CRM. The source list is specified by the sourceListId and the destination list by the listId. The destination list must have a processingType of MANUAL or SNAPSHOT, while the source list can have any processingType. The source list must contain fewer than 100,000 memberships. The API requires an authorization header with a Bearer token. The response is HTTP 204 for success with no content, or an error object detailing any issues encountered.
Input Fields: Input Fields
Output Fields: Output Fields

Add and/or Remove Records from a List

ID: put_add_and_or_remove_records_from_a_list
Operation: write
Entities: list, membership, record
Summary: This API endpoint allows users to add and/or remove records from a list that has a processing type of MANUAL or SNAPSHOT. It requires the list ID as a path parameter and accepts arrays of record IDs to add or remove in the request body. The response includes arrays of successfully added and removed record IDs, as well as any missing record IDs. The endpoint requires authorization via a Bearer token and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Add Records to a List

ID: put_add_records_to_a_list
Operation: write
Entities: list, membership, record
Summary: This API endpoint allows you to add records to a specified list in the CRM. The list must have a processing type of MANUAL or SNAPSHOT. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The path parameter 'listId' specifies the target list, and the body contains an array of record IDs to be added. The response includes arrays of record IDs that were removed, added, or missing. Errors are detailed with specific categories, context, and messages.
Input Fields: Input Fields
Output Fields: Output Fields

Create Default Association Between Two Object Types

ID: put_create_default_association_between_two_object_types
Operation: write
Entities: association, error, object
Summary: This API creates the default (most generic) association type between two object types in HubSpot. It requires authentication via a Bearer token and supports various scopes for access. The API takes path parameters including 'fromObjectType', 'fromObjectId', 'toObjectType', and 'toObjectId' to specify the source and target objects for the association. The response includes timestamps for when the request was made, started, and completed, as well as any errors encountered during the operation. The results include details about the association specification and the involved objects.
Input Fields: Input Fields
Output Fields: Output Fields

Move a Folder in CRM

ID: put_move_a_folder_in_crm
Operation: write
Entities: folder, parent
Summary: This API endpoint moves a folder from its current location to a new location by updating its parent folder ID. It requires the 'crm.lists.write' and 'crm.lists.read' scopes. The request must include the folder ID to be moved and the new parent folder ID as path parameters. The response includes the updated folder details if successful, or an error message if the operation fails.
Input Fields: Input Fields
Output Fields: Output Fields

Move List to Folder

ID: put_move_list_to_folder
Operation: write
Entities: list, folder
Summary: This API endpoint moves a specified list to a given folder within the CRM. It requires the list ID and the new folder ID as input parameters in the request body. The request must include headers for 'accept', 'content-type', and 'authorization' with a valid Bearer token. The response will indicate success or provide error details, including missing scopes or invalid properties, if applicable.
Input Fields: Input Fields
Output Fields: Output Fields

Remove Records from a List

ID: put_remove_records_from_a_list
Operation: write
Entities: list, error, record
Summary: This API endpoint removes specified records from a list identified by the listId. It only works for lists with a processingType of MANUAL or SNAPSHOT. The request requires an authorization header with a Bearer token and a content-type header set to application/json. The path parameter listId is required to specify the list from which records are to be removed. The body of the request should contain an array of record IDs to be removed. The response includes arrays of record IDs that were successfully removed, added, or not found in the list. Errors are returned with detailed context and links to documentation for remediation.
Input Fields: Input Fields
Output Fields: Output Fields

Rename a Folder in CRM

ID: put_rename_folder_in_crm
Operation: write
Entities: user, folder
Summary: This API endpoint renames a folder in the CRM system identified by the given folderId. It requires the 'crm.lists.write' and 'crm.lists.read' scopes for authorization. The request must include the folderId as a path parameter and the new name as a query parameter. The response includes the updated folder details or an error message if the operation fails. The API is subject to standard rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Replace a Pipeline

ID: put_replace_a_pipeline
Operation: write
Entities: metadata, pipeline stage, pipeline
Summary: This API endpoint allows you to replace all the properties of an existing pipeline with the values provided. It overwrites any existing pipeline stages and returns the updated pipeline in the response. The request requires authentication via a Bearer token and accepts parameters such as objectType and pipelineId in the path. The body of the request includes displayOrder, stages, and label. The response includes details about the created pipeline, such as createdAt, archivedAt, displayOrder, stages, label, id, and updatedAt.
Input Fields: Input Fields
Output Fields: Output Fields

Replace a Pipeline Stage

ID: put_replace_pipeline_stage
Operation: write
Entities: metadata, stage, pipeline
Summary: This API endpoint allows you to replace all properties of an existing pipeline stage with new values. It requires authentication via a Bearer token and supports both private apps and OAuth. The endpoint requires path parameters for objectType, pipelineId, and stageId. The request body must include metadata, displayOrder, and label. The response returns the updated pipeline stage details, including creation and update timestamps, metadata, display order, label, and unique ID. The API enforces standard rate limits and requires specific scopes for access.
Input Fields: Input Fields
Output Fields: Output Fields

Restore a Deleted List

ID: put_restore_deleted_list
Operation: write
Entities: list, error, context
Summary: This API endpoint allows you to restore a previously deleted list by its ILS list ID. The list can be restored up to 90 days after deletion. The request requires an authorization header with a Bearer token and the listId as a path parameter. The response will be HTTP 204 if successful, indicating no content. In case of an error, the response will include details such as subCategory, context, correlationId, links, message, category, and errors array with specific error details.
Input Fields: Input Fields
Output Fields: Output Fields

Set Association Labels Between Two CRM Records

ID: put_set_association_labels_between_two_crm_records
Operation: write
Entities: label, association, object
Summary: This API endpoint allows you to set association labels between two CRM records in HubSpot. It requires the object type and ID for both the source and target records, as well as the association category and type ID in the request body. The response includes the IDs of the associated objects and any labels applied. The API requires appropriate OAuth scopes for access and adheres to standard API rate limits.
Input Fields: Input Fields
Output Fields: Output Fields

Update an Existing Event Template

ID: put_update_existing_event_template
Operation: write
Entities: template, token, event
Summary: This API endpoint updates an existing event template and its tokens. It is used to modify the headerTemplate and detailTemplate, which will affect existing events. Additionally, it allows updating or replacing all tokens in the template. The request requires the appId and eventTemplateId as path parameters, and the body should include the template details such as name, detailTemplate, headerTemplate, and tokens. The response includes the updated template details, including the name, headerTemplate, detailTemplate, and tokens with their properties.
Input Fields: Input Fields
Output Fields: Output Fields

Update List Filter Definition

ID: put_update_list_filter_definition
Operation: write
Entities: list, filter branch, workflow
Summary: The Update List Filter Definition API allows you to update the filter branch definition of a dynamic list in HubSpot. Once updated, the list memberships will be re-evaluated and updated to match the new definition. The API requires the 'crm.lists.write' and 'crm.lists.read' scopes. The endpoint is accessed via a PUT request to 'https://api.hubapi.com/crm/v3/lists/{listId}/update-list-filters'. The request must include the list ID as a path parameter, and optionally a query parameter 'enrollObjectsInWorkflows' to indicate if memberships should be enrolled in workflows. The request body must contain the 'filterBranch' object with 'filterBranchType' and 'filterBranchOperator'. The response includes details of the updated list, such as processing type, object type ID, updated by ID, and filter branch details.
Input Fields: Input Fields
Output Fields: Output Fields

Update List Name

ID: put_update_list_name
Operation: write
Entities: list, user, filter
Summary: The Update List Name API allows you to update the name of a list in the CRM. The list name must be globally unique relative to all other public lists in the portal. The API requires the 'crm.lists.write' and 'crm.lists.read' scopes for authorization. The request includes a path parameter 'listId' to specify the list to update, and a query parameter 'listName' for the new name. An optional query parameter 'includeFilters' can be set to true to include filter branch definitions in the response. The response includes details about the updated list, such as processing type, object type ID, updated by ID, and more.
Input Fields: Input Fields
Output Fields: Output Fields

Update Token on Event Template

ID: put_update_token_on_event_template
Operation: write
Entities: token, event template, CRM object property
Summary: This API updates an existing token on an event template in HubSpot. The token's name and type cannot be changed. The request requires the app ID, event template ID, and token name as path parameters. The body can include options for enumeration types, a label for segmentation, and an object property name for CRM integration. The response includes details about the token, such as its name, type, creation and update timestamps, label, and options.
Input Fields: Input Fields
Output Fields: Output Fields

Update User Defined Association Definition

ID: put_update_user_defined_association_definition
Operation: write
Entities: label, scope, association definition
Summary: This API updates a user-defined association definition between two object types in the CRM. It requires the 'fromObjectType' and 'toObjectType' as path parameters to specify the objects involved in the association. The request body must include 'inverseLabel', 'associationTypeId', and 'label' to define the association. The API requires an authorization bearer token and returns a status and message indicating the result of the update operation.
Input Fields: Input Fields
Output Fields: Output Fields

Update Video Conference Application Settings

ID: put_update_video_conference_application_settings
Operation: write
Entities: setting, meeting, application
Summary: This API updates the settings for a video conference application with the specified ID. It requires the application ID as a path parameter and the HubSpot developer API key as a query parameter. The request body must include URLs for user verification, fetching accounts, creating meetings, updating meetings, and deleting meetings. The response includes the same URLs if the operation is successful. In case of an error, a detailed error message is provided.
Input Fields: Input Fields
Output Fields: Output Fields

Updated about 1 month ago