HubSpot CRM API
Tools that enable LLMs to interact directly with the Hubspot CRM API.
1.0.0HubSpot CRM API Toolkit
The HubSpot CRM API Toolkit enables seamless interactions with the HubSpot CRM system, providing tools that harness the extensive capabilities of the CRM ecosystem.
Capabilities
- Manage and automate CRM objects such as contacts, companies, deals, and more.
- Perform batch operations for creating, updating, and retrieving records efficiently.
- Facilitate associations between various CRM objects and manage their relationships.
- Access detailed control over property management and object schemas.
- Implement GDPR compliance for data management and retrieval.
OAuth
Provider: Unknown
Scopes: automation, crm.dealsplits.read_write, crm.contacts.read/write, etc.
Secrets
None.
Available tools(453)
| Tool name | Description | Secrets | |
|---|---|---|---|
Add records from a source list to a destination list in HubSpot.
This tool transfers all records from a specified source list to a destination list in HubSpot CRM, ignoring duplicates. Suitable for destination lists with manual or snapshot processing and source lists with fewer than 100,000 memberships. | |||
Add records to a specified HubSpot CRM list.
Use this tool to add records to a specific HubSpot CRM list. Only works for lists with a processing type of MANUAL or SNAPSHOT. Records that don't exist or are already members will be ignored. | |||
Archive a call in HubSpot CRM by moving it to the recycle bin.
Use this tool to move a specific call, identified by its `callId`, to the recycling bin in HubSpot CRM. | |||
Archive a batch of calls by their IDs.
Use this tool to archive multiple calls in HubSpot CRM by providing their IDs. Archived calls can be restored within 90 days, but call recordings are permanently deleted. Refer to HubSpot's documentation for more details on restoring activities.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archive multiple carts by ID in a batch operation.
Use this tool to archive a batch of shopping carts by their IDs in HubSpot CRM. This is useful for managing and organizing outdated or completed carts.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archive a batch of commerce payments by ID.
Use this tool to archive multiple commerce payments at once by their IDs. Ideal for managing and organizing payment data efficiently by removing outdated or unnecessary records in batches.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archive a communication by its ID.
Use this tool to move a communication object to the recycling bin by specifying its ID. | |||
Archive a batch of contacts by ID in HubSpot CRM.
Use this tool to archive multiple contacts simultaneously in HubSpot CRM by providing their IDs. This can be useful for managing or cleaning up contact lists efficiently.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archive a batch of courses by ID.
Use this tool to archive multiple courses at once by providing their IDs. This simplifies the management of courses by automating the archiving process.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archive a list of properties in HubSpot CRM.
Use this tool to archive a provided list of properties within a specified object type in HubSpot CRM. It returns a confirmation of successful archiving, regardless of the properties' initial state.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Archives a specific deal in HubSpot CRM.
Use this tool to move a deal identified by `dealId` to the recycling bin in HubSpot CRM, effectively archiving it. | |||
Archive a batch of discounts by their IDs in HubSpot CRM.
This tool is used to archive multiple discount objects in HubSpot CRM by providing their IDs. It should be called when there's a need to remove or deactivate several discounts at once for organizational or business purposes.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archive a batch of emails by their IDs.
Use this tool to archive multiple emails in the HubSpot CRM by providing their unique IDs. Useful for organizing or cleaning up email records.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archives a batch of fees by their IDs in HubSpot CRM.
Use this tool to archive multiple fee records in HubSpot CRM by providing their IDs. Ideal for managing outdated or unnecessary fee entries efficiently.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archive multiple goal targets using their IDs in one batch.
This tool allows users to archive multiple goal targets in HubSpot CRM by providing their IDs. It's useful for efficiently managing goal targets that are no longer needed.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archive a HubSpot CRM lead by identifier.
Use this tool to move a HubSpot CRM lead, identified by `leadsId`, to the recycling bin. Ideal for managing and removing leads from active status. | |||
Archive a batch of HubSpot CRM objects by ID.
Use this tool to archive multiple objects in HubSpot CRM by specifying their IDs and object type, such as 'contacts' or 'companies'.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Archive multiple HubSpot tasks by their IDs.
Use this tool to archive a batch of tasks in HubSpot CRM by specifying their IDs. It should be called when you need to update the status of tasks to archived.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archive a batch of invoices by their IDs.
Use this tool to archive multiple invoices at once by providing their IDs. It should be called when there is a need to organize or hide invoices that are no longer active or needed.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archive a batch of leads by ID in HubSpot CRM.
Use this tool to archive multiple leads in HubSpot CRM by providing their IDs. Useful for managing large numbers of leads efficiently.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archive a batch of line items in HubSpot CRM.
Use this tool to archive multiple line items at once by their IDs within HubSpot CRM. Ideal for managing and organizing CRM data efficiently.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archive multiple meetings by IDs in batch.
Use this tool to archive a batch of meetings by their IDs in HubSpot CRM. It is suitable for managing and cleaning up old or unnecessary meeting data efficiently.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archive multiple appointments using their IDs.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Archive multiple deals using their IDs in HubSpot CRM.
This tool is used to archive multiple deals in HubSpot CRM by providing their IDs. It should be called when there is a need to batch archive deals efficiently.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Archive multiple listings using their IDs.
This tool archives multiple listings in HubSpot CRM by providing their IDs. It should be called when you need to bulk archive specific listings efficiently.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
HubspotCrmApi.AddAllFromSourceListToDestinationList
Add records from a source list to a destination list in HubSpot. This tool transfers all records from a specified source list to a destination list in HubSpot CRM, ignoring duplicates. Suitable for destination lists with manual or snapshot processing and source lists with fewer than 100,000 memberships.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
destination_list_id | string | Required | The ILS ID of the MANUAL or SNAPSHOT destination list to which the source list records are added. |
source_list_id | string | Required | The ILS ID of the source list from which records are added to the destination list. |
Requirements
Output
json— Response from the API endpoint 'put-/crm/v3/lists/{listId}/memberships/add-from/{sourceListId}_addAllFromList'.HubspotCrmApi.AddToHubspotCrmList
Add records to a specified HubSpot CRM list. Use this tool to add records to a specific HubSpot CRM list. Only works for lists with a processing type of MANUAL or SNAPSHOT. Records that don't exist or are already members will be ignored.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The ILS ID of the MANUAL or SNAPSHOT list to add records. |
record_ids_to_add | array<string> | Required | An array of strings representing the IDs of the records to add to the list. |
Requirements
Output
json— Response from the API endpoint 'put-/crm/v3/lists/{listId}/memberships/add_add'.HubspotCrmApi.ArchiveCallInHubspot
Archive a call in HubSpot CRM by moving it to the recycle bin. Use this tool to move a specific call, identified by its `callId`, to the recycling bin in HubSpot CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
call_identifier | string | Required | The unique identifier for the call to be archived in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/calls/{callId}_archive'.HubspotCrmApi.ArchiveCallsBatch
Archive a batch of calls by their IDs. Use this tool to archive multiple calls in HubSpot CRM by providing their IDs. Archived calls can be restored within 90 days, but call recordings are permanently deleted. Refer to HubSpot's documentation for more details on restoring activities. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/calls/batch/archive_archive'.HubspotCrmApi.ArchiveCartsBatch
Archive multiple carts by ID in a batch operation. Use this tool to archive a batch of shopping carts by their IDs in HubSpot CRM. This is useful for managing and organizing outdated or completed carts. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/carts/batch/archive'.HubspotCrmApi.ArchiveCommercePaymentsBatch
Archive a batch of commerce payments by ID. Use this tool to archive multiple commerce payments at once by their IDs. Ideal for managing and organizing payment data efficiently by removing outdated or unnecessary records in batches. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/commerce_payments/batch/archive'.HubspotCrmApi.ArchiveCommunication
Archive a communication by its ID. Use this tool to move a communication object to the recycling bin by specifying its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
communication_id | string | Required | The unique identifier for the communication object to be archived. It must be a valid string representing an existing communication ID. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/communications/{communicationId}_archive'.HubspotCrmApi.ArchiveContactsBatch
Archive a batch of contacts by ID in HubSpot CRM. Use this tool to archive multiple contacts simultaneously in HubSpot CRM by providing their IDs. This can be useful for managing or cleaning up contact lists efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/contacts/batch/archive'.HubspotCrmApi.ArchiveCoursesBatch
Archive a batch of courses by ID. Use this tool to archive multiple courses at once by providing their IDs. This simplifies the management of courses by automating the archiving process. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-410/batch/archive'.HubspotCrmApi.ArchiveCrmProperties
Archive a list of properties in HubSpot CRM. Use this tool to archive a provided list of properties within a specified object type in HubSpot CRM. It returns a confirmation of successful archiving, regardless of the properties' initial state. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
crm_object_type | string | Optional | Specify the type of CRM object (e.g., 'contacts', 'companies') for which the properties should be archived. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/properties/{objectType}/batch/archive'.HubspotCrmApi.ArchiveDealInHubspot
Archives a specific deal in HubSpot CRM. Use this tool to move a deal identified by `dealId` to the recycling bin in HubSpot CRM, effectively archiving it.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
deal_id | string | Required | The unique identifier of the deal to be archived in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/0-3/{dealId}_archive'.HubspotCrmApi.ArchiveDiscountsBatch
Archive a batch of discounts by their IDs in HubSpot CRM. This tool is used to archive multiple discount objects in HubSpot CRM by providing their IDs. It should be called when there's a need to remove or deactivate several discounts at once for organizational or business purposes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/discounts/batch/archive'.HubspotCrmApi.ArchiveEmailsBatch
Archive a batch of emails by their IDs. Use this tool to archive multiple emails in the HubSpot CRM by providing their unique IDs. Useful for organizing or cleaning up email records. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/emails/batch/archive_archive'.HubspotCrmApi.ArchiveFeesBatch
Archives a batch of fees by their IDs in HubSpot CRM. Use this tool to archive multiple fee records in HubSpot CRM by providing their IDs. Ideal for managing outdated or unnecessary fee entries efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/fees/batch/archive'.HubspotCrmApi.ArchiveGoalTargetsBatch
Archive multiple goal targets using their IDs in one batch. This tool allows users to archive multiple goal targets in HubSpot CRM by providing their IDs. It's useful for efficiently managing goal targets that are no longer needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/goal_targets/batch/archive_archive'.HubspotCrmApi.ArchiveHubspotLead
Archive a HubSpot CRM lead by identifier. Use this tool to move a HubSpot CRM lead, identified by `leadsId`, to the recycling bin. Ideal for managing and removing leads from active status.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
lead_identifier | string | Required | The unique identifier for the lead to be archived in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/leads/{leadsId}_archive'.HubspotCrmApi.ArchiveHubspotObjectsBatch
Archive a batch of HubSpot CRM objects by ID. Use this tool to archive multiple objects in HubSpot CRM by specifying their IDs and object type, such as 'contacts' or 'companies'. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
hubspot_object_type | string | Optional | Specifies the type of HubSpot CRM objects to archive (e.g., 'contacts', 'companies'). Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/{objectType}/batch/archive_archive'.HubspotCrmApi.ArchiveHubspotTasks
Archive multiple HubSpot tasks by their IDs. Use this tool to archive a batch of tasks in HubSpot CRM by specifying their IDs. It should be called when you need to update the status of tasks to archived. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tasks/batch/archive_archive'.HubspotCrmApi.ArchiveInvoicesBatch
Archive a batch of invoices by their IDs. Use this tool to archive multiple invoices at once by providing their IDs. It should be called when there is a need to organize or hide invoices that are no longer active or needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/invoices/batch/archive_archive'.HubspotCrmApi.ArchiveLeadsBatch
Archive a batch of leads by ID in HubSpot CRM. Use this tool to archive multiple leads in HubSpot CRM by providing their IDs. Useful for managing large numbers of leads efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/leads/batch/archive_archive'.HubspotCrmApi.ArchiveLineItemsBatch
Archive a batch of line items in HubSpot CRM. Use this tool to archive multiple line items at once by their IDs within HubSpot CRM. Ideal for managing and organizing CRM data efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/line_items/batch/archive_archive'.HubspotCrmApi.ArchiveMeetingsBatch
Archive multiple meetings by IDs in batch. Use this tool to archive a batch of meetings by their IDs in HubSpot CRM. It is suitable for managing and cleaning up old or unnecessary meeting data efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/meetings/batch/archive_archive'.HubspotCrmApi.ArchiveMultipleAppointments
Archive multiple appointments using their IDs. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
appointment_object_type | string | Optional | The type of object to be archived, typically 'appointments' for this endpoint. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/objects/v3/{objectType}/batch/archive'.HubspotCrmApi.ArchiveMultipleDeals
Archive multiple deals using their IDs in HubSpot CRM. This tool is used to archive multiple deals in HubSpot CRM by providing their IDs. It should be called when there is a need to batch archive deals efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-3/batch/archive_archive'.HubspotCrmApi.ArchiveMultipleListings
Archive multiple listings using their IDs. This tool archives multiple listings in HubSpot CRM by providing their IDs. It should be called when you need to bulk archive specific listings efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-420/batch/archive'.HubspotCrmApi.ArchiveNotesBatch
Archive a batch of notes by their IDs. Use this tool to archive multiple notes in HubSpot CRM by providing their IDs. Ideal for managing large numbers of notes that need to be archived simultaneously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/notes/batch/archive_archive'.HubspotCrmApi.ArchiveOrdersBatch
Archive a batch of orders by ID in HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/orders/batch/archive'.HubspotCrmApi.ArchivePostalMail
Archive a postal mail object in HubSpot CRM. This tool moves a postal mail object, specified by its ID, to the recycling bin in HubSpot CRM. Use this tool when you need to archive a specific postal mail entry.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
postal_mail_id | string | Required | The unique identifier of the postal mail object to be archived. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/postal_mail/{postalMailId}_archive'.HubspotCrmApi.ArchivePostalMailBatch
Archive a batch of postal mail objects using their IDs. Use this tool to archive multiple postal mail objects in HubSpot CRM by providing their IDs. This is useful for managing large volumes of mailing data efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/postal_mail/batch/archive_archive'.HubspotCrmApi.ArchiveProductsBatch
Archive a batch of products by ID in HubSpot CRM. Use this tool to archive multiple products in HubSpot CRM by providing their IDs. It should be called when you need to bulk remove products from the CRM database. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/products/batch/archive_archive'.HubspotCrmApi.ArchiveQuote
Archive a quote by moving it to the recycling bin. This tool archives a quote in HubSpot CRM, identified by its `quoteId`, by moving it to the recycling bin. Use this tool when you need to delete a quote temporarily.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
quote_identifier | string | Required | The unique identifier for the quote to be archived in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/quotes/{quoteId}_archive'.HubspotCrmApi.ArchiveQuotesBatch
Archive a batch of quotes in HubSpot CRM. Use this tool to archive multiple quotes in HubSpot CRM by providing their IDs. It should be called when there's a need to bulk archive quotes to manage CRM records efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/quotes/batch/archive_archive'.HubspotCrmApi.ArchiveServicesBatch
Archive multiple services using their IDs in bulk. Use this tool to archive a batch of services in the CRM by providing their IDs. This is useful for managing large sets of records efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-162/batch/archive'.HubspotCrmApi.ArchiveSubscriptionsBatch
Archive a batch of subscriptions by ID in HubSpot CRM. Use this tool to archive multiple subscriptions at once by providing their IDs. This is useful for managing bulk subscription updates in HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/subscriptions/batch/archive'.HubspotCrmApi.ArchiveTaxBatch
Archive a batch of taxes by their IDs. This tool archives a batch of taxes in the HubSpot CRM by their IDs. It should be called when you need to remove or deactivate multiple tax records at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/taxes/batch/archive_archive'.HubspotCrmApi.ArchiveUsersBatch
Archives a batch of users by their IDs in HubSpot CRM. Use this tool to archive multiple users at once by providing their IDs to the HubSpot CRM system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/users/batch/archive'.HubspotCrmApi.AssociatePartnerClientWithObject
Associate a partner client with another CRM object. Use this tool to create an association between a partner client and another object in the CRM system, such as a contact, company, or deal. This can help in linking related entities for better data management and relationship tracking.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
association_type | string | Required | Specifies the type of association (e.g., contact, company, deal) between the partner client and the object. |
partner_client_id | string | Required | The unique identifier for the partner client you wish to associate with another object. This should be a string representing the partner client's ID in the CRM system. |
target_object_id | string | Required | The unique identifier of the CRM object you are associating with the partner client. This could be any valid object ID such as that of a contact, company, or deal. |
target_object_type | string | Required | The type of the object to associate with the partner client (e.g., contact, company, deal). |
Requirements
Output
json— Response from the API endpoint 'put-/crm/v3/objects/partner_clients/{partnerClientId}/associations/{toObjectType}/{toObjectId}/{associationType}'.HubspotCrmApi.AssociatePartnerService
Associate a partner service with another CRM object. Use this tool to associate a partner service with another CRM object in HubSpot, such as contacts, companies, or deals. This is useful when you want to establish connections between different objects in your CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
association_type | string | Required | Specifies the type of association to create between the partner service and another object (e.g., "owner", "affiliate"). |
partner_service_id | string | Required | The identifier for the partner service to associate with another object. This should be a valid string representing the unique ID of the partner service in the CRM. |
target_object_id | string | Required | The ID of the target object you want to associate with the partner service. This should be a valid object ID in HubSpot CRM. |
target_object_type | string | Required | The type of CRM object to associate with the partner service, e.g., 'contacts', 'companies', or 'deals'. |
Requirements
Output
json— Response from the API endpoint 'put-/crm/v3/objects/partner_services/{partnerServiceId}/associations/{toObjectType}/{toObjectId}/{associationType}'.HubspotCrmApi.BatchCreateTimelineEvents
Batch create multiple timeline event instances. Batch create multiple timeline events using an event template. Created events are immutable and can trigger updates to object properties if configured in the template. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/integrators/timeline/v3/events/batch/create_createBatch'.HubspotCrmApi.BatchReadAssociations
Retrieve batch associations between CRM object types in HubSpot. This tool retrieves a batch of association data between specified CRM object types in HubSpot, such as contacts to companies. Use it to efficiently access multiple associations at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
source_object_type | string | Optional | The CRM object type from which the associations originate, such as 'contacts' or 'deals'. Specify a valid CRM object type. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
destination_object_type | string | Optional | Specify the CRM object type to associate with, such as 'contacts' or 'companies'. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/read_read'.HubspotCrmApi.BatchReadContacts
Retrieve multiple contacts using internal IDs or unique properties. Use this tool to read a batch of contacts from HubSpot CRM by providing their internal IDs or unique property values. Ideal for situations where multiple contact details are needed simultaneously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_only | boolean | Optional | Set to True to return only archived contacts. False excludes them. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/contacts/batch/read'.HubspotCrmApi.BatchReadPartnerClients
Fetch batch details of partner clients in HubSpot CRM. Use this tool to retrieve information for multiple partner clients at once from HubSpot CRM. Ideal for scenarios where bulk data about partner clients is needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
include_archived | boolean | Optional | Set to true to include archived partner clients in the batch results. Default is false. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/partner_clients/batch/read'.HubspotCrmApi.BatchRetrieveHubspotRecords
Retrieve HubSpot CRM records using batch read. This tool retrieves records from HubSpot CRM by record ID or custom unique property in a batch. Use it when you need to access multiple entities by their specific identifiers. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
crm_object_type | string | Optional | Specify the type of CRM object to retrieve, such as 'contact', 'deal', or 'company'. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
return_archived_results | boolean | Optional | Set to true to return only archived results. Use false to include active records. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/{objectType}/batch/read_read'.HubspotCrmApi.BatchUpdateNotes
Update multiple notes in HubSpot CRM by ID or property. Use this tool to update a batch of notes in HubSpot CRM by their internal IDs or unique property values. Ideal for situations where multiple notes need simultaneous modifications. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/notes/batch/update_update'.HubspotCrmApi.BatchUpsertRecords
Create or update HubSpot CRM records via unique identifier. This tool creates or updates HubSpot CRM records based on a unique property identifier specified by the `idProperty` parameter. It is useful for ensuring records are maintained accurately in the CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-410/batch/upsert'.HubspotCrmApi.CreateBatchAppointments
Create multiple appointments in one request. This tool facilitates the creation of multiple appointments in a single API call. Use it when you need to schedule several appointments efficiently without making multiple requests. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
appointment_object_type | string | Optional | Specify the type of CRM object for the appointments, typically 'appointments'. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/objects/v3/{objectType}/batch/create'.HubspotCrmApi.CreateBatchAssociationsHubspot
Batch create associations between object types in HubSpot CRM. This tool is used to batch create associations between two specified object types in HubSpot CRM, such as associating multiple contacts with companies in one request. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
from_object_type | string | Optional | The type of the source object for the association (e.g., 'contact', 'company'). Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
target_object_type | string | Optional | The type of the object that the associations will point to (e.g., 'contacts', 'companies'). Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create_create'.HubspotCrmApi.CreateBatchCommercePayments
Create a batch of commerce payments in HubSpot CRM. This tool is used to create a batch of commerce payments in the HubSpot CRM system. It should be called when there's a need to process multiple payment entries at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/commerce_payments/batch/create'.HubspotCrmApi.CreateBatchContacts
Create a batch of contacts in HubSpot CRM. Use this tool to create multiple contacts in HubSpot CRM at once. Ideal for bulk uploading contact information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/contacts/batch/create'.HubspotCrmApi.CreateBatchDiscountsHubspot
Create a batch of discounts in HubSpot. Use this tool to create multiple discounts simultaneously in HubSpot CRM. It should be called when batch creation of discounts is needed, providing an efficient way to manage discount entries. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/discounts/batch/create'.HubspotCrmApi.CreateBatchFees
Create a batch of fees in HubSpot CRM. This tool allows the creation of multiple fees in a single batch within HubSpot CRM. It should be called when there is a need to add a set of new fees to the CRM system efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/fees/batch/create'.HubspotCrmApi.CreateBatchMeetings
Create a batch of meetings in HubSpot CRM. Use this tool to efficiently create multiple meetings at once in HubSpot CRM. Ideal for scheduling large numbers of meetings in a single operation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/meetings/batch/create_create'.HubspotCrmApi.CreateBatchOfCalls
Create a batch of calls with specified properties and associations. This tool is used to create multiple calls at once in HubSpot CRM, specifying properties for each call and defining associations with other CRM records as needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/calls/batch/create_create'.HubspotCrmApi.CreateBatchOfCarts
Create a batch of carts efficiently in HubSpot CRM. Use this tool to create multiple shopping carts at once within HubSpot CRM. Ideal for managing cart data in bulk efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/carts/batch/create'.HubspotCrmApi.CreateBatchOfCompanies
Create a batch of companies with properties and associations. This tool allows you to create multiple companies in one request. Each company can have specific property values and can be associated with other CRM records. Use this when needing to add several companies at once along with their details and relationships. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/companies/batch/create_create'.HubspotCrmApi.CreateBatchOfCourses
Create a batch of courses in CRM. Use this tool to add multiple courses at once to HubSpot CRM. Ideal for instances where you need to create several course entries simultaneously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-410/batch/create'.HubspotCrmApi.CreateBatchOfEmails
Create a batch of emails with specified properties. This tool is used to create multiple emails at once in a batch, using specified properties, and returns the details of the created email objects. Ideal for situations where several emails need to be generated and saved in the CRM system at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/emails/batch/create_create'.HubspotCrmApi.CreateBatchOfInvoices
Create a batch of invoices swiftly. Use this tool to create multiple invoices at once in HubSpot CRM when bulk billing is required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/invoices/batch/create_create'.HubspotCrmApi.CreateBatchOfNotes
Create multiple notes in a CRM batch operation. Use this tool to create a batch of notes in HubSpot CRM. Ideal for adding multiple notes efficiently in a single operation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/notes/batch/create_create'.HubspotCrmApi.CreateBatchOfProducts
Create a batch of products in HubSpot CRM. Use this tool to add multiple products to the HubSpot CRM in a single batch. Ideal for updating product catalogs efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/products/batch/create_create'.HubspotCrmApi.CreateBatchOfQuotes
Creates a batch of quotes in HubSpot CRM. This tool is used to create multiple quotes at once using HubSpot CRM's batch creation endpoint. Ideal for automating the quote generation process for multiple clients or deals. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/quotes/batch/create_create'.HubspotCrmApi.CreateBatchOfServices
Create a batch of services in HubSpot CRM. Use this tool to create multiple service entries at once within HubSpot CRM. This is useful for efficiently managing and organizing service-related data. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-162/batch/create'.HubspotCrmApi.CreateBatchOrders
Create a batch of orders in HubSpot CRM. Use this tool to create multiple orders at once in HubSpot CRM. It is suitable when you need to efficiently process and record several orders simultaneously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/orders/batch/create'.HubspotCrmApi.CreateBatchProperties
Create a batch of properties for a specified object type in HubSpot. This tool facilitates the creation of multiple properties at once for any specified object type in HubSpot CRM, using the standard rules applied to individual property creation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
object_type | string | Optional | Specifies the type of CRM object for which to create properties (e.g., contacts, deals, companies). Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/properties/{objectType}/batch/create'.HubspotCrmApi.CreateBatchSubscriptions
Create a batch of subscriptions in HubSpot CRM. This tool is used to create multiple subscriptions at once in HubSpot CRM. Call this tool when you need to add several subscriptions simultaneously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/subscriptions/batch/create'.HubspotCrmApi.CreateBatchTasks
Create a batch of tasks in HubSpot CRM. This tool is used to create multiple tasks at once in HubSpot CRM, streamlining task management processes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tasks/batch/create_create'.HubspotCrmApi.CreateBatchTickets
Create a batch of tickets in HubSpot CRM. Use this tool to create multiple tickets in HubSpot CRM at once. You can specify property values for each ticket and define associations with other CRM records. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tickets/batch/create_create'.HubspotCrmApi.CreateCartHubspotCrm
Create a cart and retrieve its details including ID. Use this tool to create a new cart in HubSpot CRM with specified properties. It returns a detailed cart object including its unique ID. Ideal for setting up new customer carts. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/carts'.HubspotCrmApi.CreateCommercePayment
Create a commerce payment and return its details. Use this tool to create a new commerce payment in the HubSpot CRM. It returns the details of the payment, including the unique ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/commerce_payments'.HubspotCrmApi.CreateCompanyHubspot
Create a new company in HubSpot CRM. Use this tool to create a single company in HubSpot CRM. It allows you to define property values for the company and specify associations with other CRM records. Ideal for organizing and managing company information efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/companies_create'.HubspotCrmApi.CreateCrmAppointment
Create an appointment in the CRM with specified properties. Use this tool to schedule a new appointment within the CRM system. It requires the necessary properties for the appointment and returns the created appointment object along with its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
appointment_object_type | string | Optional | Specifies the type of CRM object to create. For appointments, this should be 'appointment'. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/objects/v3/{objectType}'.HubspotCrmApi.CreateCrmObject
Create a CRM object and retrieve its details. This tool creates a new CRM object in HubSpot with specified properties and returns the object, including its ID. Use it to add contacts, companies, deals, etc., to your HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
crm_object_type | string | Optional | Specify the type of CRM object to create, such as 'contact', 'company', or 'deal'. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/{objectType}_create'.HubspotCrmApi.CreateCrmObjectAssociation
Create an association between HubSpot CRM objects. This tool creates an association between specified HubSpot CRM objects. Use it when you need to link different CRM objects (like contacts and companies) within the HubSpot platform.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
crm_object_type_schema | string | Required | Fully qualified name or object type ID of your CRM object schema to create the association. |
primary_object_type_id | string | Required | ID of the primary object type to link from in the CRM system. |
target_object_type_id | string | Required | ID of the target object type to link to in the CRM association. |
association_name | string | Optional | A unique name for the association between CRM objects. This helps identify the link. |
Requirements
Output
json— Response from the API endpoint 'post-/crm-object-schemas/v3/schemas/{objectType}/associations_createAssociation'.HubspotCrmApi.CreateCrmObjectSchema
Create a new CRM object schema in HubSpot. Use this tool to create a new object schema in HubSpot's CRM. This is useful when you need to define a new structure for CRM objects tailored to specific business needs. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm-object-schemas/v3/schemas_create'.HubspotCrmApi.CreateCrmPipeline
Create a new CRM pipeline in HubSpot. Use this tool to create a new pipeline in HubSpot CRM with given property values. It returns the entire pipeline object, including its unique ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
pipeline_object_type | string | Optional | Specify the type of CRM object for the pipeline, such as 'deals' or 'tickets'. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/pipelines/{objectType}_create'.HubspotCrmApi.CreateCrmUser
Create a new user in the CRM and retrieve their ID. Use this tool to create a new user in the HubSpot CRM system. The tool will return a detailed user object, including the newly assigned ID. This is useful for adding new users to your CRM database. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/users'.HubspotCrmApi.CreateDiscount
Creates a discount and returns its details. Use this tool to create a new discount with specified properties in HubSpot CRM. It returns the created discount object along with its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/discounts'.HubspotCrmApi.CreateFeeInCrm
Create a fee in the CRM and receive the object's details. Call this tool to add a new fee in the CRM system using specified properties. It returns the newly created fee object along with its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/fees'.HubspotCrmApi.CreateFolderHubspotCrm
Creates a folder in HubSpot CRM with specified details. Use this tool to create a new folder in HubSpot CRM by providing the necessary information for the folder you want to create.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_name | string | Required | The name of the folder to be created in HubSpot CRM. |
parent_folder_id | string | Optional | The ID of the folder where the new folder will be created. Defaults to root folder (ID: 0) if not specified. |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/lists/folders_create'.HubspotCrmApi.CreateGoalTarget
Create a goal target in HubSpot CRM. Use this tool to create a new goal target in the HubSpot CRM system. It takes the properties for the goal target and returns a copy of the created object along with its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/goal_targets_create'.HubspotCrmApi.CreateGoalTargetsBatch
Batch create multiple goal targets in HubSpot CRM. Use this tool to create multiple goal targets at once in HubSpot CRM. It is suited for managing and setting up several targets simultaneously, aiding in efficient CRM organization. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/goal_targets/batch/create_create'.HubspotCrmApi.CreateHubspotCall
Create a call in HubSpot with specified properties. Use this tool to create a call in HubSpot CRM with specified properties. It returns the newly created call details, including its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/calls_create'.HubspotCrmApi.CreateHubspotCommunication
Create a new communication entry in HubSpot CRM. This tool creates a communication in HubSpot CRM with specified properties and returns the created object, including its ID. Use this when you need to log or track communications within the CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/communications_create'.HubspotCrmApi.CreateHubspotContact
Create a contact in HubSpot CRM and retrieve its details. Use this tool to add a new contact to HubSpot CRM by specifying the desired properties. It returns a copy of the contact, including its unique ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/contacts'.HubspotCrmApi.CreateHubspotCourse
Create a course in HubSpot CRM and return its details. Use this tool to create a new course in HubSpot CRM with specified properties. It returns the course details, including the generated ID, upon successful creation. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-410'.HubspotCrmApi.CreateHubspotCrmProperty
Create a new property for a specified object type in HubSpot CRM. This tool creates and returns a new property for the specified object type in HubSpot CRM. It should be used when you need to add a custom property to an object such as a contact, company, or deal in HubSpot. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
object_type | string | Optional | Specify the object type to which the new property will be added, such as contact, company, or deal. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/properties/{objectType}'.HubspotCrmApi.CreateHubspotDeal
Create a new deal in HubSpot CRM. Use this tool to create a new deal in HubSpot CRM by specifying the necessary properties. It returns the created deal object along with its unique ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-3_create'.HubspotCrmApi.CreateHubspotEmail
Create an email in HubSpot CRM and retrieve its details. Use this tool to create a new email in HubSpot CRM by specifying certain properties. It returns the created email object along with its ID, facilitating the organization and tracking of email records within the CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/emails_create'.HubspotCrmApi.CreateHubspotInvoice
Create an invoice in HubSpot CRM and retrieve its details. This tool creates a new invoice in HubSpot CRM using the provided properties and returns the created invoice's details, including its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/invoices_create'.HubspotCrmApi.CreateHubspotLineItem
Create a new line item in HubSpot CRM. This tool creates a line item in HubSpot CRM with specified properties and returns the complete object, including its ID. Use this when you need to add a line item to HubSpot. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/line_items_create'.HubspotCrmApi.CreateHubspotListing
Create a HubSpot CRM listing and get the object details. Use this tool to create a listing in HubSpot CRM with specified properties. It returns the newly created object's details, including its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-420'.HubspotCrmApi.CreateHubspotMeeting
Create a meeting in HubSpot and get its details. This tool is used to create a meeting in HubSpot CRM with specific properties. It returns the details of the created meeting, including the unique ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/meetings_create'.HubspotCrmApi.CreateHubspotMessagesBatch
Create a batch of messages in HubSpot CRM. Use this tool to create multiple messages in HubSpot CRM simultaneously. Ideal for handling bulk message creation with optional properties and associations with other CRM records. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/communications/batch/create_create'.HubspotCrmApi.CreateHubspotObjectsBatch
Create a batch of objects in HubSpot CRM. Use this tool to create multiple objects at once in HubSpot CRM. Suitable for handling bulk operations where several objects need to be created simultaneously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
hubspot_object_type | string | Optional | Specifies the type of object to create in HubSpot, such as 'contacts', 'deals', or 'companies'. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/{objectType}/batch/create_create'.HubspotCrmApi.CreateHubspotOrder
Create a new order in HubSpot CRM with specified properties. Use this tool to create a new order in the HubSpot CRM system. It returns the details and ID of the created order, allowing further tracking and management. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/orders'.HubspotCrmApi.CreateHubspotQuote
Create a new quote in HubSpot CRM. Use this tool to create a new quote in HubSpot CRM with specified properties. It returns the created quote, including its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/quotes_create'.HubspotCrmApi.CreateHubspotTax
Create a tax in HubSpot CRM and retrieve its details. This tool creates a tax with specified properties in HubSpot CRM and returns a detailed object including the newly assigned ID. Use this for adding new tax records to your CRM system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/taxes_create'.HubspotCrmApi.CreateLeadHubspot
Create a new lead in HubSpot CRM. Use this tool to create a new lead in HubSpot CRM by providing the necessary properties. It returns a copy of the lead object, including the ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/leads_create'.HubspotCrmApi.CreateLeadsBatch
Create a batch of new leads in HubSpot CRM. Use this tool to add multiple new leads to your HubSpot CRM account in one operation. Ideal for onboarding new leads efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/leads/batch/create_create'.HubspotCrmApi.CreateLineItemsBatch
Create a batch of line items in HubSpot CRM. Use this tool to create multiple line items at once in HubSpot CRM. Ideal for bulk operations where several line items need to be added simultaneously to the system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/line_items/batch/create_create'.HubspotCrmApi.CreateMultipleDeals
Create multiple deals in HubSpot CRM in one request. Use this tool to batch create multiple deals in HubSpot CRM efficiently. It should be called when you need to add several deals at once, reducing the number of individual requests. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-3/batch/create_create'.HubspotCrmApi.CreateMultipleListings
Create multiple listings in a single request. Use this tool to add several listings to the CRM in one operation. Ideal for bulk uploads or extensive data entry tasks. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-420/batch/create'.HubspotCrmApi.CreateNoteInHubspot
Create a note in HubSpot CRM and return its details. Use this tool to create a note in HubSpot CRM with specified properties. It returns a copy of the created note object, including its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/notes_create'.HubspotCrmApi.CreateObjectAssociation
Create an association between two CRM objects in HubSpot. Use this tool to link two objects in HubSpot CRM by specifying their types, IDs, and the type of association. This is useful for connecting related records, such as associating a contact with a specific company or deal.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
association_type | string | Required | Specifies the type of association to create between the objects, such as 'contact_to_company'. |
source_object_id | string | Required | The ID of the primary object to associate in HubSpot. This should be a valid string representing the CRM object's unique identifier. |
source_object_type | string | Required | Type of the source object. Specify the CRM object type, such as 'contact', 'company', or 'deal'. |
target_object_id | string | Required | The ID of the target object to associate with. This is the object you want to link to the main object in HubSpot CRM. |
target_object_type | string | Required | The type of the target object to associate. Examples include 'contact', 'company', or 'deal'. |
Requirements
Output
json— Response from the API endpoint 'put-/crm/objects/v3/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}/{associationType}'.HubspotCrmApi.CreateOrUpdateBatchRecords
Create or update CRM records in batches. Use this tool to create or update records in the CRM identified by a unique property value. It allows handling multiple records in a single batch operation, specified by the `idProperty`. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-420/batch/upsert'.HubspotCrmApi.CreateOrUpdateCompanies
Create or update companies in HubSpot CRM using a unique identifier. This tool creates or updates companies in the HubSpot CRM based on a unique identifier property. It should be called when you need to batch upsert company records identified by a unique property. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/companies/batch/upsert_upsert'.HubspotCrmApi.CreateOrUpdateHubspotEmails
Create or update HubSpot email records in batch. This tool allows you to create or update email records in HubSpot's CRM by using a unique property value to identify the records. It's useful when you need to manage email data efficiently by ensuring existing records are updated and new ones are created where needed. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/emails/batch/upsert_upsert'.HubspotCrmApi.CreateOrUpdateHubspotRecords
Create or update HubSpot CRM records using unique properties. This tool is used to create or update HubSpot CRM records by leveraging unique property values for identification. It ensures that records are upserted based on the provided unique identifier. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-3/batch/upsert_upsert'.HubspotCrmApi.CreateOrUpdateQuotes
Create or update quote records in HubSpot CRM. This tool is used to create or update quote records in HubSpot CRM based on a unique property value specified by `idProperty`. Use it when you need to ensure quotes are updated or added to the CRM system efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/quotes/batch/upsert_upsert'.HubspotCrmApi.CreateOrUpdateTaxRecords
Create or update tax records based on unique properties. This tool creates or updates tax records in HubSpot CRM by using unique property values specified by the `idProperty` parameter. It should be called when you need to ensure tax records are correctly up-to-date by leveraging existing unique identifiers. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/taxes/batch/upsert_upsert'.HubspotCrmApi.CreatePipelineStage
Create a stage in a specified pipeline. This tool creates a new stage within a specified pipeline in the HubSpot CRM. Use it when you need to add a new stage to an existing pipeline, specifying the object type and pipeline ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
crm_object_type | string | Optional | Specify the CRM object type, such as deals or tickets, for the pipeline. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
pipeline_id | string | Optional | The unique identifier of the pipeline where the new stage will be created. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/pipelines/{objectType}/{pipelineId}/stages_create'.HubspotCrmApi.CreatePostalMailBatch
Create a batch of postal mail objects in HubSpot CRM. Use this tool to create multiple postal mail records within the HubSpot CRM system. Ideal for handling bulk postal mail operations efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/postal_mail/batch/create_create'.HubspotCrmApi.CreatePostalMailObject
Create a postal mail object in HubSpot CRM. This tool is used to create a postal mail object in the HubSpot CRM with the provided properties. It returns a copy of the created object, including its unique identifier. Use this tool to record postal mail interactions in your CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/postal_mail_create'.HubspotCrmApi.CreateProductInHubspot
Create a new product in HubSpot CRM. Use this tool to create a product in HubSpot CRM with specified properties. It returns the created product details, including the ID, which can be used for further referencing or operations. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/products_create'.HubspotCrmApi.CreatePropertyGroup
Create a new property group in HubSpot CRM. This tool creates and returns a new property group for a specified object type in HubSpot CRM. Use it when you need to organize CRM properties into groups.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
internal_property_group_name | string | Required | The unique name used internally to reference the property group via the API. |
object_type | string | Required | Specifies the CRM object type for the property group (e.g., contacts, companies). |
property_group_label | string | Required | A human-readable label for the property group, displayed in HubSpot. |
property_group_display_order | integer | Optional | Defines the display order of the property group, with lowest positive integers displayed first. Use -1 to display after positive values. |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/properties/{objectType}/groups'.HubspotCrmApi.CreateServiceRecord
Create a service record in HubSpot CRM. This tool creates a new service object in HubSpot CRM with the specified properties and returns the created object, including its ID. It's useful for adding new service records to the CRM system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-162'.HubspotCrmApi.CreateSubscription
Create a new subscription in HubSpot CRM. This tool creates a subscription in HubSpot CRM using specified properties and returns a copy of the object with its ID included. Use it to add new subscriptions to the CRM system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/subscriptions'.HubspotCrmApi.CreateTaskInCrm
Create a task in HubSpot CRM and return task details. This tool creates a task in HubSpot CRM with specified properties and returns the task details, including the ID. It should be called when you need to add a new task to the CRM system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tasks_create'.HubspotCrmApi.CreateTaxBatch
Create a batch of taxes in HubSpot CRM. Use this tool to create multiple tax records at once in HubSpot CRM. Ideal for situations where bulk tax data entry is required. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/taxes/batch/create_create'.HubspotCrmApi.CreateTicket
Create a support ticket in HubSpot CRM. Use this tool to create a new support ticket with specified properties in HubSpot CRM and receive a copy of the ticket object along with its ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tickets_create'.HubspotCrmApi.CreateUsersBatch
Create a batch of users in the CRM system. Use this tool to create multiple users at once in the HubSpot CRM. It should be called when there is a need to add multiple users efficiently through a single command. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/users/batch/create'.HubspotCrmApi.DeleteBatchMessages
Delete a batch of messages by ID with restoration option. Delete multiple messages by their IDs. Deleted messages can be restored within 90 days. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/communications/batch/archive_archive'.HubspotCrmApi.DeleteCallTranscript
Delete a call transcript by transcript ID. Removes a call transcript identified by transcript ID from the HubSpot CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transcript_id | string | Required | The unique identifier for the call transcript you want to delete from the HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/extensions/calling/transcripts/{transcriptId}'.HubspotCrmApi.DeleteCommercePayment
Delete a commerce payment from the CRM system. Use this tool to move a specified commerce payment to the recycling bin by providing the payment ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
commerce_payment_id | string | Required | The unique identifier for the commerce payment to be moved to the recycling bin. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/commerce_payments/{commercePaymentId}'.HubspotCrmApi.DeleteCompaniesBatch
Delete a batch of companies by ID in HubSpot CRM. This tool deletes a batch of companies in HubSpot CRM using their IDs. Deleted companies can be restored within 90 days. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/companies/batch/archive_archive'.HubspotCrmApi.DeleteCompany
Delete a company by ID in HubSpot CRM. Use this tool to delete a company by its ID in HubSpot CRM. Deleted companies can be restored within 90 days if needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
company_id | string | Required | The unique identifier of the company to be deleted in HubSpot CRM. This ID is required to specify the company. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/companies/{companyId}_archive'.HubspotCrmApi.DeleteContact
Delete a contact and move it to the recycling bin. Use this tool to delete a contact in HubSpot CRM, identified by `contactId`, moving it to the recycling bin.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_id | string | Required | The unique identifier of the contact to be deleted and moved to the recycling bin. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/contacts/{contactId}'.HubspotCrmApi.DeleteCourse
Delete a course by moving it to the recycling bin. This tool deletes a specific course in the CRM by moving it to the recycling bin, identified by the provided `courseId`. Use this when you need to remove a course from the CRM records.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
course_id | string | Required | The unique identifier for the course to be deleted. This identifier is used to locate the specific course in the CRM system. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/0-410/{courseId}'.HubspotCrmApi.DeleteCrmAssociation
Remove an association between CRM object schemas. This tool is used to delete an association between specified CRM object schemas in HubSpot. It should be called when there is a need to remove or archive a link between two object types.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
association_id | string | Required | Unique ID of the association to be removed. |
schema_object_type | string | Required | The fully qualified name or object type ID of your schema to identify which CRM object to target. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm-object-schemas/v3/schemas/{objectType}/associations/{associationIdentifier}_archiveAssociation'.HubspotCrmApi.DeleteCrmFolder
Deletes a specified CRM folder by ID. Use this tool to delete a folder in HubSpot CRM by providing the folder ID. It should be called when a specific folder needs to be permanently removed from the CRM system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_id_to_delete | string | Required | The ID of the folder to be deleted in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/lists/folders/{folderId}_remove'.HubspotCrmApi.DeleteCrmObject
Delete a CRM object and move it to the recycling bin. Use this tool to delete an object in HubSpot CRM by specifying the object type and ID. The object will be moved to the recycling bin.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
crm_object_id | string | Required | The unique identifier for the CRM object to be deleted. This ID specifies which object will be moved to the recycling bin. |
crm_object_type | string | Required | Specify the type of CRM object to delete, such as 'contact', 'deal', or 'company'. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/objects/v3/{objectType}/{objectId}'.HubspotCrmApi.DeleteCrmObjectSchema
Delete a CRM object schema in HubSpot. This tool deletes a specified CRM object schema in HubSpot. Use it when you need to remove an existing schema, ensuring it's no longer accessible or in use.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type_identifier | string | Required | The fully qualified name or object type ID of the schema to delete. |
return_only_archived_results | boolean | Optional | Set to True to return only archived results. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm-object-schemas/v3/schemas/{objectType}_archive'.HubspotCrmApi.DeleteDiscount
Delete a discount and move it to the recycling bin. Use this tool to delete a discount object in HubSpot CRM by moving it to the recycling bin. Call it when you need to remove discounts identified by a specific discount ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
discount_identifier | string | Required | The unique identifier of the discount object to delete and move to the recycling bin. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/discounts/{discountId}'.HubspotCrmApi.DeleteEmail
Move an email to the recycling bin using its ID. This tool moves an email identified by `emailId` to the recycling bin in HubSpot CRM. It should be used when an email needs to be archived or deleted from active view.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
email_id | string | Required | The unique identifier of the email to be archived in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/emails/{emailId}_archive'.HubspotCrmApi.DeleteFeeObject
Move a fee object to the recycling bin using its fee ID. Call this tool to delete a fee object in HubSpot CRM. Useful for removing unwanted or outdated fee records by providing the specific fee ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fee_id_to_delete | string | Required | The unique identifier of the fee object to be deleted in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/fees/{feeId}'.HubspotCrmApi.DeleteGoalTarget
Deletes a goal target by its ID to the recycling bin. Use this tool to delete a specific goal target by providing its unique ID. This action will move the target to the recycling bin, allowing for potential recovery.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
goal_target_id | string | Required | The unique identifier for the goal target to be deleted. Required to specify which target to move to the recycling bin. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/goal_targets/{goalTargetId}_archive'.HubspotCrmApi.DeleteHubspotTicketsBatch
Delete a batch of tickets in HubSpot CRM. Use this tool to delete multiple tickets by ID in HubSpot CRM. Deleted tickets can be restored within 90 days. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tickets/batch/archive_archive'.HubspotCrmApi.DeleteInvoice
Archive an invoice by moving it to the recycling bin. Use this tool to archive an invoice in HubSpot CRM by moving it to the recycling bin. It is identified by the `{invoiceId}` parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_identifier | string | Required | The unique identifier for the invoice to be archived in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/invoices/{invoiceId}_archive'.HubspotCrmApi.DeleteLineItem
Moves a specified line item to the recycling bin. This tool is used to delete or archive a line item in HubSpot CRM by moving it to the recycling bin. It should be called when a user wants to remove a line item identified by its `lineItemId`.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
line_item_id | string | Required | The unique identifier of the line item to be archived or deleted. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/line_items/{lineItemId}_archive'.HubspotCrmApi.DeleteList
Delete a specified CRM list by its ID. Use this tool to delete a CRM list using its ID. Deleted lists can be restored within 90 days, after which they'll be permanently removed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id_to_delete | string | Required | The ILS ID of the CRM list to delete. Ensure the ID is correct to avoid unintentional deletion. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/lists/{listId}_remove'.HubspotCrmApi.DeleteMeeting
Move a meeting to the recycling bin using its ID. This tool is used to move a meeting, identified by its meeting ID, to the recycling bin in the HubSpot CRM. It is useful when you need to archive or remove a meeting from active records.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
meeting_id | string | Required | The unique ID of the meeting to be moved to the recycling bin. This is required to identify the specific meeting. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/meetings/{meetingId}_archive'.HubspotCrmApi.DeleteNoteHubspot
Move a HubSpot note to the recycling bin. Use this tool to move a note identified by `noteId` in HubSpot CRM to the recycling bin. This is useful for soft-deleting notes when they are no longer needed in the immediate CRM workspace.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
note_id | string | Required | The unique identifier of the note to be archived in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/notes/{noteId}_archive'.HubspotCrmApi.DeleteObjectHubspot
Move an object to the recycling bin in HubSpot CRM. Use this tool to delete an object identified by `serviceId` within the HubSpot CRM, moving it to the recycling bin.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_service_id | string | Required | The unique identifier for the object to be moved to the recycling bin in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/0-162/{serviceId}'.HubspotCrmApi.DeleteOrderById
Deletes an order by its ID from the CRM. Use this tool to delete an order from the CRM system by providing its unique ID. The order will be moved to the recycling bin, allowing for potential recovery later if needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
order_id | string | Required | The unique ID of the order to delete, moving it to the recycling bin. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/orders/{orderId}'.HubspotCrmApi.DeletePipeline
Delete a specific pipeline in the CRM. This tool is used to delete a specific pipeline in HubSpot CRM by providing the object type and pipeline ID. Call this tool when a pipeline needs to be removed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
pipeline_id | string | Required | The unique identifier of the pipeline to be deleted. Required for specifying which pipeline to remove. |
pipeline_object_type | string | Required | Specify the type of object for the pipeline, such as 'deals' or 'tickets'. |
validate_deal_stage_usages_before_deletion | boolean | Optional | Set to true to validate deal stage usages before deleting a pipeline, preventing deletion if usages are found. |
validate_references_before_delete | boolean | Optional | Set to true to validate references before deleting the pipeline. This prevents accidental deletion when references are present. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/pipelines/{objectType}/{pipelineId}_archive'.HubspotCrmApi.DeletePipelineStage
Deletes a pipeline stage from HubSpot CRM. Use to remove a specific stage from a pipeline in HubSpot CRM by specifying the object type, pipeline ID, and stage ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type | string | Required | Specify the type of CRM object (e.g., deals, tickets) for which the pipeline stage is being deleted. |
pipeline_id | string | Required | The unique ID of the pipeline containing the stage to be deleted. |
stage_identifier | string | Required | The unique identifier of the pipeline stage to be deleted. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}_archive'.HubspotCrmApi.DeletePropertyGroup
Delete a property group and move it to recycling bin. Use this tool to move a specified property group to the recycling bin in HubSpot CRM. Ideal when a property group is no longer needed and should be removed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
crm_object_type | string | Required | Specify the type of CRM object, such as 'contacts', 'companies', etc. |
property_group_name | string | Required | The name of the property group to delete. This identifies which group to move to the recycling bin in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/properties/{objectType}/groups/{groupName}'.HubspotCrmApi.DeletePropertyHubspotCrm
Delete a property in HubSpot CRM and move it to the recycling bin. Use this tool to delete a specific property from the HubSpot CRM by specifying the object type and property name. This action moves the property to the recycling bin.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type | string | Required | Specify the type of object in HubSpot CRM (e.g., 'contacts', 'companies'). |
property_name | string | Required | The name of the property to delete, identified by its unique name within the object type. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/properties/{objectType}/{propertyName}'.HubspotCrmApi.DeleteScheduledConversion
Delete a scheduled conversion for a specific list. This tool deletes an existing scheduled conversion for a specified list in the HubSpot CRM. It should be called when you need to cancel a conversion schedule, and it returns a confirmation of the deletion.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The ID of the list for which you want to cancel the scheduled conversion. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/lists/{listId}/schedule-conversion'.HubspotCrmApi.DeleteShoppingCart
Delete a shopping cart from HubSpot CRM. Use this tool to move a shopping cart, identified by its `cartId`, to the recycling bin in HubSpot CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cart_identifier | string | Required | The unique identifier of the shopping cart to delete from HubSpot CRM. It should be a string. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/carts/{cartId}'.HubspotCrmApi.DeleteSubscription
Delete a specific subscription from HubSpot CRM. This tool deletes a subscription identified by `subscriptionId` from HubSpot CRM, moving it to the recycling bin. Use this when you need to remove a subscription object from the system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
subscription_id | string | Required | The unique identifier of the subscription to be deleted. This moves the subscription to the recycling bin in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/subscriptions/{subscriptionId}'.HubspotCrmApi.DeleteTaskInHubspot
Delete a task in HubSpot by task ID. Use this tool to move a specific task in HubSpot CRM to the recycling bin by providing the task ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
task_id | string | Required | The unique identifier of the task to be deleted from HubSpot CRM. Required to move the task to the recycling bin. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/tasks/{taskId}_archive'.HubspotCrmApi.DeleteTaxEntry
Archive a tax entry in HubSpot CRM. Use this tool to move a tax object identified by `taxId` to the recycling bin in HubSpot CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tax_entry_id | string | Required | The unique identifier for the tax entry you want to archive in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/taxes/{taxId}_archive'.HubspotCrmApi.DeleteTicket
Move a ticket to the recycling bin by ticket ID. Use this tool to delete a CRM ticket by moving it to the recycling bin using its unique ticket ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ticket_id | string | Required | The unique ID of the ticket to move to the recycling bin. Must be a valid string representing the ticket identifier. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/tickets/{ticketId}_archive'.HubspotCrmApi.DeleteUser
Delete a user and move to recycling bin.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_id_to_delete | string | Required | The unique identifier of the user to delete and move to the recycling bin. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/users/{userId}'.HubspotCrmApi.EditHubspotObject
Partially update a HubSpot CRM object with specified properties. This tool performs a partial update on a HubSpot CRM object identified by the `serviceId` or a unique property value using the `idProperty` query parameter. It overwrites provided properties while ensuring read-only or non-existent properties result in errors. Properties can be cleared with an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
object_identifier | string | Optional | The unique identifier or `{serviceId}` for the object to be updated. This can be an internal object ID or a unique property value when used with `idProperty`. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of a unique property for the object, used instead of the internal ID if specified. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/0-162/{serviceId}'.HubspotCrmApi.EnableObjectTypeInHubspot
Enable an object type in HubSpot CRM via its ID. This tool is used to enable a specific object type in HubSpot's CRM system using the object's unique ID. It should be called when there is a need to activate or verify the activation status of a specific object category in HubSpot.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type_id | string | Required | The unique identifier for the object type in HubSpot CRM that needs to be enabled. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/object-library/enablement/{objectTypeId}'.HubspotCrmApi.FetchAssociationLimitObjects
Fetch objects approaching association limits for a specified type. Use this tool to retrieve objects where the specified 'from' object type has records that are nearing or have reached their association limits in HubSpot CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
from_object_type_id | string | Required | Identifier for the 'from' object type whose records' association limits are being queried. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/limits/associations/records/{fromObjectTypeId}/to'.HubspotCrmApi.FetchEnablementData
Fetch enablement data from HubSpot CRM. Use this tool to obtain enablement information from the HubSpot CRM. It should be called when detailed enablement data is required for CRM-related operations or analyses.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/object-library/enablement'.HubspotCrmApi.FetchHubspotListById
Fetch a single HubSpot CRM list using its ILS list ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The ILS ID of the HubSpot CRM list to fetch. |
include_filter_definitions | boolean | Optional | Include filter branch definitions in the response. Defaults to false, meaning filter definitions are not included. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/lists/{listId}_getById'.HubspotCrmApi.FetchHubspotListMemberships
Retrieve memberships of a HubSpot list by order of record ID. Use this tool to fetch the memberships of a specific list in HubSpot CRM, sorted by `recordId`. The results can be ordered in ascending or descending order based on the presence of an `after` or `before` offset.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_identifier | string | Required | The ILS ID of the HubSpot list to retrieve memberships for. |
before_offset_token | string | Optional | The paging offset token for the page before the previously requested records, used to sort records in descending order. |
number_of_records_to_return | integer | Optional | Defines how many records to retrieve in the response, with a maximum value of 250. |
paging_offset_after_token | string | Optional | The paging offset token for the page that comes after the previously requested records. If provided, records will follow this offset, sorted in ascending order. Takes precedence over the before offset. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/lists/{listId}/memberships_getPage'.HubspotCrmApi.FetchHubspotObjectById
Retrieve a HubSpot CRM object using its unique ID. Use this tool to fetch the details of a HubSpot CRM object by its unique ID. Specify the object type and optional parameters to control the returned data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_identifier | string | Required | The unique identifier of the HubSpot CRM object to retrieve. This can be the internal object ID or another unique property value if specified by the `id_property` parameter. |
object_type | string | Required | The type of the HubSpot CRM object you want to retrieve. Examples include 'contact', 'company', and 'deal'. |
associated_object_types | array<string> | Optional | Specify object types to retrieve associated IDs for, separated by commas. Non-existing associations will be ignored. |
properties_with_history | array<string> | Optional | A list of properties to return along with their historical values. Ignored if properties are not present. |
return_only_archived_results | boolean | Optional | Set to true to return only archived results. Set to false to include all results. |
return_properties | array<string> | Optional | List of properties to return for the object. Ignored if not present on the object. |
unique_property_name | string | Optional | Specify the property name that uniquely identifies the object. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/{objectType}/{objectId}_getById'.HubspotCrmApi.FetchHubspotObjectRecords
Retrieve HubSpot CRM records by ID or custom property. Use this tool to retrieve HubSpot CRM records by specifying record IDs or by using a custom unique value property with the `idProperty` parameter. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_only | boolean | Optional | Indicate if only archived records should be returned when retrieving HubSpot CRM data. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-162/batch/read'.HubspotCrmApi.FetchHubspotRecords
Retrieve HubSpot CRM records by ID or custom property. This tool retrieves records from HubSpot CRM using either a record ID or a custom unique value property. It should be called when you need to access specific CRM records based on these identifiers. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_records_only | boolean | Optional | Set to true to return only HubSpot CRM records that have been archived. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-420/batch/read'.HubspotCrmApi.FetchListByName
Fetch details of a list by its name and object type. Use this tool to obtain the information of a specific list in HubSpot CRM by providing the list name and object type ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_name | string | Required | The name of the list to fetch. This is not case sensitive. |
object_type_id | string | Required | The object type ID for the list. Example: `0-1` for `CONTACT`. |
include_filters | boolean | Optional | Set to true to include filter branch definitions in the response. By default, filters are not included. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/lists/object-type-id/{objectTypeId}/name/{listName}_getByName'.HubspotCrmApi.FetchListMembershipsOrdered
Fetch list memberships ordered by addition date. Fetch the memberships of a HubSpot CRM list, ordered by the date they were added. Useful for retrieving member records in an ascending order based on addition time, or in descending order if a 'before' offset is used.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The unique ILS ID of the list to retrieve memberships from. |
after_paging_offset_token | string | Optional | The token for the page that comes after the previously requested records, sorted in ascending order. Takes precedence over 'before'. |
before_offset_token | string | Optional | The paging offset token to retrieve records preceding the specified page, sorted in descending order. |
record_limit | integer | Optional | Specify the number of records to return, with a maximum limit of 250. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/lists/{listId}/memberships/join-order_getPageOrderedByAddedToListDate'.HubspotCrmApi.FetchPropertyValidation
Retrieve validation rules for a specific property in HubSpot CRM. This tool is used to read the validation rules of a property identified by {propertyName} within a specified object type in HubSpot CRM. It helps to understand the constraints and validations applied to a property.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type_id | string | Required | The unique identifier for the object type in HubSpot CRM, such as "contacts" or "deals". |
property_name | string | Required | The name of the property whose validation rules you want to retrieve in HubSpot CRM. It must match exactly to identify the property correctly. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/property-validations/{objectTypeId}/{propertyName}'.HubspotCrmApi.FetchTicketsPage
Retrieve a page of tickets from HubSpot CRM. Use this tool to read a page of tickets from HubSpot CRM. You can control the returned data using the `properties` query parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | A list of object types (e.g. 'contacts', 'companies') to retrieve associated IDs for tickets. Ignore if they don't exist. |
include_properties | array<string> | Optional | A list of properties to return for each ticket. Specify as strings; unlisted properties will be ignored. |
paging_cursor_token | string | Optional | The token for the last read resource to continue paging results. |
properties_with_history | array<string> | Optional | A list of property names to return with their historical values. Reduces the number of tickets retrievable per request. |
results_per_page | integer | Optional | The maximum number of results to display per page. Must be a positive integer. |
return_only_archived | boolean | Optional | Return only archived tickets if set to 'True'. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/tickets_getPage'.HubspotCrmApi.GdprDeleteContact
Permanently delete a contact for GDPR compliance. Use this tool to permanently delete a contact and all associated content to comply with GDPR. You can identify the contact by email address using the 'idProperty'. If the email isn't found, it will be added to a blocklist to avoid future use.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_identifier | string | Required | The unique ID or email used to identify the contact for deletion. Use 'email' in conjunction with 'id_property' if identifying by email. |
contact_identifier_property | string | Optional | Specify 'email' to identify the contact by email address. If not using email, specify another unique identifier property. |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/contacts/gdpr-delete'.HubspotCrmApi.GdprDeleteObject
Delete CRM objects in compliance with GDPR. This tool removes specified CRM objects in accordance with GDPR regulations. It's used when you need to ensure data is deleted to comply with GDPR requests.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_id | string | Required | The unique identifier for the CRM object to be deleted under GDPR compliance. |
object_type_for_gdpr_deletion | string | Required | Specify the type of CRM object to delete (e.g., contacts, companies) for GDPR compliance. |
unique_property_name | string | Optional | Specify a unique property name for the object to be deleted under GDPR. |
Requirements
Output
json— Response from the API endpoint 'post-/crm/objects/v3/{objectType}/gdpr-delete'.HubspotCrmApi.GetAllPipelines
Retrieve all pipelines for a specified object type. Use this tool to fetch all pipelines related to a specific object type in HubSpot CRM. This is useful for obtaining pipeline information for various CRM entities such as contacts, deals, etc.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type | string | Required | Specify the CRM object type (e.g., contacts, deals) to retrieve pipelines for. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/pipelines/{objectType}_getAll'.HubspotCrmApi.GetAppointmentsData
Retrieve a page of appointments from HubSpot CRM. Fetches appointment details using the specified properties to control the data returned. Useful for accessing and managing CRM appointment information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
appointment_object_type | string | Required | The type of HubSpot object to be queried, specifically for appointments. |
appointment_properties_to_return | array<string> | Optional | A list of property names to include in the response. Properties not present on the requested objects are ignored. |
only_archived_results | boolean | Optional | Set to true to return only results that have been archived. |
paging_cursor_token | string | Optional | Token indicating the last successfully read resource to continue pagination. |
properties_with_history | array<string> | Optional | List properties to return with their history of values. Reduces max results per request. |
results_limit | integer | Optional | Specify the maximum number of results to display per page. |
retrieve_associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for. If specified associations don't exist, they will be ignored. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/objects/v3/{objectType}'.HubspotCrmApi.GetAssociationLimitRecords
Fetch records near association limits between two objects. Use this tool to retrieve records that are close to or have reached the association limits between specified objects in HubSpot CRM. This is useful for monitoring and managing object relationships within the CRM system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
source_object_type_id | string | Required | Specifies the ID of the source object type to check association limits from. |
to_object_type_id | string | Required | The ID of the target object type for the association limit query. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/limits/associations/records/{fromObjectTypeId}/{toObjectTypeId}'.HubspotCrmApi.GetAssociationsInHubspot
Retrieve associations between HubSpot CRM objects. This tool is used to get the associations between specified HubSpot CRM objects. Useful for identifying relationships between different objects in the CRM, such as contacts, deals, or companies.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
hubspot_object_id | string | Required | The unique identifier for the HubSpot CRM object whose associations are being requested. |
object_type | string | Required | Specifies the type of HubSpot CRM object (e.g., contact, deal, company) whose associations you want to retrieve. |
target_object_type | string | Required | The type of the target object to which the association is being found. Specify the object type like 'contact', 'deal', 'company', etc. |
include_full_associations | boolean | Optional | Set to true to include full associations in the response, otherwise only basic associations will be returned. |
max_results | integer | Optional | Specifies the maximum number of associations to return. Provide an integer value to limit the results. |
paging_offset_after | string | Optional | A string used for pagination to get the next set of results after the specified cursor. Leave empty or omit for the first set of results. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/objects/v3/{objectType}/{objectId}/associations/{toObjectType}'.HubspotCrmApi.GetAssociationTypes
Get association types between two object types in HubSpot CRM. Use this tool to retrieve all association types between specified object types in HubSpot CRM. This is useful when needing to understand the relationships between different entities in the CRM system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
source_object_type | string | Required | Specifies the source object type in HubSpot CRM from which associations are retrieved (e.g., 'contact', 'deal'). |
target_object_type | string | Required | Specify the type of the destination object to retrieve association types for. These are the related entities in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/associations/{fromObjectType}/{toObjectType}/types_getAll'.HubspotCrmApi.GetCalculatedPropertiesLimits
Get limits and usage for calculated properties in HubSpot CRM. Call this tool to retrieve overall limits and per object usage for calculated properties in HubSpot CRM.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/limits/calculated-properties'.HubspotCrmApi.GetCallDetails
Retrieve details of a call using its ID in HubSpot CRM. This tool fetches the details of a call object in HubSpot CRM using the call ID. It allows optional control over which properties of the call are returned. Use this tool to retrieve specific information on call objects by their unique identification.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
call_identifier | string | Required | The unique identifier for the call. This can be an internal object ID or a unique property value as specified. |
associated_object_types | array<string> | Optional | Specify object types to retrieve associated IDs for. Use comma-separated values. |
only_archived_results | boolean | Optional | Specify `True` to return only archived results, otherwise `False`. |
properties_with_history | array<string> | Optional | Comma-separated list of properties to return with history. Ignores non-existent properties. |
return_properties | array<string> | Optional | Comma-separated list of properties to return in the response. Ignored if not present on requested object. |
unique_property_name | string | Optional | Unique property name used to identify the call object in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/calls/{callId}_getById'.HubspotCrmApi.GetCallsPage
Retrieve a page of call records from HubSpot CRM. This tool is used to retrieve a page of call records from the HubSpot CRM. The response can be customized by specifying the desired call properties through the `properties` query parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | Specify object types to retrieve associated IDs for. Comma-separated list. Non-existing associations are ignored. |
call_properties | array<string> | Optional | A list of properties to include in the response, such as call date, duration, etc. |
paging_cursor_token | string | Optional | The paging cursor token from the last successfully read resource for retrieving the next page of results. |
properties_with_history | array<string> | Optional | A list of properties to return with historical values. Note: Reduces max calls per request. |
results_per_page | integer | Optional | The maximum number of call records to display per page. |
return_only_archived_results | boolean | Optional | Set to true to return only archived call records. False will include non-archived records. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/calls_getPage'.HubspotCrmApi.GetCartDetails
Retrieve detailed information of a cart by ID. Use this tool to get detailed information about a specific cart in the HubSpot CRM by providing the cart ID. It allows for optional specification of unique property values and controlled return data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
cart_identifier | string | Required | The unique identifier for the cart. This can be the internal ID or a unique property value specified by the `idProperty` parameter. |
associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for, such as 'deals' or 'contacts'. |
only_return_archived_results | boolean | Optional | Set to `true` to return only archived results; `false` includes all. |
properties_with_history | array<string> | Optional | Specify properties to retrieve alongside their history of previous values, separated by commas. |
return_properties | array<string> | Optional | List of specific properties to retrieve for the cart. Ignored if properties don't exist. |
unique_property_name | string | Optional | Specify a property name with unique values for the cart object, if not using the default internal ID. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/carts/{cartId}'.HubspotCrmApi.GetCommercePayments
Retrieve a page of commerce payments from HubSpot CRM. This tool allows you to retrieve a page of commerce payments from HubSpot CRM, with customizable properties.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associations_to_retrieve | array<string> | Optional | List of object types to retrieve associated IDs for. Non-existing associations are ignored. |
paging_cursor_token | string | Optional | The paging cursor token from the last successfully read resource. Used for paginating through results. |
properties_with_history | array<string> | Optional | A list of properties to be returned with their historical values. Reduces the maximum payments per request. |
results_per_page | integer | Optional | Specify the maximum number of results to display per page. |
returned_properties | array<string> | Optional | List the properties to return in the response. Non-present properties are ignored. |
show_only_archived | boolean | Optional | Set to true to return only archived results. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/commerce_payments'.HubspotCrmApi.GetCommunicationById
Retrieve details of a communication by its ID. Use this tool to obtain the details of a communication object by specifying its unique ID. The ID can be the internal object ID or any unique property value. You can control the returned data using query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
communication_identifier | string | Required | Specify the unique ID or property value for the communication object to retrieve. |
properties_to_return | array<string> | Optional | Comma-separated list of properties to include in the response. Missing properties are ignored. |
properties_with_history | array<string> | Optional | List the properties whose history of values should be returned. Comma-separated values are expected. |
retrieve_associated_object_types | array<string> | Optional | A list of object types for retrieving associated IDs. Non-existing associations will be ignored. |
return_only_archived | boolean | Optional | Set to true to return only results that have been archived. Defaults to false to include non-archived results. |
unique_property_name | string | Optional | The property name used to uniquely identify the communication object. Allows retrieval by non-default identifiers. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/communications/{communicationId}_getById'.HubspotCrmApi.GetContactDetails
Retrieve detailed information about a specific contact. This tool fetches detailed information about a contact from HubSpot CRM, identified by `contactId`. It provides an option to specify which properties to return using query parameters. Use this tool when you need to access in-depth details about a contact, such as their internal object ID or any unique property value.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_identifier | string | Required | The ID or unique property value used to identify the contact in HubSpot CRM. |
associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for. Ignored if associations do not exist. |
properties_with_history | array<string> | Optional | A list of properties to return with their history of previous values. Ignored if properties are not present. |
return_only_archived_results | boolean | Optional | Set to true to return only results that have been archived. |
return_properties | array<string> | Optional | List of properties to include in the response for the contact. If absent on the object, they will be ignored. |
unique_property_name | string | Optional | The property name with unique values for the contact type, used to identify the object. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/contacts/{contactId}'.HubspotCrmApi.GetContacts
Retrieve a page of contacts from HubSpot CRM. This tool retrieves a page of contacts from the HubSpot CRM. You can specify which properties you want to be returned by controlling the `properties` query parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_properties_to_retrieve | array<string> | Optional | A list of properties to include in the response. Non-existent properties will be ignored. |
max_results_per_page | integer | Optional | The maximum number of contact results to return per page. |
paging_cursor_token | string | Optional | The token indicating the last read resource, used for pagination to retrieve more results. |
properties_with_history | array<string> | Optional | Specify properties to return with their history of previous values, reducing the max number of objects per request. |
retrieve_associated_ids | array<string> | Optional | A list of object types to retrieve associated IDs for. If associations do not exist, they will be ignored. |
return_only_archived_results | boolean | Optional | Whether to return only results that have been archived. Use 'true' for archived only. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/contacts'.HubspotCrmApi.GetCourseDetails
Fetch details of a course using the course ID. Use this tool to retrieve detailed information about a course identified by its ID. The tool provides access to all course-related data, leveraging the course ID or any unique property value specified.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
course_id | string | Required | The unique identifier for the course. Use this to specify which course details to retrieve. |
include_properties | array<string> | Optional | A list of property names to include in the response. Any missing properties will be ignored. |
include_properties_with_history | array<string> | Optional | Specify properties to retrieve with their history of changes. Input as a list, each entry being a property name. |
retrieve_associated_object_types | array<string> | Optional | A list of object types for retrieving associated IDs. Non-existent associations will be ignored. |
return_only_archived | boolean | Optional | Set to true to return only results that have been archived. |
unique_property_name | string | Optional | Specify the name of a unique property for the course object. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/0-410/{courseId}'.HubspotCrmApi.GetCourses
Fetch a page of courses from HubSpot CRM. Use this tool to read and retrieve information about a page of courses from HubSpot CRM. The response can be tailored using the `properties` query parameter to control what specific data is returned.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | Comma-separated list of object types to retrieve associated IDs for; ignored if non-existent. |
maximum_results_per_page | integer | Optional | Specify the maximum number of courses to display in a single page of results. |
paging_cursor_token | string | Optional | The paging cursor token of the last successfully read resource, used to fetch the next page of results. |
properties_to_return | array<string> | Optional | Comma separated list of properties to include in the response. Ignored if not present on requested objects. |
properties_with_history | array<string> | Optional | List of properties to return with their history. This can reduce the number of courses per request. |
return_only_archived_results | boolean | Optional | Set to true to return only archived results. False includes non-archived results. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/0-410'.HubspotCrmApi.GetCrmFees
Fetch a list of fees from the CRM. Retrieve a page of fee objects from the CRM, allowing control over returned properties through query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | Comma-separated list of object types to retrieve associated IDs for. Ignored if associations don't exist. |
fee_properties_to_return | array<string> | Optional | List of properties to be returned in the response. If a property is not present, it will be ignored. |
maximum_results_per_page | integer | Optional | The maximum number of fees to display per page. |
paging_cursor_token | string | Optional | The token used to retrieve the next page of results. Use the token returned in `paging.next.after` from a previous response. |
properties_with_history | array<string> | Optional | List of properties to return with their history. Reduces max number of fees per request. |
return_archived_only | boolean | Optional | Set to true to return only results that have been archived. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/fees'.HubspotCrmApi.GetCrmObjectSchema
Retrieve a CRM object schema by its type. Use this tool to get detailed information about a specific CRM object schema by providing the object type. This helps in understanding the structure and properties of the CRM object within HubSpot.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type | string | Required | The fully qualified name or object type ID of the CRM schema to retrieve. |
Requirements
Output
json— Response from the API endpoint 'get-/crm-object-schemas/v3/schemas/{objectType}_getById'.HubspotCrmApi.GetCustomAssociationLabelsLimits
Get limits and usage for custom association labels in HubSpot CRM. This tool retrieves limits and current usage information for custom association labels within the HubSpot CRM environment. It should be called when you need to understand the constraints or current utilization of these labels.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
source_object_type_id | string | Optional | The unique identifier for the source object type. It specifies which object type the association is coming from in the CRM. |
target_object_type_id | string | Optional | The ID of the target object type to which the association label applies. Specify the target entity in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/limits/associations/labels'.HubspotCrmApi.GetCustomObjectLimits
Retrieve limits and usage for HubSpot custom object schemas. This tool is used to get the limits and usage data for custom object schemas in HubSpot CRM. It's useful for monitoring and managing custom object types and understanding their current usage.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/limits/custom-object-types'.HubspotCrmApi.GetCustomPropertyLimits
Retrieve limits and usage for custom properties per object. Use this tool to access the limits and usage statistics for custom properties categorized by object in HubSpot CRM.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/limits/custom-properties'.HubspotCrmApi.GetDealsPage
Read a page of deals from the CRM system. Use this tool to retrieve a page of deals from HubSpot CRM. You can control the information returned by specifying desired properties through query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | List of object types to retrieve associated IDs for, separated by commas. If associations don't exist, they're ignored. |
deal_properties | array<string> | Optional | List the properties to include in the response as a comma-separated string. Ignored if not present. |
paging_cursor_token | string | Optional | The token for the paging cursor to retrieve the next page of results. |
properties_with_history | array<string> | Optional | A list of deal properties for which historical values are returned. Usage reduces max results per request. |
results_limit_per_page | integer | Optional | The maximum number of deals to display per page, as an integer. |
return_archived_only | boolean | Optional | Set to true to return only archived results; false to include active results. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/0-3_getPage'.HubspotCrmApi.GetFeedbackSubmissionById
Retrieve feedback submission details by ID. Use this tool to obtain details of a feedback submission using its ID. You can specify additional properties to control the details returned.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
feedback_submission_id | string | Required | The ID of the feedback submission to retrieve details for. This can be the internal object ID or a unique property value specified by `idProperty`. |
associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for. If nonexistent, they will be ignored. |
properties_with_history | array<string> | Optional | Comma-separated list of properties to return with their history of previous values. Ignored if not present on the object. |
return_archived_only | boolean | Optional | Set to true to return only archived results, false for active ones. |
return_properties | array<string> | Optional | List of properties to return in the response. Non-existent properties will be ignored. |
unique_property_name | string | Optional | The name of a property whose values are unique for the feedback submission object. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/feedback_submissions/{feedbackSubmissionId}_getById'.HubspotCrmApi.GetFeedbackSubmissions
Retrieve a page of feedback submissions from the CRM. This tool retrieves a page of feedback submissions from HubSpot CRM. It allows control over the returned data using the 'properties' query parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | Comma separated list of object types to retrieve associated IDs for, like 'contacts' or 'companies'. Ignored if nonexistent. |
max_results_per_page | integer | Optional | Specify the maximum number of results to display per page. |
paging_cursor_token | string | Optional | The token of the last read resource for fetching the next page of results. |
properties_to_return | array<string> | Optional | List of properties to return for each feedback submission. Comma separated. Ignores non-existing properties. |
properties_with_history | array<string> | Optional | A list of property names whose history of values should be returned. Properties not present will be ignored. Reduces the maximum number of submissions per request. |
return_only_archived_results | boolean | Optional | Set to true to return only archived feedback submissions; false to include both archived and active submissions. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/feedback_submissions_getPage'.HubspotCrmApi.GetFeeDetails
Retrieve information about a specific fee by ID. This tool is used to get detailed information about a fee object in HubSpot CRM using the fee's unique identifier. It can control the returned data with optional query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
fee_identifier | string | Required | The unique identifier for the fee object to retrieve. It can be the internal object ID or a value from a unique property specified by the `idProperty` parameter. |
associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for. Non-existent associations will be ignored. |
only_return_archived_results | boolean | Optional | Set to true to retrieve only archived results. False for non-archived. |
properties_with_history | array<string> | Optional | List of properties to return with their history of previous values, specified as strings. Non-existent properties will be ignored. |
return_properties | array<string> | Optional | A list of properties to return for the fee object. Any non-existent properties will be ignored. |
unique_property_name | string | Optional | Specify the property name with unique values for the fee object. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/fees/{feeId}'.HubspotCrmApi.GetGoalTargetById
Retrieve goal target object details using its ID. This tool retrieves details of a goal target object identified by `goalTargetId`. It can use either the default internal object ID or any unique property value specified by the `idProperty` query parameter. The `properties` query parameter can control what information is returned.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
goal_target_id | string | Required | The unique identifier for the goal target object. Can be the internal object ID or a unique property value specified by `idProperty`. |
archived_results | boolean | Optional | Set to true to return only archived results. Default is false. |
associated_object_types | array<string> | Optional | Specify object types to retrieve associated IDs. If not present, they will be ignored. Use commas to separate multiple types. |
properties_with_history | array<string> | Optional | Comma-separated properties to return with their value histories. Ignored if properties are absent on the object. |
returned_properties | array<string> | Optional | List of properties to return. Ignored if not present on the object. |
unique_property_name | string | Optional | The property name used as a unique identifier for the goal target object. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/goal_targets/{goalTargetId}_getById'.HubspotCrmApi.GetGoalTargets
Retrieve a page of goal targets from HubSpot CRM. Use this tool to access a specific page of goal targets within HubSpot CRM. You can control the data returned by specifying the `properties` query parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | List of object types to retrieve associated IDs for, ignored if non-existent. |
paging_cursor_token | string | Optional | Token of the last successfully read item. Use it for fetching the next page of results. |
properties_with_history | array<string> | Optional | Comma-separated properties to return with their history of previous values. Reduces the max number of goals retrievable in one request. |
results_per_page_limit | integer | Optional | Specify the maximum number of results to display per page. |
return_only_archived | boolean | Optional | Set to true to return only results that have been archived. |
returned_properties | array<string> | Optional | Comma-separated list of properties to return in the response. Ignored if absent on requested objects. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/goal_targets_getPage'.HubspotCrmApi.GetHubspotCrmLimitsRecords
Retrieve limits and usage for records in HubSpot CRM. Use this tool to obtain detailed information about the limits and current usage of various objects within the HubSpot CRM records.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/limits/records'.HubspotCrmApi.GetHubspotCrmObjectSchemas
Retrieve HubSpot CRM object schemas. Call this tool to fetch all object schemas from the HubSpot CRM, which can help understand data structure within the CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
return_archived_only | boolean | Optional | Set to True to return only results that have been archived. |
Requirements
Output
json— Response from the API endpoint 'get-/crm-object-schemas/v3/schemas_getAll'.HubspotCrmApi.GetHubspotDealById
Retrieve HubSpot CRM deal information by Deal ID. Use this tool to fetch detailed information about a specific deal in HubSpot CRM using the deal's unique ID. The response includes properties specified by the user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
deal_id | string | Required | The unique identifier of the deal to retrieve from HubSpot CRM. |
associated_object_types | array<string> | Optional | List of object types to retrieve associated IDs for. Ignored if associations do not exist. |
properties_with_history | array<string> | Optional | Specify properties to return with their history of values. Use a comma-separated list. |
return_archived_only | boolean | Optional | Set to true to return only results that have been archived. |
return_properties | array<string> | Optional | List of properties to be returned in the response. Ignored if not present on the object. |
unique_property_name | string | Optional | Specify the unique property name used to identify the deal. It defaults to an internal object ID if not provided. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/0-3/{dealId}_getById'.HubspotCrmApi.GetHubspotDiscounts
Retrieve a page of discounts from HubSpot CRM. Use this tool to read a page of discounts from HubSpot CRM. You can control the returned data using the `properties` query parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for. Unknown associations will be ignored. |
maximum_results_per_page | integer | Optional | The maximum number of results to display per page. |
paging_cursor_token | string | Optional | The cursor token for pagination. Use the token from the last successfully read resource to fetch the next page. |
properties_with_history | array<string> | Optional | List of properties to return with their history; reduces number of discounts returned per request. |
return_only_archived | boolean | Optional | Set to true to return only archived discounts, false to include all. |
returned_discount_properties | array<string> | Optional | List of properties to include in the response. Comma-separated, ignored if not present. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/discounts'.HubspotCrmApi.GetHubspotLeadsPage
Retrieve a page of leads from HubSpot CRM. This tool fetches a page of leads from the HubSpot CRM. It allows you to control the properties returned for the leads through query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
archived_leads_only | boolean | Optional | Return only leads that have been archived. Set to true to include only archived leads, false to exclude them. |
associated_object_types | array<string> | Optional | Comma-separated list of object types to retrieve associated IDs for; ignored if non-existent. |
lead_properties_to_return | array<string> | Optional | An array of the property names to include in the lead details response. Unavailable properties will be ignored. |
paging_cursor_token | string | Optional | The cursor token to continue retrieving leads from where the last page ended. |
properties_with_history | array<string> | Optional | List of properties whose historical values will be returned. Reduce max leads per request. |
results_limit_per_page | integer | Optional | Defines the maximum number of leads to display per page. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/leads_getPage'.HubspotCrmApi.GetHubspotObjectById
Retrieve a HubSpot CRM object using its service ID. This tool is used to read a specific HubSpot CRM object identified by its `serviceId`. It can optionally use any unique property value by specifying the `idProperty`. The returned data can be customized with the `properties` query parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
hubspot_crm_service_id | string | Required | The unique identifier (service ID) of the HubSpot CRM object to retrieve. This can be the internal object ID or any unique property defined by the `idProperty`. |
associated_object_types | array<string> | Optional | A list of object types whose associated IDs should be retrieved. Non-existent associations will be ignored. |
properties_with_history | array<string> | Optional | A list of properties to return along with their history for a HubSpot CRM object. Properties should be specified as strings in the list. |
return_archived_only | boolean | Optional | Set to true to return only archived results. False returns non-archived results. |
return_properties_list | array<string> | Optional | A list of properties to be returned in the response. Non-existing properties will be ignored. |
unique_property_name | string | Optional | Specify the name of a property with unique values for the object. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/0-162/{serviceId}'.HubspotCrmApi.GetHubspotObjectsPage
Retrieve a page of HubSpot CRM objects. Use this tool to read a page of objects from HubSpot CRM. Specify the desired properties through the `properties` query parameter to control the returned data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type | string | Required | Specify the type of CRM object to retrieve, such as 'contacts', 'companies', or 'deals'. |
associated_object_types | array<string> | Optional | Comma-separated object types to retrieve associated IDs for. Ignored if associations do not exist. |
max_results_per_page | integer | Optional | Specify the maximum number of results to display per page. |
paging_cursor_token | string | Optional | The token used to retrieve the next page of results. Obtained from the `paging.next.after` property of a previous response. |
properties_with_history | array<string> | Optional | List the properties to return with their historical values in the CRM objects. |
requested_properties | array<string> | Optional | List of properties to include in the response. Ignored if not present on the object(s). |
return_archived_results_only | boolean | Optional | Return only the archived results if set to true. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/{objectType}_getPage'.HubspotCrmApi.GetInvoiceById
Retrieve invoice details by ID. Fetch invoice information using the unique identifier, `{invoiceId}`. This can include internal object ID or any unique property value specified by the `idProperty` parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
invoice_identifier | string | Required | The unique identifier for the invoice. This can be the internal object ID or any unique property value as specified by the `id_property`. |
associated_object_types | array<string> | Optional | List of object types to retrieve associated IDs for, separated by commas. Ignored if associations don't exist. |
historical_properties | array<string> | Optional | Comma-separated list of properties to return along with their history of previous values. |
requested_properties | array<string> | Optional | List of properties to be returned in the response for the specified invoice. Properties not present on the object will be ignored. |
return_archived_only | boolean | Optional | Specify `True` to return only archived results. `False` returns both archived and non-archived results. |
unique_identifier_property | string | Optional | The name of a property whose values uniquely identify the invoice object. Specify this to use a unique property other than the internal object ID. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/invoices/{invoiceId}_getById'.HubspotCrmApi.GetLeadById
Retrieve a lead by its unique identifier. This tool retrieves detailed information about a lead from HubSpot CRM using a unique identifier. It allows filtering of returned data using optional query parameters such as `idProperty` for specifying unique properties and `properties` for controlling which data is returned.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
lead_identifier | string | Required | The unique identifier for the lead. Typically the internal ID, or a unique property value if specified by `idProperty`. |
associated_object_types | array<string> | Optional | Comma-separated list of object types to retrieve associated IDs for, with non-existent associations ignored. |
only_archived_results | boolean | Optional | Set to true to return only archived results. |
return_properties_with_history | array<string> | Optional | A list of properties to return with their history of previous values. Comma-separated values should be used. Ignored if properties are not present. |
returned_properties | array<string> | Optional | A list of properties to be returned in the response. Only specified properties present on the lead will be included. |
unique_property_name | string | Optional | Specifies a unique property name to identify the lead. Overrides default ID. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/leads/{leadsId}_getById'.HubspotCrmApi.GetLineItemDetails
Retrieve details of a line item by its ID. This tool fetches details of a specific line item from HubSpot CRM using its internal ID or any unique property value. Use this tool to access information about a particular line item, specifying any desired properties to control the response.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
line_item_id | string | Required | The unique ID or property value of the line item to retrieve. This identifies the specific line item in HubSpot CRM. |
associated_object_types | array<string> | Optional | Comma separated list of object types to retrieve associated IDs for. Non-existent associations are ignored. |
only_return_archived | boolean | Optional | Set to True to return only archived results. |
properties_with_history | array<string> | Optional | A list of properties to return with their value history. Ignored if not present on the object. |
return_properties | array<string> | Optional | Comma-separated list of properties to return. Ignored if not present on the object. |
unique_identifier_property | string | Optional | Specifies a unique property name to identify the line item in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/line_items/{lineItemId}_getById'.HubspotCrmApi.GetListingDetails
Retrieve details of a listing by its ID. Retrieve information about a listing in HubSpot CRM using a unique listing ID or any specified unique property. Allows control of returned details via query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
unique_listing_id | string | Required | The unique identifier for the listing to be retrieved in HubSpot CRM. |
properties_to_return | array<string> | Optional | A list of properties to be included in the response. Non-existent properties will be ignored. |
properties_with_history | array<string> | Optional | An array of property names to return along with their historical values. |
retrieve_associated_object_types | array<string> | Optional | List of object types to retrieve associated IDs for. Comma separated. Non-existent associations will be ignored. |
return_only_archived_results | boolean | Optional | Set to true to return only archived results. Use false to include non-archived as well. |
unique_property_name | string | Optional | The name of a property with unique values to identify the object in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/0-420/{listingId}'.HubspotCrmApi.GetMeetingDetailsById
Retrieve detailed information about a specific meeting. Use this tool to get information about a meeting using its unique ID. You can specify properties to control what details are returned.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
meeting_identifier | string | Required | Unique identifier for the meeting you want to retrieve details for. |
only_archived | boolean | Optional | Set to true to return only archived meeting results. |
properties_with_history | array<string> | Optional | Comma separated list of properties to return with history of values. Ignored if not present on the object. |
retrieve_associated_object_ids | array<string> | Optional | List of object types to fetch associated IDs for. Nonexistent associations will be ignored. |
return_properties | array<string> | Optional | A list of properties to be returned in the response. If any specified properties are not present, they will be ignored. |
unique_property_name | string | Optional | The property name whose values uniquely identify the meeting object. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/meetings/{meetingId}_getById'.HubspotCrmApi.GetMeetingsPage
Retrieve a page of meetings data from HubSpot CRM. Use this tool to read a page of meetings from HubSpot CRM. You can specify which properties to return using query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
maximum_results_per_page | integer | Optional | The maximum number of meeting results to display per page. Specify an integer value. |
paging_cursor_token | string | Optional | The token indicating the last successfully read resource, used for paging through results. |
properties | array<string> | Optional | A list of property names to return in the response. If any are not present, they will be ignored. |
properties_with_history | array<string> | Optional | List of properties to retrieve with their change history. Reduces max meetings returned per request. |
retrieve_associated_object_ids | array<string> | Optional | List object types to retrieve associated IDs for; ignored if associations don't exist. |
return_archived_results | boolean | Optional | Set to true to return only archived results; false to include active results. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/meetings_getPage'.HubspotCrmApi.GetMultiplePostalMailObjects
Retrieve multiple postal mail objects by IDs or unique values. This tool retrieves multiple postal mail objects from HubSpot CRM using their internal IDs or unique property values. It is useful when you need to access detailed information on several postal mail entries at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
include_archived | boolean | Optional | Set to true to include archived postal mail objects in the results. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/postal_mail/batch/read_read'.HubspotCrmApi.GetNoteDetails
Retrieve details of a note by its unique ID. Use this tool to get details of a note from HubSpot CRM using its unique ID. You can specify additional properties to control the returned data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
note_id | string | Required | The unique identifier of the note to retrieve details for. |
associated_object_types | array<string> | Optional | List the object types to retrieve associated IDs for, separated by commas. Invalid types are ignored. |
properties_to_return | array<string> | Optional | A list of property names to return for the note. Non-existing properties will be ignored. |
return_archived_results_only | boolean | Optional | Set to true to return only archived notes. |
return_properties_with_history | array<string> | Optional | List properties to return with their history of previous values. Ignored if not present on the object. |
unique_property_name | string | Optional | Specify the unique property name to identify the object in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/notes/{noteId}_getById'.HubspotCrmApi.GetOrderDetails
Retrieve details of an order using its ID. Call this tool to get detailed information about a specific order from the HubSpot CRM by using the order's ID. You can control which properties of the order are returned by specifying them in the `properties` query parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
order_identifier | string | Required | The unique identifier for the order. This can be the internal object ID or a unique property value specified by the idProperty. |
associated_object_types | array<string> | Optional | Comma separated list of object types to retrieve associated IDs. Non-existent associations are ignored. |
properties_with_history | array<string> | Optional | A list of properties to return with their history of previous values. If specified properties are not present, they will be ignored. |
return_only_archived_results | boolean | Optional | Set to true to return only archived results for the specified order. |
return_properties | array<string> | Optional | List the properties to retrieve for the order. Any nonexistent properties will be ignored. |
unique_property_name | string | Optional | Specify the name of a unique property to identify the order. Overrides the default ID. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/orders/{orderId}'.HubspotCrmApi.GetOrdersPage
Retrieve a page of orders from CRM. This tool fetches a page of orders from the CRM. You can specify which properties to include in the results using the query parameters. Use this tool to list orders when needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for; ignored if not existing. |
only_return_archived_orders | boolean | Optional | Set to true to return only archived orders. False returns both archived and unarchived orders. |
order_properties_to_return | array<string> | Optional | A list of properties to be included in the order response. Specify as a comma-separated string. Ignored if not present on the objects. |
paging_cursor_token | string | Optional | Token for pagination, representing the last successfully read resource for fetching the next page of results. |
properties_with_history | array<string> | Optional | A list of order properties to return with their history of previous values. Reduces maximum results per request. |
results_per_page | integer | Optional | The maximum number of orders to display per page. This controls the pagination size. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/orders'.HubspotCrmApi.GetPartnerClientInfo
Retrieve information for a specific partner client. Call this tool to obtain details about a specific partner client using their unique identifier within the HubSpot CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
partner_client_id | string | Required | The unique identifier for the partner client to retrieve details from HubSpot CRM. |
associated_objects | array<string> | Optional | A list of associated object types to include, such as 'contacts' or 'deals'. |
include_archived_data | boolean | Optional | Boolean to specify if archived partner client data should be included in the response. Set to true to include archived data. |
optional_properties | array<string> | Optional | An array of specific properties to retrieve for the partner client. Leave empty to obtain all available properties. |
properties_with_history | array<string> | Optional | Specify the list of properties to retrieve, including their historical values. |
property_id | string | Optional | Specify which property should be used as the primary identifier for the partner client. Useful for custom identification schemes. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/partner_clients/{partnerClientId}'.HubspotCrmApi.GetPartnerClients
Retrieve partner clients from HubSpot CRM. This tool retrieves a list of partner clients from the HubSpot CRM. It should be called when users need to access details about their partner clients stored in HubSpot's CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
client_properties | array<string> | Optional | A list of specific client properties to retrieve, such as 'name', 'email', etc. |
include_archived | boolean | Optional | Set to true to include archived partner clients, false to exclude them. |
include_associations | array<string> | Optional | List of associations to include in the response. Specify names of associations as strings. |
pagination_cursor | string | Optional | A string token to retrieve the next page of partner clients, obtained from a previous response. |
properties_with_history | array<string> | Optional | List property names to retrieve along with their historical versions. Each property should be specified as a string. |
retrieval_limit | integer | Optional | Specifies the maximum number of partner clients to retrieve from the HubSpot CRM in a single call. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/partner_clients'.HubspotCrmApi.GetPartnerServiceDetails
Retrieve details of a partner service by ID. Use this tool to get information about a specific partner service object using its ID. You can specify which properties to return or use the default settings to retrieve comprehensive details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
partner_service_id | string | Required | The unique ID of the partner service object to retrieve. This can be the internal object ID or a unique property value as specified by the `idProperty`. |
properties_to_return | array<string> | Optional | A list of property names to return for the partner service. Any missing properties will be ignored. |
properties_with_history | array<string> | Optional | List of properties whose historical values should be returned for the partner service object. |
retrieve_associated_ids | array<string> | Optional | Comma-separated list of object types to retrieve associated IDs. Non-existent associations are ignored. |
return_only_archived_results | boolean | Optional | Set to true to return only archived results, false otherwise. |
unique_property_name | string | Optional | The name of a unique property to identify the object. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/partner_services/{partnerServiceId}'.HubspotCrmApi.GetPartnerServices
Retrieve a page of partner services. Fetch a list of partner services from the HubSpot CRM. The returned data can be customized using the `properties` query parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for. Ignored if associations do not exist. |
maximum_results_per_page | integer | Optional | The maximum number of results to display per page. Must be an integer value. |
paging_cursor_after | string | Optional | The cursor token to retrieve the next page of results in a paged response. |
properties_with_history | array<string> | Optional | List of property names to fetch with their history. Reduces max number of results per request. |
return_only_archived | boolean | Optional | Set to true to return only results that have been archived. |
return_properties | array<string> | Optional | List of properties to return in the response. Ignored if not present on requested objects. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/partner_services'.HubspotCrmApi.GetPaymentDetails
Retrieve details of a payment object by ID. Use this tool to obtain information about a specific payment object in the CRM by providing its ID. The ID can be the internal object ID or another unique property value. You can control the properties returned using the `properties` query parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
payment_identifier | string | Required | The unique identifier for the payment object. This can be the internal object ID or a unique property value. |
properties_with_history | array<string> | Optional | List of properties to return with their historical values. Unavailable properties will be ignored. |
requested_properties | array<string> | Optional | A list of properties to return in the response. Non-existent properties will be ignored. |
retrieve_associated_object_ids | array<string> | Optional | A list of object types to retrieve associated IDs for this payment. Non-existent associations are ignored. |
return_only_archived_results | boolean | Optional | Set to true to return only archived results in the response. |
unique_property_name | string | Optional | The name of a property uniquely identifying the payment object type. Used to specify a unique property other than the internal ID. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/payments/{paymentsId}'.HubspotCrmApi.GetPaymentRecords
Retrieve a page of payment records from HubSpot CRM. Use this tool to get a list of payment records from the HubSpot CRM. You can specify which properties to include in the results by using query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
archived_results_only | boolean | Optional | Indicate if only archived payment records should be returned. Set to true to filter for archived records only. |
associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for. If specified associations do not exist, they will be ignored. |
paging_token_after | string | Optional | The cursor token from the last read resource to fetch the next page of results. |
payment_properties_to_include | array<string> | Optional | A list of property names to include in the response. Specified properties not present on the requested objects will be ignored. |
properties_with_history | array<string> | Optional | A list of property names to return with their historical values. Ignored if not present on objects. |
results_per_page_limit | integer | Optional | Maximum number of payment records to display per page. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/payments'.HubspotCrmApi.GetPipelineAuditLog
Retrieves the audit log for a specified CRM pipeline. Call this tool to obtain a list of all changes made to a specified pipeline in HubSpot CRM, in reverse chronological order.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type | string | Required | The type of CRM object for which audit logs are being retrieved, such as 'deals' or 'contacts'. |
pipeline_id | string | Required | The unique identifier for the pipeline to fetch the audit log from. This ID is used to target a specific pipeline within HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/pipelines/{objectType}/{pipelineId}/audit_getAudit'.HubspotCrmApi.GetPipelineById
Retrieve a single CRM pipeline by its unique ID. Use this tool to get detailed information about a specific pipeline in the HubSpot CRM by providing its unique identifier and object type.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type_in_crm | string | Required | Specify the type of CRM object, such as 'deals' or 'tickets', whose pipeline you want to retrieve. |
pipeline_unique_id | string | Required | The unique identifier for the CRM pipeline to retrieve details. This value is required to fetch the specific pipeline information. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/pipelines/{objectType}/{pipelineId}_getById'.HubspotCrmApi.GetPipelineStageAudit
Retrieve audit logs for a specific pipeline stage. This tool retrieves a reverse chronological list of all mutations that have occurred on a specified pipeline stage within HubSpot CRM. It should be called when you need to audit changes or track the history of a pipeline stage.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type | string | Required | The CRM object type to query for the pipeline stage, such as 'deals', 'tickets', or 'contacts'. |
pipeline_id | string | Required | The unique identifier for the pipeline to retrieve stage audit logs from. |
stage_identifier | string | Required | The unique identifier of the pipeline stage to audit. Use this to specify which stage's mutations you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}/audit_getAudit'.HubspotCrmApi.GetPipelineStageById
Retrieve a specific pipeline stage by its ID. Use this tool to get details of a particular stage within a pipeline in HubSpot CRM, identified by its unique stage ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type | string | Required | The type of CRM object, such as 'deals' or 'tickets', to access the pipeline stage for. |
pipeline_id | string | Required | The unique identifier for the pipeline in HubSpot CRM. Use this ID to specify which pipeline the stage belongs to. |
stage_id | string | Required | Unique ID of the pipeline stage to retrieve details from HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}_getById'.HubspotCrmApi.GetPipelineStages
Retrieve all stages of a specified pipeline. Use this tool to get all the stages associated with a specific pipeline in HubSpot CRM. It requires specifying the pipeline through its ID and object type.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type | string | Required | Specify the type of CRM object, such as deals or tickets, associated with the pipeline. |
pipeline_id | string | Required | The ID of the pipeline to retrieve stages for. Must be a valid pipeline ID in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/pipelines/{objectType}/{pipelineId}/stages_getAll'.HubspotCrmApi.GetPostalMailById
Retrieve details of a postal mail record by ID from HubSpot CRM. Use this tool to get detailed information about a specific postal mail record in HubSpot CRM by providing the postal mail ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
postal_mail_id | string | Required | The unique identifier for the postal mail record to retrieve details from HubSpot CRM. |
identify_by_id_property | string | Optional | Specifies which property will be used as the primary identifier. Accepts a string that represents the property within the postal mail object that should be used to identify and retrieve details. |
include_archived | boolean | Optional | Set to true to include archived postal mail records in the response. |
properties_with_history | array<string> | Optional | A list of property names for which history should be returned. Accepts an array of strings. |
related_objects_associations | array<string> | Optional | List of string identifiers representing related objects to retrieve alongside the postal mail record. |
specified_properties | array<string> | Optional | A list of specific postal mail properties to retrieve. Leave empty to get all properties. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/postal_mail/{postalMailId}_getById'.HubspotCrmApi.GetPostalMailRecords
Retrieve postal mail records from the CRM. Use this tool to access postal mail records from the CRM. It is helpful for obtaining stored postal mail information.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_objects | array<string> | Optional | A list of object types to retrieve associations for, such as contacts or companies. |
include_archived_records | boolean | Optional | Include archived postal mail records if true; exclude them if false. |
include_properties_history | array<string> | Optional | Specify property names to include their history in the records. Use an array of strings. |
max_records | integer | Optional | The maximum number of postal mail records to return. Must be an integer. |
pagination_cursor_after | string | Optional | A cursor for pagination. Use it to retrieve the next set of postal mail records after a specific point. |
retrieve_specific_properties | array<string> | Optional | List of specific properties to include in the response. Provide property names as strings. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/postal_mail_getPage'.HubspotCrmApi.GetProductDetailsById
Retrieve product details using a product ID. This tool retrieves the details of a product in HubSpot CRM using its product ID. It can also use any unique property specified by the `idProperty` query parameter. Use this tool to obtain specific product information from HubSpot CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_id | string | Required | A unique identifier for the product. Can be the internal ID or any unique property as specified by `idProperty`. |
properties_to_return | array<string> | Optional | A list of product properties to include in the response. Any missing properties will be ignored. |
properties_with_history | array<string> | Optional | List properties to return with their history of past values, separated by commas. Ignored if not present in object. |
retrieve_associated_object_ids | array<string> | Optional | A list of object types to retrieve associated IDs for. Any non-existent associations will be ignored. |
return_archived_only | boolean | Optional | Set to true to return only archived results. If false, only non-archived results are returned. |
unique_property_name | string | Optional | Specify the property name with unique values for the product object, instead of default productId. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/products/{productId}_getById'.HubspotCrmApi.GetProductsPage
Fetch a page of products from HubSpot CRM. Use this tool to retrieve a page of products from the HubSpot CRM. You can control the returned product details using the `properties` query parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | Provide a comma-separated list of object types to retrieve associated IDs for. Ignored if not existing. |
include_properties_with_history | array<string> | Optional | Comma separated list of product properties to include along with their history. Reduces maximum results per request if used. |
maximum_results_per_page | integer | Optional | The maximum number of results to display per page. |
paging_cursor_token | string | Optional | The cursor token for the last read resource, used for paged responses. |
product_properties_to_return | array<string> | Optional | Comma-separated properties to include in the response. Any non-existent properties for the requested objects will be ignored. |
return_archived_only | boolean | Optional | Set to true to return only results that have been archived. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/products_getPage'.HubspotCrmApi.GetPropertyValidationRules
Retrieve validation rules for properties of a given object in HubSpot CRM. Use this tool to get detailed validation rules for all properties associated with a specified object type ID in HubSpot CRM. This can be helpful for understanding constraints and rules applied to object properties.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type_id | string | Required | The unique identifier for the object type in HubSpot CRM whose property validation rules you want to retrieve. This is a string value. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/property-validations/{objectTypeId}'.HubspotCrmApi.GetQuoteById
Retrieve details of a quote by its ID. Fetches a quote from HubSpot CRM using its ID or a unique property value. Allows control over returned properties.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
quote_id | string | Required | The ID or unique property value of the quote to be retrieved. This identifies the specific quote in HubSpot CRM. |
included_properties | array<string> | Optional | List of properties to be returned in the response. If a property is not present, it will be ignored. Input should be an array of strings. |
only_return_archived | boolean | Optional | Set to true to only return results that have been archived for the quote. |
properties_with_history | array<string> | Optional | Comma-separated list of properties to return with their value history. Ignored if not present. |
retrieve_associated_object_types | array<string> | Optional | List of object types to retrieve associated IDs for; ignored if non-existent. |
unique_property_name | string | Optional | The property name with unique values for the quote object, used in the retrieval process. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/quotes/{quoteId}_getById'.HubspotCrmApi.GetQuotesPage
Retrieve a page of quotes with specified properties. Use this tool to read a page of quotes from HubSpot CRM. You can control the details returned by specifying properties through query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
paging_cursor_token | string | Optional | The token to identify the last read resource for pagination. Use it to get the next page of results. |
properties_with_history | array<string> | Optional | List of properties to return with their history. Reduces max quotes per request. |
quote_properties_to_return | array<string> | Optional | List the properties to retrieve for each quote. Only present properties will be returned. |
results_limit | integer | Optional | The maximum number of quote results to display per page. Accepts an integer value. |
retrieve_associated_ids_for_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for. Non-existing associations will be ignored. |
return_archived_only | boolean | Optional | Set to true to return only archived results. False to include active results. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/quotes_getPage'.HubspotCrmApi.GetRecordListMemberships
Retrieve lists a CRM record is a member of. This tool retrieves the lists that a specified CRM record is a member of, helping track its association with different lists.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type_id | string | Required | Specify the object type ID of the record to retrieve its list memberships. |
record_id | string | Required | The unique identifier of the CRM record whose list memberships you want to retrieve. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/lists/records/{objectTypeId}/{recordId}/memberships_getLists'.HubspotCrmApi.GetSubscriptionData
Fetch a page of subscription data from HubSpot CRM. This tool retrieves a page of subscription data from HubSpot CRM. Use this tool to access subscription information, with options to control the returned data via query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | List of object types to retrieve associated IDs for. Ignored if not existing. |
max_results_per_page | integer | Optional | The maximum number of subscription results to display per page. |
paging_cursor_token | string | Optional | The token indicating the last successfully read resource, used for pagination in subsequent requests. |
properties_with_history | array<string> | Optional | List of property names for retrieving their values and history. Reduces max subscriptions per request. |
requested_properties | array<string> | Optional | A list of property names to be included in the response. If a specified property is not present in the requested objects, it will be ignored. |
return_only_archived | boolean | Optional | Set to true to return only archived results. Set to false to include active results. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/subscriptions'.HubspotCrmApi.GetSubscriptionDetails
Retrieve details of a specific subscription by ID. This tool is used to fetch the details of a subscription object identified by its subscription ID. It allows control over what is returned using query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
subscription_id | string | Required | The unique identifier for the subscription object to be retrieved. This can be the internal object ID or a unique property value specified by the idProperty query param. |
association_types_to_retrieve | array<string> | Optional | A list of object types to retrieve associated IDs for. Non-existing associations will be ignored. |
only_archived_results | boolean | Optional | Set to true to return only archived items, false to exclude them. |
properties_with_history | array<string> | Optional | A list of property names whose values and history are to be retrieved for the subscription. Properties not present on the object will be ignored. |
requested_properties | array<string> | Optional | List of properties to return in the response. Properties not present in the object will be ignored. |
unique_property_name | string | Optional | The property name used to uniquely identify the subscription object instead of the default ID. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/subscriptions/{subscriptionId}'.HubspotCrmApi.GetTaskDetails
Retrieve HubSpot CRM task details using task ID. Call this tool to get detailed information about a specific task in HubSpot CRM by providing the task ID. Modify the returned data using query parameters if needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
task_id | string | Required | The unique identifier for the HubSpot CRM task. Retrieve specific task details using this ID. |
associated_object_types | array<string> | Optional | List of object types to retrieve associated IDs for. Returns IDs of related objects. |
properties_with_history | array<string> | Optional | List of properties to return with their previous values. Comma-separated and ignored if not present. |
requested_properties | array<string> | Optional | List of properties to return for the task. Only available properties will be returned. |
return_only_archived | boolean | Optional | Set to true to return only archived results. |
unique_property_name | string | Optional | Specify the name of the property with unique values to identify the task. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/tasks/{taskId}_getById'.HubspotCrmApi.GetTasksList
Retrieve a page of tasks from HubSpot CRM. Use this tool to read a page of tasks from HubSpot CRM. Specify which properties to return using the 'properties' query parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
max_results_per_page | integer | Optional | Specify the maximum number of task results to retrieve per page. |
paging_cursor_token | string | Optional | The token indicating the last resource read, used for pagination to continue from the next page. |
properties_with_history | array<string> | Optional | Specify properties to return along with their full change history. Note: This reduces the number of tasks per request. |
retrieve_associated_object_ids | array<string> | Optional | A list of object types to retrieve associated IDs for. If specified associations do not exist, they will be ignored. |
return_only_archived_results | boolean | Optional | Set to true to return only archived tasks; false for active tasks. |
task_properties_to_return | array<string> | Optional | A list of property names to include in the response. Ignored if not present on the tasks. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/tasks_getPage'.HubspotCrmApi.GetTaxDetailsById
Retrieve tax details using a specific tax ID. This tool retrieves tax object details from HubSpot CRM by specifying a tax ID. The ID can be the internal object ID or any unique property value as set by the `idProperty` query parameter. Useful for accessing specific tax information within HubSpot.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
tax_id | string | Required | The unique ID or property value for the tax object. Default is the internal object ID. |
associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for. Non-existent associations will be ignored. |
properties_with_history | array<string> | Optional | List properties to return with their historical values. Use a comma-separated format. |
return_archived_only | boolean | Optional | Set to true to return only archived results. False returns non-archived records. |
return_properties | array<string> | Optional | Comma-separated list of properties to be included in the response. Non-existing properties will be ignored. |
unique_property_name | string | Optional | The name of a property whose values are unique for the tax object. Use this to specify an alternative ID property instead of the default internal ID. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/taxes/{taxId}_getById'.HubspotCrmApi.GetTaxesPage
Retrieve a page of tax details from HubSpot CRM. Use this tool to read a specific page of tax details from the HubSpot CRM. You can control which properties are returned by specifying them in the query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
archived_only | boolean | Optional | Set to true to return only archived tax results. |
included_properties | array<string> | Optional | List the properties to be returned for each tax. Specify as an array of strings. |
max_results_per_page | integer | Optional | Specify the maximum number of tax results to display per page. |
paging_cursor_token | string | Optional | The token for the paging cursor from the last read resource for fetching the next page of results. |
properties_with_history | array<string> | Optional | Specify properties to return with their history. Reduces max number of taxes per request. |
retrieve_associated_object_ids | array<string> | Optional | Comma-separated list of object types to retrieve associated IDs for. Non-existent associations will be ignored. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/taxes_getPage'.HubspotCrmApi.GetTicketDetails
Retrieve details of a ticket by ID from HubSpot CRM. This tool retrieves detailed information about a specific ticket in HubSpot CRM identified by `ticketId`. It's useful for obtaining comprehensive ticket data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
ticket_id | string | Required | The ID of the ticket to retrieve from HubSpot CRM. This can be the internal object ID or a unique property value based on the `idProperty`. |
associated_object_types | array<string> | Optional | List of object types for retrieving associated IDs. Non-existent associations will be ignored. |
only_return_archived | boolean | Optional | Set to true to return only archived results. |
properties_to_return | array<string> | Optional | A list of properties to include in the response. Properties not present will be ignored. |
properties_with_history | array<string> | Optional | List of properties with their history to be returned. If properties are missing, they'll be ignored. |
unique_identifier_property | string | Optional | Specifies the property name with unique values for identifying the ticket. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/tickets/{ticketId}_getById'.HubspotCrmApi.GetTranscriptById
Retrieve call transcript details by transcript ID. This tool retrieves details of a call transcript for a given transcript ID in the HubSpot CRM. Use it to access specific call records and transcript data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
transcript_id | string | Required | The unique identifier of the call transcript to retrieve from HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/extensions/calling/transcripts/{transcriptId}'.HubspotCrmApi.GetUserInfo
Retrieves user information from HubSpot CRM using user ID. Use this tool to fetch detailed information about a user in HubSpot CRM by specifying the user's unique ID. You can control the returned data by using specific query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
user_identifier | string | Required | The unique identifier for the user. This can be the internal object ID or a property value specified by `idProperty`. |
object_associations | array<string> | Optional | Comma separated list of object types to retrieve associated IDs for in the user info response. |
properties_to_return | array<string> | Optional | A list of user properties to return in the response. If any specified properties are not present, they will be ignored. |
properties_with_history | array<string> | Optional | List of property names to return with their value history for the user. |
return_only_archived_results | boolean | Optional | Set to true to return only archived results. Set to false to exclude archived items from results. |
unique_property_name | string | Optional | The name of a property with unique values to identify the object. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/users/{userId}'.HubspotCrmApi.GetUsersPage
Fetch a page of users from the CRM. Use this tool to read a page of users from the HubSpot CRM. You can control which user properties are returned by using the appropriate query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | A list of object types for which associated IDs should be retrieved. If specified associations do not exist, they will be ignored. |
max_results_per_page | integer | Optional | Specify the maximum number of results to display per page. |
paging_cursor_token | string | Optional | The paging cursor token from the last read resource, used to fetch next set of results. |
properties_with_history | array<string> | Optional | List of properties to return with their history. Reduces the maximum number of users per request. |
return_only_archived | boolean | Optional | Set to true to return only results that have been archived. |
user_properties | array<string> | Optional | A list of user property names to include in the response. Any non-existent properties will be ignored. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/users'.HubspotCrmApi.HubspotBatchArchiveAssociations
Batch archive associations in HubSpot CRM. This tool is used to archive multiple associations between specified object types in HubSpot CRM in a single batch operation. Call this tool when you need to efficiently remove associations between records, such as contacts and companies, or deals and tickets, in bulk. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
source_object_type | string | Optional | The type of the source object for the associations to be archived (e.g., 'contacts', 'companies'). Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
target_object_type | string | Optional | Specify the type of the object to which the association is directed, e.g., 'company', 'deal'. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/archive_archive'.HubspotCrmApi.HubspotCrmSearchObjects
Search and retrieve objects from HubSpot CRM. Use this tool to perform a search for specific objects within the HubSpot CRM. It should be called when you need to find and retrieve detailed information about CRM objects based on search criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-410/search'.HubspotCrmApi.HubspotCrmUpsertRecords
Create or update unique records in HubSpot CRM. This tool allows for the creation or update of CRM records in HubSpot, identified by a unique property. Use it when you need to batch upload or modify records based on a unique identifier. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-162/batch/upsert'.HubspotCrmApi.HubspotSearchCustomObjects
Search for custom objects in HubSpot CRM. Use this tool to search for custom objects within the HubSpot CRM. It should be called when you need to retrieve specific custom object data based on certain criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-162/search'.HubspotCrmApi.HubspotUpdateListing
Update specific details of a HubSpot listing. This tool performs a partial update of a HubSpot listing identified by `listingId` or a unique property specified by `idProperty`. It overwrites provided property values, with errors for read-only or non-existent properties. Clear values by passing an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
listing_id | string | Optional | The unique identifier of the listing to update in HubSpot. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of a unique property for this object, used for identification. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/0-420/{listingId}'.HubspotCrmApi.ListCrmEntries
Retrieve a page of CRM listings with specified properties. This tool fetches a page of CRM listings from HubSpot, allowing the user to control which properties are returned via query parameters. Use this to obtain customer records and details from the CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for, such as 'contacts' or 'deals'. Ignored if not existent. |
include_only_archived_results | boolean | Optional | Set to true to return only archived results. False to exclude archived entries. |
include_properties_with_history | array<string> | Optional | List the properties whose values along with their history should be returned. Reduces the number of listings per request. |
maximum_results_per_page | integer | Optional | The maximum number of CRM listing results to display per page. This controls pagination size. |
paging_cursor_token | string | Optional | The cursor token for fetching the next page of CRM listings. |
properties_to_return | array<string> | Optional | Comma-separated list of properties to include in the response. Non-existent properties will be ignored. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/0-420'.HubspotCrmApi.ListPartnerClientAssociations
Retrieve associations of a partner client by type. Use this tool to list associations for a specific partner client in HubSpot CRM. It helps in retrieving related objects based on the specified type.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
partner_client_id | string | Required | The unique identifier for the partner client whose associations are to be retrieved. It is required and must be a valid string. |
target_object_type | string | Required | The type of object to which the partner client is associated. Specify using a string value representing the object type, such as 'contact' or 'deal'. |
include_family_associations | boolean | Optional | Indicate whether to include family associations in the response. Set to true to include them. |
max_results_per_page | integer | Optional | Specify the maximum number of results to display per page. Use an integer value. |
paging_cursor_token | string | Optional | The token used for pagination to fetch the next set of results. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/partner_clients/{partnerClientId}/associations/{toObjectType}'.HubspotCrmApi.ListPartnerServiceAssociations
Retrieve associations of a partner service by type. This tool retrieves a list of associations for a specified partner service in HubSpot CRM based on the provided type. It should be called when you need to explore relationships connected to a partner service, filtering by specific object types.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
partner_service_id | string | Required | The unique identifier of the partner service to retrieve associations for. This ID is required. |
target_object_type | string | Required | The type of object to filter associations by, such as contacts, companies, etc. |
include_associated_fields | boolean | Optional | Set to true to include associated fields in the response. |
max_results_per_page | integer | Optional | Specify the maximum number of results to display per page. This determines the page size for the response. |
paging_cursor_token | string | Optional | The token to continue paginated results from the last read resource. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/partner_services/{partnerServiceId}/associations/{toObjectType}'.HubspotCrmApi.ManageDealSplits
Create or replace deal splits for specific deals. This tool is used to create or update deal splits for the specified deal IDs. The deal split percentages must add up to 100% and can have up to 8 decimal places. It is useful for managing deal contributions among different stakeholders. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/deals/splits/batch/upsert_upsert'.HubspotCrmApi.MergeCompanyRecords
Merge two company records in HubSpot CRM. Use this tool to merge two company records into a single record in HubSpot CRM, ensuring data consistency.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
company_id_to_merge | string | Required | The ID of the company to merge into the primary company. |
primary_company_id | string | Required | The ID of the primary company into which the other company will be merged. |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/companies/merge_merge'.HubspotCrmApi.MergeContacts
Merges two contacts into one in HubSpot CRM. Use this tool to merge two existing contacts within HubSpot CRM. It consolidates contact information, ensuring that no duplicate entries exist for the same individual.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
contact_id_to_merge | string | Required | The ID of the contact object that will be merged into the primary contact. |
primary_contact_id | string | Required | The unique identifier of the primary contact that will remain after merging. This contact's information will be retained. |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/contacts/merge'.HubspotCrmApi.MergeDeals
Combine two deals into a single unified deal in HubSpot CRM. Use this tool to merge two deals of the same type into one within HubSpot CRM. It is useful when consolidating duplicate or related deals into a single entry.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
deal_id_to_merge | string | Required | The ID of the deal to be merged into the primary deal. |
primary_deal_id | string | Required | The ID of the primary deal that will remain after merging. |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-3/merge_merge'.HubspotCrmApi.MergeHubspotCrmObjects
Merge two HubSpot CRM objects into a single entity. Use this tool to merge two CRM objects of a specified type within HubSpot. It combines duplicate records into a single object, streamlining the data management process.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
hubspot_object_type | string | Required | Specify the type of HubSpot CRM object to merge, such as contact, company, or deal. |
object_id_to_merge | string | Required | The ID of the HubSpot CRM object to be merged into the primary object. This should be a string identifier. |
primary_object_id | string | Required | The ID of the primary HubSpot CRM object to retain post-merge. |
Requirements
Output
json— Response from the API endpoint 'post-/crm/objects/v3/{objectType}/merge'.HubspotCrmApi.MergeHubspotObjects
Merge two HubSpot CRM objects of the same type. Use this tool to merge two objects within HubSpot CRM that have the same object type, such as contacts or companies. It is useful for consolidating duplicate records into a single, unified entry.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_id_to_merge | string | Required | The ID of the object to be merged into the primary object. It must be of the same type as the primary object. |
object_type_to_merge | string | Required | The type of HubSpot CRM object to merge, such as 'contacts' or 'companies'. |
primary_object_id | string | Required | The ID of the object that will remain after the merge. Provide as a string. |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/{objectType}/merge_merge'.HubspotCrmApi.MergeSupportTickets
Merge two support tickets into one unified record. This tool merges two separate support tickets into a single ticket record, combining all the relevant information. It should be used when consolidating duplicate or related tickets is necessary to streamline customer support operations.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
primary_ticket_id | string | Required | The ID of the ticket designated as the primary record in the merge operation. After merging, this ticket will contain all combined information. |
secondary_ticket_id | string | Required | The ID of the support ticket to be merged into the primary ticket. It specifies which ticket will be combined with the primary ticket record. |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tickets/merge_merge'.HubspotCrmApi.ModifyHubspotObject
Update specific properties of a HubSpot CRM object. Use this tool to perform partial updates on HubSpot CRM objects by specifying the object type and ID. You can update properties by providing new values, but ensure they aren't read-only or non-existent. Clear properties by passing an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
hubspot_object_type | string | Optional | Specify the type of HubSpot CRM object (e.g., 'contacts', 'companies', 'deals'). Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
object_identifier | string | Optional | The internal ID of the HubSpot object to update. Use a string format. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of a unique property for identifying the object. Use when the default object ID isn't used. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/{objectType}/{objectId}_update'.HubspotCrmApi.MoveFolderInHubspot
Move a folder to a new parent in HubSpot CRM. This tool moves a folder to a new parent location in HubSpot CRM, updating the folder's parent ID to the specified new ID. Use this when you need to reorganize folder structures within the CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_id_to_move | string | Required | The ID of the folder you want to move to a new location in HubSpot CRM. |
target_parent_folder_id | string | Required | The ID of the target parent folder to which the current folder will be moved. |
Requirements
Output
json— Response from the API endpoint 'put-/crm/v3/lists/folders/{folderId}/move/{newParentFolderId}_move'.HubspotCrmApi.MoveListingToRecycleBin
Move a listing to the recycling bin by ID. Use this tool to move a specific listing identified by its ID to the recycling bin in HubSpot CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
listing_id | string | Required | The unique identifier of the listing to be moved to the recycling bin in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/0-420/{listingId}'.HubspotCrmApi.MoveListToFolder
Move a CRM list to a specified folder. Use this tool to move a specific list within HubSpot CRM to a desired folder, organizing lists efficiently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The ID of the list you want to move. It should be a valid string representing the list in HubSpot CRM. |
target_folder_id | string | Required | The ID of the folder to move the list to. Use '0' for the root folder. |
Requirements
Output
json— Response from the API endpoint 'put-/crm/v3/lists/folders/move-list_moveList'.HubspotCrmApi.MoveObjectToRecycleBin
Move a CRM object to the recycling bin. Use this tool to move a specified CRM object to the recycling bin using its object type and ID. This is useful for archiving or removing unnecessary data in HubSpot CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_id | string | Required | The unique identifier for the CRM object to be moved to the recycling bin. This ID specifies which object within the CRM will be affected. |
object_type | string | Required | Type of the CRM object to be moved, such as 'contacts', 'companies', etc. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/{objectType}/{objectId}_archive'.HubspotCrmApi.PipelineLimitsUsage
Retrieve limits and usage for HubSpot CRM pipelines. Call this tool to obtain information about the limits and current usage of pipelines in HubSpot CRM. Useful for understanding capacity and utilization of your CRM pipelines.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/limits/pipelines'.HubspotCrmApi.ReadBatchDealSplits
Fetch a batch of deal split objects by deal ID. This tool reads a batch of deal split objects using their associated deal object internal IDs, allowing access to multiple deal splits in one request. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/deals/splits/batch/read_read'.HubspotCrmApi.ReadBatchPayments
Retrieve a batch of payments from CRM by IDs or unique properties. Use this tool to get details of multiple payments from the CRM system based on internal IDs or unique property values. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
only_return_archived_results | boolean | Optional | Return only archived results if set to true. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/payments/batch/read'.HubspotCrmApi.ReadBatchProperties
Fetches a batch of properties for a specified CRM object type. Use this tool to retrieve a list of properties for a given object type in the CRM. This can be useful when you need detailed information about multiple properties at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
crm_object_type | string | Optional | The type of CRM object for which properties are being read (e.g., contacts, deals). Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/properties/{objectType}/batch/read'.HubspotCrmApi.ReadCommunicationsPage
Retrieve a page of communications from HubSpot CRM. Use this tool to read a page of communications. You can control the information returned using query parameters for specific properties.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
paging_cursor_token | string | Optional | The paging cursor token for the next set of results to read from the previous request's `paging.next.after` JSON property. |
properties_with_history | array<string> | Optional | A list of properties to return with their history. Reduces the maximum number of communications per request. |
results_per_page | integer | Optional | The maximum number of results to display per page. |
retrieve_associations | array<string> | Optional | Comma-separated list of object types to get associated IDs for. Ignored if the association doesn't exist. |
return_only_archived_results | boolean | Optional | Set to true to return only archived results. False includes all results. |
specified_properties | array<string> | Optional | List of communication properties to return in the response. Properties not present will be ignored. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/communications_getPage'.HubspotCrmApi.ReadProperty
Retrieve CRM property details by name and type. This tool fetches details of a specific property from HubSpot CRM by providing the property name and object type. Use this tool to access property information when dealing with HubSpot CRM data.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
crm_object_type | string | Required | Specify the CRM object type, such as 'contact' or 'company', to retrieve the property for. |
property_name | string | Required | The unique name of the property to retrieve. This should match the property name in HubSpot CRM. |
property_specifications | string | Optional | Specify the details or attributes of the property to retrieve. Use a comma-separated list for multiple specifications. |
return_archived_only | boolean | Optional | Set to True to return only archived property results. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/properties/{objectType}/{propertyName}'.HubspotCrmApi.ReadPropertyGroup
Retrieve details of a property group by its name. Use this tool to get detailed information about a property group identified by {groupName} within a specified object type in HubSpot CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type | string | Required | Specify the type of CRM object, such as 'contacts' or 'deals'. |
property_group_name | string | Required | The name of the property group to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/properties/{objectType}/groups/{groupName}'.HubspotCrmApi.ReadServicesPage
Retrieve a page of services with customizable properties. This tool retrieves a page of services from the HubSpot CRM API, allowing customization of returned data via the `properties` query parameter. Use this tool to access service information efficiently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for each service. Ignored if associations do not exist. |
max_results_per_page | integer | Optional | Specify the maximum number of results to display per page. |
paging_cursor_token | string | Optional | The cursor token from the last read to retrieve the next page of results. |
properties_with_history | array<string> | Optional | A list of properties to return with their history of values. If absent, properties are ignored. Reduces max services per request. |
requested_properties | array<string> | Optional | Comma-separated list of properties to include in the response. Non-existent properties will be ignored. |
return_archived_only | boolean | Optional | Set to true to return only archived results; false to include non-archived results. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/0-162'.HubspotCrmApi.RemoveAllListMemberships
Remove all records from a CRM list without deleting the list. Use this tool to remove all memberships from a HubSpot CRM list that has a processing type of MANUAL or SNAPSHOT. Suitable for lists with fewer than 100,000 memberships.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The ILS ID of a MANUAL or SNAPSHOT list in HubSpot CRM. Required for removing all memberships. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/lists/{listId}/memberships_removeAll'.HubspotCrmApi.RemoveCrmAssociation
Remove associations between CRM objects. This tool removes the association between two CRM objects based on specified types and IDs. Use it when you need to delete a relationship or link between specific CRM entities.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
association_type | string | Required | The type of association between the CRM objects to be removed. Specify the nature of the relationship, such as 'contact-to-company'. |
object_type | string | Required | Specifies the type of the primary CRM object (e.g., 'contact', 'company'). |
source_object_id | string | Required | The unique identifier of the source object whose association is to be removed. |
target_object_id | string | Required | The ID of the target object to unlink from the source object. This must be a string representing the unique identifier. |
target_object_type | string | Required | Specifies the type of the target CRM object to unlink. Examples include 'contact', 'company', etc. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/objects/v3/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}/{associationType}'.HubspotCrmApi.RemovePartnerClientAssociation
Remove an association between two partner clients in HubSpot CRM. This tool removes an existing association between two partner clients in the HubSpot CRM system. It should be called when you need to disassociate a partner client from another object, identified by specific IDs and association type.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
association_type | string | Required | The type of association to be removed between the partner client and the object. This defines the nature of their relationship. |
partner_client_id | string | Required | The unique identifier for the partner client to be disassociated. This should be a string that identifies the specific partner client in the HubSpot CRM. |
target_object_id | string | Required | The unique identifier of the object associated with the target partner client. |
target_object_type | string | Required | Specify the type of the object you are dissociating from the partner client, such as 'contacts' or 'companies'. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/partner_clients/{partnerClientId}/associations/{toObjectType}/{toObjectId}/{associationType}'.HubspotCrmApi.RemovePartnerServiceAssociation
Remove an association between two partner services. This tool removes the specified association between partner services in HubSpot CRM. Use it when you need to disassociate two services linked by a specific relationship.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
association_type | string | Required | Specifies the type of association to remove between the partner services. This is a string value that defines how the services are linked. |
partner_service_id | string | Required | The unique identifier for the partner service. It specifies which partner service's association is to be removed. |
target_object_id | string | Required | The unique identifier of the object to be disassociated from the partner service. This is required to specify which object is being unlinked. |
target_object_type | string | Required | The type of the object to which the partner service is associated. Specify the object category, such as 'contact', 'company', etc. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/partner_services/{partnerServiceId}/associations/{toObjectType}/{toObjectId}/{associationType}'.HubspotCrmApi.RemoveProduct
Archive a product by moving it to the recycling bin. Use this tool to move a product, identified by its productId, to the recycling bin in HubSpot CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
product_id | string | Required | The unique identifier of the product to be archived in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'delete-/crm/v3/objects/products/{productId}_archive'.HubspotCrmApi.RemoveRecordsFromList
Remove specified records from a HubSpot CRM list. Use this tool to remove records from a HubSpot CRM list with `processingType` of `MANUAL` or `SNAPSHOT`. Records not in the list will be ignored.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The ILS ID of the MANUAL or SNAPSHOT list from which records will be removed. |
record_ids_to_remove | array<string> | Required | List of record IDs to remove from the HubSpot CRM list. |
Requirements
Output
json— Response from the API endpoint 'put-/crm/v3/lists/{listId}/memberships/remove_remove'.HubspotCrmApi.RenameCrmFolder
Rename a folder in HubSpot CRM by its folder ID. Use this tool to rename a specific folder in HubSpot CRM using its folder ID. Useful for organizing or updating folder names within your CRM system.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
folder_id | string | Required | The ID of the folder you want to rename in HubSpot CRM. |
new_folder_name | string | Optional | The new name to assign to the folder. It should be a string representing the desired folder name in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'put-/crm/v3/lists/folders/{folderId}/rename_rename'.HubspotCrmApi.ReplacePipelineHubspot
Replace a specific pipeline in HubSpot CRM. Use this tool to replace a specific pipeline in HubSpot CRM when you need to update or modify the pipeline's entire structure or data. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
object_type | string | Optional | Specify the object type for the pipeline, such as 'deals' or 'tickets'. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
pipeline_identifier | string | Optional | The unique identifier of the pipeline to replace in HubSpot CRM. This is required to specify which pipeline is being modified. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
validate_references_before_deletion | boolean | Optional | Set to true to validate all references before deleting the pipeline. Only used when mode is 'execute'. |
validate_deal_stage_usages_before_delete | boolean | Optional | Set to true to validate deal stage usages before deleting a pipeline; false to proceed without validation. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'put-/crm/v3/pipelines/{objectType}/{pipelineId}_replace'.HubspotCrmApi.ReplacePipelineStageProperties
Replace and update a pipeline stage in HubSpot CRM. Use this tool to replace all properties of an existing pipeline stage in HubSpot CRM with the provided values. The modified stage's details are returned in the response. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
crm_object_type | string | Optional | Specifies the CRM object type like 'deals' or 'contacts' to identify the pipeline stage being replaced. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
pipeline_id | string | Optional | The unique identifier for the pipeline whose stage properties are to be replaced. This must match the ID used in HubSpot CRM. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
pipeline_stage_id | string | Optional | The unique identifier for the pipeline stage to be replaced. This is required to specify which stage's properties will be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'put-/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}_replace'.HubspotCrmApi.RestoreDeletedList
Restore a previously deleted HubSpot CRM list. This tool restores a previously deleted list in HubSpot CRM using the list ID. Lists can be restored up to 90 days after deletion. Use this when you need to recover a list that was mistakenly deleted.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id_to_restore | string | Required | The ILS ID of the list to restore. Use this to specify which deleted list to recover. |
Requirements
Output
json— Response from the API endpoint 'put-/crm/v3/lists/{listId}/restore_restore'.HubspotCrmApi.RetrieveAllCompanies
Retrieve all companies from HubSpot CRM. This tool retrieves all companies from the HubSpot CRM. It uses query parameters to control the information that gets returned, such as filtering or specifying fields. Useful for getting a comprehensive list of companies stored in the CRM.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for. Non-existent associations will be ignored. |
paging_cursor_token | string | Optional | The cursor token to fetch the next set of results in a paginated response. |
properties_to_return | array<string> | Optional | List of properties to include in the response. Ignore if not present on the object. |
properties_with_history | array<string> | Optional | A list of properties to return with their history of previous values. This reduces max companies per request. |
results_per_page_limit | integer | Optional | The maximum number of results to display per page. |
return_only_archived_results | boolean | Optional | Set to true to return only archived results in the response. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/companies_getPage'.HubspotCrmApi.RetrieveBatchCommunications
Retrieve a batch of communication messages by ID. This tool retrieves a batch of communication messages from the HubSpot CRM using either the message ID or a unique property value. It should be called when you need to access multiple messages simultaneously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_only | boolean | Optional | Set to True to return only archived results. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/communications/batch/read_read'.HubspotCrmApi.RetrieveBatchCompaniesHubspot
Retrieve a batch of company records from HubSpot CRM. Use this tool to retrieve multiple companies from HubSpot CRM by specifying their IDs or unique properties. You can customize the returned data using the `properties` query parameter. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_only | boolean | Optional | Set to true to return only archived companies in the results. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/companies/batch/read_read'.HubspotCrmApi.RetrieveBatchLineItems
Retrieve batch line item records by ID or custom property. Use this tool to retrieve multiple line item records from HubSpot CRM using their IDs or a custom unique property. This is helpful for accessing specific sets of records without manually querying each one individually. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
retrieve_only_archived | boolean | Optional | Set to true to retrieve only archived line items. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/line_items/batch/read_read'.HubspotCrmApi.RetrieveCallsBatch
Retrieve a batch of calls by ID from HubSpot CRM. Use this tool to fetch details of multiple calls from HubSpot CRM by providing their IDs. It returns information about each call in the batch. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_only_archived | boolean | Optional | Set to 'true' to return only archived calls, 'false' to exclude them. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/calls/batch/read_read'.HubspotCrmApi.RetrieveCartDetails
Retrieve detailed information about shopping carts. Use this tool to get information about shopping carts, with options to specify which details to retrieve via query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | List object types to retrieve associated IDs for. Ignored if associations don't exist. |
cart_properties_to_return | array<string> | Optional | List of properties to include in the response for each cart. Ignored if missing on objects. |
max_results_per_page | integer | Optional | Maximum number of results to display per page when retrieving cart details. |
paging_cursor_token | string | Optional | The paging cursor token for retrieving the next set of results. Use the `paging.next.after` from the previous response for more results. |
properties_with_history_list | array<string> | Optional | List of properties to return with their history in the response. Reduces max number of carts per request. |
return_only_archived | boolean | Optional | Set to true to return only archived results. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/carts'.HubspotCrmApi.RetrieveCartRecords
Retrieve cart records by record ID or custom property. Use this tool to fetch cart records from HubSpot CRM by specifying record IDs or using a custom unique value property. Ideal for accessing detailed cart information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
only_archived_results | boolean | Optional | Set to true to return only archived results. Default is false. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/carts/batch/read'.HubspotCrmApi.RetrieveCommercePaymentDetails
Retrieve details of a specific commerce payment using its ID. Use this tool to obtain detailed information about a commerce payment by specifying its unique ID. This can include any details specified by the `properties` query parameter, if required.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
commerce_payment_id | string | Required | The unique identifier for the commerce payment to retrieve details for. It corresponds to the internal object ID by default. |
associated_object_types | array<string> | Optional | List of object types to retrieve associated IDs for. If any specified associations do not exist, they are ignored. |
only_return_archived_results | boolean | Optional | Specify `true` to return only archived results. Default is `false`. |
properties_with_history | array<string> | Optional | List of properties to retrieve along with their historical values. Specify as comma-separated values. |
return_properties | array<string> | Optional | A list of property names to be included in the response. Irrelevant properties will be ignored. |
unique_property_name | string | Optional | The property name used as a unique identifier for the commerce payment object. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/commerce_payments/{commercePaymentId}'.HubspotCrmApi.RetrieveCommercePaymentRecords
Retrieve commerce payment records by ID or unique property. This tool is used to fetch commerce payment records from HubSpot CRM by specifying record IDs or using a custom unique property for retrieval. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_results_only | boolean | Optional | Return only archived commerce payment records if set to true. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/commerce_payments/batch/read'.HubspotCrmApi.RetrieveCompanyById
Retrieve detailed company information using its ID. Use this tool to get detailed information about a company by providing its ID or a unique property. You can specify which properties to retrieve.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
company_identifier | string | Required | A unique identifier for the company, such as its ID or a unique property name, used to retrieve its details. |
associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for. Ignores non-existent associations. |
company_properties_to_retrieve | array<string> | Optional | List the specific company properties to retrieve, separated by commas. Ignored if properties are unavailable. |
retrieve_properties_with_history | array<string> | Optional | List of properties to return with their history of previous values. Ignored if properties aren't present. |
return_only_archived | boolean | Optional | Set to true to return only archived results. If false, non-archived results will be returned. |
unique_property_name | string | Optional | The name of a unique property to identify the company. Used instead of company ID. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/companies/{companyId}_getById'.HubspotCrmApi.RetrieveConversionDetails
Retrieve conversion details for a specific list in HubSpot CRM. Use this tool to check for upcoming conversions or to get details of past conversions for a list.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The ID of the list for which you want to retrieve conversion details. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/lists/{listId}/schedule-conversion'.HubspotCrmApi.RetrieveCrmObject
Fetch CRM object details by ID or unique property. Use this tool to retrieve details of a CRM object by specifying the object type and ID. You can control the properties returned using query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_id | string | Required | The ID of the CRM object to retrieve. This can be the internal object ID or a unique property value specified by the id_property. |
object_type | string | Required | Specifies the type of CRM object to retrieve, such as "contacts", "companies", or "deals". |
associated_object_types | array<string> | Optional | Comma-separated list of object types to retrieve associated IDs for. Missing associations are ignored. |
properties_list | array<string> | Optional | An array of property names to be returned in the response. If any specified properties are not present, they will be ignored. |
properties_with_history | array<string> | Optional | List properties to be returned with their historical values. If a property doesn't exist, it'll be ignored. |
return_only_archived_results | boolean | Optional | Set to true to return only archived results. |
unique_property_name | string | Optional | Specify the name of a property with unique values for this object to identify it instead of the default ID. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/objects/v3/{objectType}/{objectId}'.HubspotCrmApi.RetrieveCrmRecords
Retrieve CRM records by ID or custom unique property. This tool retrieves CRM records using either their record ID or a custom unique value property specified by the `idProperty` parameter. It is useful for accessing detailed information about specific records stored in the CRM system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
retrieve_only_archived_records | boolean | Optional | Set to true to retrieve only archived CRM records. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-3/batch/read_read'.HubspotCrmApi.RetrieveDiscountDetails
Retrieve details of a discount by its ID. Use this tool to get detailed information about a specific discount object by providing its ID. The tool allows customization of returned properties through query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
discount_identifier | string | Required | The unique identifier for the discount object to retrieve. This can either be the internal ID or a value of a unique property specified by `idProperty`. |
archived_results_only | boolean | Optional | Set to true to return only results that have been archived. |
associated_object_types | array<string> | Optional | Comma-separated list of object types to retrieve associated IDs for. Non-existent associations will be ignored. |
properties_with_history | array<string> | Optional | List of properties to retrieve along with their value history. Ignored if properties are missing. |
return_properties | array<string> | Optional | Comma-separated list of properties to return in response. Ignored if not present on the object. |
unique_property_name | string | Optional | The property name for uniquely identifying the discount object. Use when the property value is not the default ID. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/discounts/{discountId}'.HubspotCrmApi.RetrieveDiscountRecords
Retrieve discount records by ID or custom property. This tool retrieves discount records from HubSpot CRM by specifying record IDs or a unique custom property. Use it to fetch detailed information about discounts in a batch. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
archived | boolean | Optional | Set to true to return only archived results. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/discounts/batch/read'.HubspotCrmApi.RetrieveEmailById
Retrieve email object details using its ID. Use this tool to get detailed information about an email object in HubSpot CRM using its unique ID. You can control the output via query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
email_id | string | Required | The unique ID or property value of the email object to be retrieved. |
object_types_for_associated_ids | array<string> | Optional | List the object types to retrieve associated IDs. If no associations exist, they will be ignored. |
properties_with_history | array<string> | Optional | Comma-separated property names to include their history of previous values in the response. Non-existent properties will be ignored. |
return_only_archived_results | boolean | Optional | Set to true to return only archived results. Set to false to return active results. |
returned_properties | array<string> | Optional | A list of properties to return for the email object. Properties not present on the object will be ignored. |
unique_property_name | string | Optional | Specify the property name that holds unique values for the email object to be retrieved. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/emails/{emailId}_getById'.HubspotCrmApi.RetrieveEmailRecords
Retrieve email records by ID or custom property. This tool retrieves email records from HubSpot CRM by providing record IDs or using a custom unique value property. It should be called when you need details about specific email records stored within HubSpot. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
only_archived_records | boolean | Optional | Set to true to return only archived email records from HubSpot CRM. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/emails/batch/read_read'.HubspotCrmApi.RetrieveEmailsPage
Retrieve a page of emails from HubSpot CRM. This tool reads a page of emails from HubSpot CRM. You can control which email properties are returned by using the `properties` query parameter.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | A list of object types to retrieve associated IDs for. If any specified associations don't exist, they will be ignored. |
max_results_per_page | integer | Optional | The maximum number of email results to display per page. |
paging_cursor_token | string | Optional | The token for the next page of results, from the `paging.next.after` field of the previous response. |
properties_with_history | array<string> | Optional | List of properties to return with their history of previous values. Reduces maximum emails per request. |
return_only_archived | boolean | Optional | Set to true to retrieve only archived emails. |
returned_email_properties | array<string> | Optional | List the email properties to be included in the response. Specify as an array of strings representing the desired properties. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/emails_getPage'.HubspotCrmApi.RetrieveEventDetails
Retrieve detailed information for a specific HubSpot event. Use this tool to get detailed information about a specific event in HubSpot CRM, identified by its template ID and event ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_id | string | Required | Specify the event ID to retrieve detailed information for a specific event in HubSpot CRM. |
event_template_id | string | Required | The ID of the event template used to identify and retrieve specific event details in HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'get-/integrators/timeline/v3/events/{eventTemplateId}/{eventId}/detail_getDetailById'.HubspotCrmApi.RetrieveEventInstance
Retrieve an event instance using template and event ID. Use this tool to access detailed information about a specific event instance by providing the event template ID and event ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
event_id | string | Required | The unique identifier for the specific event you want to retrieve. |
event_template_id | string | Required | The unique ID of the event template required to retrieve the event instance. |
Requirements
Output
json— Response from the API endpoint 'get-/integrators/timeline/v3/events/{eventTemplateId}/{eventId}_getById'.HubspotCrmApi.RetrieveFeedbackRecords
Retrieve feedback submission records by ID or custom properties. Use this tool to fetch feedback submission records from HubSpot CRM using either a record ID or a custom unique value property (`idProperty`). Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_only | boolean | Optional | Set to true to return only archived feedback submission records. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/feedback_submissions/batch/read_read'.HubspotCrmApi.RetrieveFeeRecords
Retrieve fee records by ID or custom property. Use this tool to retrieve fee records from HubSpot CRM by specifying record IDs or using a custom unique value property. Useful for accessing detailed record information in batch. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_only | boolean | Optional | Set to true to return only archived fee records. False to return active records. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/fees/batch/read'.HubspotCrmApi.RetrieveFoldersWithChildNodes
Retrieve folders and include all child folders recursively. This tool is used to retrieve a folder from HubSpot CRM and recursively include all child folders via the childNodes attribute, while child lists in these nodes will be empty. Only the retrieved folder will include its child lists.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
target_folder_id | string | Optional | The ID of the folder to retrieve and include all child nodes recursively from HubSpot CRM. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/lists/folders_getAll'.HubspotCrmApi.RetrieveGoalTargets
Retrieve goal target records using record ID or custom value. Use this tool to retrieve goal target records from HubSpot CRM by providing either the record ID or a custom unique value property. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_only_archived_results | boolean | Optional | Set to true to return only the archived records. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/goal_targets/batch/read_read'.HubspotCrmApi.RetrieveHubspotCrmRecords
Retrieve HubSpot CRM records by ID or unique property. Use this tool to fetch HubSpot CRM records by specifying a record ID or a custom unique value property using the `idProperty` parameter. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
crm_object_type | string | Optional | The type of CRM object to retrieve (e.g., contacts, companies). Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
return_only_archived_records | boolean | Optional | Set true to return only archived records; false to return unarchived records. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/objects/v3/{objectType}/batch/read'.HubspotCrmApi.RetrieveHubspotOrders
Retrieve order records from HubSpot CRM by ID or custom property. Use this tool to fetch order records from HubSpot CRM by providing record IDs or a custom unique value property. Ideal for accessing specific order details stored in your HubSpot account. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_only_archived_orders | boolean | Optional | Set to True to return only archived order records from HubSpot CRM. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/orders/batch/read'.HubspotCrmApi.RetrieveHubspotProductRecords
Retrieve HubSpot product records by ID or unique property. This tool retrieves HubSpot CRM product records using a record ID or a custom unique value property (`idProperty`). It is useful for accessing detailed product data stored in HubSpot CRM based on specific identifiers. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
only_archived | boolean | Optional | Set to true to retrieve only archived product records. False returns unarchived records. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/products/batch/read_read'.HubspotCrmApi.RetrieveHubspotProperties
Retrieve all properties for a HubSpot object type. Use this tool to read all existing properties for a specified object type in HubSpot CRM. It provides property details relevant to the chosen object type within a HubSpot account.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type | string | Required | Specifies the HubSpot object type (e.g., contact, deal) to retrieve properties for. |
return_archived_only | boolean | Optional | Set to true to return only results that have been archived. Otherwise, return all properties. |
selected_properties | string | Optional | A comma-separated list of specific properties to retrieve for the object type. Leave empty to retrieve all properties. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/properties/{objectType}'.HubspotCrmApi.RetrieveHubspotPropertyGroups
Retrieve HubSpot CRM property groups for a specified object type. This tool retrieves all existing property groups for a specified object type within a HubSpot account. Use it to access property group information for organizing and managing CRM data effectively.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
hubspot_object_type | string | Required | Specify the HubSpot object type to retrieve property groups, such as 'contacts', 'companies', or 'deals'. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/properties/{objectType}/groups'.HubspotCrmApi.RetrieveHubspotRecords
Retrieve HubSpot CRM records by ID or unique property. This tool retrieves HubSpot CRM records using either the record ID or a custom unique value property specified by the `idProperty`. It's useful for accessing multiple records within the CRM at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_records | boolean | Optional | Set to true to return only archived records; false to exclude archived records in HubSpot CRM. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-410/batch/read'.HubspotCrmApi.RetrieveHubspotTasks
Retrieve HubSpot task records by ID or custom property. Use this tool to fetch task records from HubSpot CRM by specifying record IDs or a custom unique value property via the `idProperty` parameter. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_only | boolean | Optional | Set to true to return only archived records from HubSpot. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tasks/batch/read_read'.HubspotCrmApi.RetrieveHubspotUserRecords
Retrieve HubSpot user records by ID or unique property. Use this tool to fetch HubSpot CRM user records by providing a record ID or specifying a custom unique value property with the `idProperty` parameter. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_only_archived_results | boolean | Optional | Specify True to return only results that have been archived. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/users/batch/read'.HubspotCrmApi.RetrieveInvoiceRecords
Retrieve invoice records by ID or custom property. Use this tool to obtain invoice records by specifying the record ID or using a custom unique value property. Ideal for accessing specific invoice data within the HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_only | boolean | Optional | Set to true to return only results that have been archived from HubSpot CRM. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/invoices/batch/read_read'.HubspotCrmApi.RetrieveInvoices
Retrieve a page of invoices from HubSpot CRM. Use this tool to read a page of invoices from HubSpot CRM. You can control the return data by specifying desired properties through the query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | A list of object types whose associated IDs should be retrieved. Ignored if associations do not exist. |
maximum_results_per_page | integer | Optional | The maximum number of invoice results to display per page. |
paging_cursor_token | string | Optional | The token for the last successfully read resource to retrieve the next page of results. |
properties_with_history | array<string> | Optional | List properties to return with their historical values. Reduced invoice limit per request. |
return_archived_only | boolean | Optional | Set to true to return only archived invoices; false for all invoices. |
specified_properties | array<string> | Optional | List of invoice property names to return. Ignored if properties are not present on the objects. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/invoices_getPage'.HubspotCrmApi.RetrieveLeadRecords
Retrieve lead records by ID or custom unique property. This tool fetches lead records from HubSpot CRM using specified record IDs or a custom unique value property if provided. It is useful for obtaining detailed information on leads based on specific identifiers. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_only | boolean | Optional | Return only results that have been archived. Set to 'true' to filter by archived records. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/leads/batch/read_read'.HubspotCrmApi.RetrieveLimitApproachingRecords
Retrieve objects nearing or at HubSpot CRM association limits. This tool is called to get objects from HubSpot CRM that have records close to or at their association limits. It helps in monitoring and managing association constraints.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/limits/associations/records/from'.HubspotCrmApi.RetrieveLineItemsPage
Retrieve a page of line items from HubSpot CRM. Use this tool to read a specific page of line items from HubSpot CRM. You can control the details returned using the `properties` query parameter to tailor the response to your needs.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | List of object types to retrieve associated IDs. Nonexistent associations are ignored. |
include_properties | array<string> | Optional | List the properties to include in the response, separated by commas. Ignored if not present. |
max_results_per_page | integer | Optional | Sets the maximum number of line items to display per page. |
pagination_cursor_after | string | Optional | The cursor token from the last page to retrieve the next set of results. |
properties_with_history | array<string> | Optional | A list of property names to return with their value history. This reduces the max line items per request. |
return_only_archived | boolean | Optional | Set to true to return only archived results. False returns non-archived results. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/line_items_getPage'.HubspotCrmApi.RetrieveMeetingRecords
Retrieve meeting records by ID or unique property. Use this tool to retrieve HubSpot CRM meeting records by specifying record IDs or a custom unique value property. It helps in accessing specific meeting details efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_only_archived_results | boolean | Optional | Set to true to retrieve only archived meeting records. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/meetings/batch/read_read'.HubspotCrmApi.RetrieveNotesPage
Retrieve a page of notes from HubSpot CRM. Use this tool to read a page of notes from HubSpot CRM. You can control the properties returned via query parameters.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
associated_object_types | array<string> | Optional | List of object types to retrieve associated IDs for. Non-existent associations will be ignored. |
paging_cursor_token | string | Optional | Token for paging to retrieve the next set of notes. Use the token from `paging.next.after` in the previous response. |
properties_with_history | array<string> | Optional | List of properties to return with their historical values. Reduces the maximum number of notes per request. |
results_per_page | integer | Optional | The maximum number of note results to display per page. Specify an integer value. |
return_only_archived_notes | boolean | Optional | Set to True to return only archived notes; otherwise, non-archived notes are returned. |
returned_properties_list | array<string> | Optional | List of note properties to include in the response. Specify as an array of strings. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/objects/notes_getPage'.HubspotCrmApi.RetrieveNotesRecords
Retrieve notes records by ID or custom property. This tool retrieves records from HubSpot CRM using either record IDs or a custom unique value property specified by the `idProperty` parameter. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_only | boolean | Optional | Set to true to return only archived records. Use false to include non-archived records. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/notes/batch/read_read'.HubspotCrmApi.RetrieveOwnerDetails
Retrieve details of a specific CRM owner by ID. This tool retrieves details of a specific owner in the HubSpot CRM using either their 'id' or 'userId'. Use it when you need comprehensive information about a particular CRM owner.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
owner_id | integer | Required | The unique ID of the CRM owner. Use this to retrieve the owner's details. |
include_archived | boolean | Optional | Set to true to include archived owners in the retrieved details. |
owner_id_type | string | Optional | Specify whether the 'ownerId' refers to an 'id' or 'userId'. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/owners/{ownerId}'.HubspotCrmApi.RetrieveOwnersList
Retrieve a list of owners from the HubSpot CRM account. Use this tool to obtain a paginated list of all owners available in a HubSpot CRM account. This can be useful for managing owner-related data or assignments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_email | string | Optional | Specify an email address to filter the list of owners returned. Only the owner with this exact email will be retrieved. |
include_archived | boolean | Optional | Set to true to include archived owners in the retrieved list. |
owners_list_limit | integer | Optional | The maximum number of owners to return per page. Provide an integer value. |
pagination_cursor_after | string | Optional | A cursor to get the next page of results, indicating the last result shown from the previous request. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/owners/'.HubspotCrmApi.RetrievePartnerServicesRecords
Retrieve partner services records by ID or unique property. This tool retrieves records for partner services using either a record ID or a custom unique value property. It is ideal for accessing specific partner service data within the HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_only_archived_records | boolean | Optional | Set to true to return only the archived records. False will include non-archived records. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/partner_services/batch/read'.HubspotCrmApi.RetrieveQuotesBatch
Retrieve multiple quotes by ID or custom property. This tool retrieves multiple quote records by their IDs or a custom unique value property. It should be called when you need to access specific quotes in batch format from the HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
archived_results_only | boolean | Optional | Specify `true` to return only archived results; `false` to include non-archived results. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/quotes/batch/read_read'.HubspotCrmApi.RetrieveSubscriptionRecords
Retrieve subscription records by ID or unique property. Use this tool to fetch subscription records from HubSpot CRM by providing record IDs or a custom unique value property. Ideal for accessing specific subscription details quickly. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
only_archived_records | boolean | Optional | Set to true to return only archived results. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/subscriptions/batch/read'.HubspotCrmApi.RetrieveTaxRecords
Retrieve tax records by ID or custom property. Use this tool to retrieve tax records by specifying record IDs or using a custom unique value property. It's useful when you need detailed tax information for specific records. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_only | boolean | Optional | Set to true to retrieve only archived records, false to exclude them. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/taxes/batch/read_read'.HubspotCrmApi.RetrieveTicketBatch
Retrieve a batch of tickets by ID or property value. Use this tool to fetch a batch of CRM tickets by providing their IDs or a specific unique property value. Ideal for obtaining detailed information about multiple tickets simultaneously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
return_archived_tickets_only | boolean | Optional | Set to true to return only archived tickets. If false, include non-archived tickets as well. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tickets/batch/read_read'.HubspotCrmApi.ScheduleListConversion
Schedule or update the conversion of an active list to static. Use this tool to schedule the conversion of an active list into a static list, or to update an already scheduled conversion. This can be scheduled for a specific date or based on activity in HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
list_id | string | Optional | The ID of the list you want to schedule the conversion for. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'put-/crm/v3/lists/{listId}/schedule-conversion'.HubspotCrmApi.SearchAppointments
Search for appointments based on specified criteria. Use this tool to search for appointments in the CRM by specifying various criteria. It is useful for finding specific appointments or lists based on search conditions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
appointment_search_criteria_type | string | Optional | Specify the type of object for the appointment search, such as 'appointments'. This determines the domain within the CRM to be searched. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/objects/v3/{objectType}/search'.HubspotCrmApi.SearchCallsHubspot
Search and filter call records in HubSpot CRM. Use this tool to search for calls in HubSpot CRM by applying filters on properties, searching through associations, and sorting the results. Ideal for retrieving specific call records from your HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/calls/search_doSearch'.HubspotCrmApi.SearchCommercePayments
Search for commerce payments in HubSpot CRM. Use this tool to search for commerce payments within the HubSpot CRM. It should be called when you need to retrieve payment information from the CRM database. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/commerce_payments/search'.HubspotCrmApi.SearchCompaniesInHubspot
Search for companies in HubSpot CRM using filters and sorting. This tool allows you to search for companies in HubSpot CRM by applying filters, associating searches, and sorting the results. It is useful for retrieving company information based on specific criteria quickly. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/companies/search_doSearch'.HubspotCrmApi.SearchContacts
Search contacts in HubSpot CRM. Use this tool to search for contacts within the HubSpot CRM. It is useful for retrieving contact information based on search criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/contacts/search'.HubspotCrmApi.SearchCrmLeads
Search for leads in HubSpot CRM. This tool searches for leads in the HubSpot CRM. Use it when you want to query and retrieve lead information based on specific criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/leads/search_doSearch'.HubspotCrmApi.SearchCrmMessages
Search and filter CRM messages based on various criteria. Use this tool to search for messages in the CRM by applying filters on properties, checking associations, and sorting the results. Ideal for retrieving specific communications data within the HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/communications/search_doSearch'.HubspotCrmApi.SearchCrmUsers
Perform a user search in the CRM database. Use this tool to search for users within the HubSpot CRM. It should be called when you need to retrieve user information based on specific criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/users/search'.HubspotCrmApi.SearchDeals
Search for deals using specified criteria and filters. This tool searches for deals in the HubSpot CRM using the provided criteria and filters. It should be called when there's a need to find deals that match specific conditions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-3/search_doSearch'.HubspotCrmApi.SearchDiscounts
Search for discounts in the HubSpot CRM. Use this tool to search for discount records in the HubSpot CRM. It is useful when you need to find specific discounts based on certain criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/discounts/search'.HubspotCrmApi.SearchEmails
Search for emails based on specified query parameters. Use this tool to perform a search for emails in the CRM system, returning results that match the given criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/emails/search_doSearch'.HubspotCrmApi.SearchFeedbackSubmissions
Search for feedback submissions in HubSpot CRM. This tool allows you to search for feedback submissions within the HubSpot CRM, helping you find specific feedback entries based on your search criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/feedback_submissions/search_doSearch'.HubspotCrmApi.SearchFeesInCrm
Search for fees in HubSpot CRM. Use this tool to search for fees in the HubSpot CRM database. It should be called when you need to find specific fee records based on search criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/fees/search'.HubspotCrmApi.SearchGoalTargets
Search for goal targets using specified criteria. This tool allows searching for goal targets within the HubSpot CRM based on specified criteria. Call this tool when you need to locate specific goal targets or retrieve a list based on certain parameters. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/goal_targets/search_doSearch'.HubspotCrmApi.SearchHubspotCarts
Search for carts in HubSpot CRM. This tool performs a search query to retrieve cart information from HubSpot CRM. It can be used to find specific carts using various search parameters. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/carts/search'.HubspotCrmApi.SearchHubspotListings
Search listings in HubSpot CRM using filters and properties. Use this tool to execute a search query in HubSpot CRM to find listings. You can specify various filters and properties to refine your search results. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-420/search'.HubspotCrmApi.SearchHubspotLists
Search HubSpot CRM lists by name or page through all lists. This tool allows searching for specific lists within the HubSpot CRM by list name. Alternatively, you can page through all lists by providing an empty query. It's useful for retrieving specific list data or browsing all available lists.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
filter_by_list_ids | array<string> | Optional | An array of list IDs to filter search results. If not provided or empty, no filter is applied. |
filter_by_processing_types | array<string> | Optional | List of processing types to filter results. Valid values: 'MANUAL', 'SNAPSHOT', 'DYNAMIC'. If omitted, no filtering by processing type is applied. |
include_additional_list_properties | array<string> | Optional | Specify additional list properties to include in the response. Defaults fetch standard properties like `hs_list_size` and others. |
number_of_lists_to_return | integer | Optional | The number of lists to include in the response. Defaults to 20 if not provided, with a maximum of 500. |
search_query | string | Optional | The term to search for lists by name. Returns all lists if empty. |
sort_order | string | Optional | Specify the order in which the lists should be sorted. Acceptable values could be 'asc' for ascending or 'desc' for descending order. |
start_offset | integer | Optional | The starting point for pagination of list results. Defaults to `0` if not provided. |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/lists/search_doSearch'.HubspotCrmApi.SearchHubspotMeetings
Search for meetings in HubSpot CRM. Use this tool to search for meetings stored in the HubSpot CRM. It should be called whenever there is a need to locate meetings based on specific criteria within the HubSpot platform. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/meetings/search_doSearch'.HubspotCrmApi.SearchHubspotNotes
Search for notes in HubSpot CRM. Use this tool to search for specific notes within HubSpot CRM. It should be called when you need to find and retrieve notes based on particular search criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/notes/search_doSearch'.HubspotCrmApi.SearchHubspotObjects
Perform a search on HubSpot CRM objects by type. Use this tool to search for objects in HubSpot CRM by specifying the object type. It helps in locating contacts, companies, deals, and other entities based on defined criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
object_type | string | Optional | Specify the type of object to search for in HubSpot, such as contacts, companies, or deals. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/{objectType}/search_doSearch'.HubspotCrmApi.SearchHubspotPayments
Search for payments in HubSpot CRM. Use this tool to search for specific payments within the HubSpot CRM. It should be called when you need to locate payments based on specific criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/payments/search'.HubspotCrmApi.SearchHubspotProducts
Search for products in HubSpot CRM. Use this tool to search for and retrieve product information from HubSpot CRM. It calls the endpoint designed to query products based on specified criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/products/search_doSearch'.HubspotCrmApi.SearchHubspotSubscriptions
Search for subscriptions in HubSpot CRM. Use this tool to search and retrieve details of specific subscriptions from HubSpot CRM based on given criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/subscriptions/search'.HubspotCrmApi.SearchHubspotTasks
Search for tasks in HubSpot CRM. Use this tool to search for tasks within HubSpot CRM. It should be called when you need to find specific tasks based on certain search criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tasks/search_doSearch'.HubspotCrmApi.SearchInvoices
Find invoices in the HubSpot CRM. Use this tool to search and retrieve invoices from the HubSpot CRM based on specific criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/invoices/search_doSearch'.HubspotCrmApi.SearchLineItems
Search for line items in HubSpot CRM. Use this tool to search for line items within HubSpot CRM. It should be called when you need to retrieve specific line items based on search criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/line_items/search_doSearch'.HubspotCrmApi.SearchOrderRecords
Search for order records in HubSpot CRM. This tool searches order records in HubSpot CRM based on specified criteria. It should be called when you need to find specific order details or filter orders according to certain conditions. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/orders/search'.HubspotCrmApi.SearchPartnerClients
Perform a search for partner clients in CRM. Use this tool to search for partner clients within the HubSpot CRM system. It should be called when you need to find specific partner client information or records based on search criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/partner_clients/search'.HubspotCrmApi.SearchPartnerServicesHubspot
Search for partner services in HubSpot CRM. Use this tool to perform a search for partner services within the HubSpot CRM. It can be called when you need to find specific partner services based on given criteria or parameters. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/partner_services/search'.HubspotCrmApi.SearchPostalMailHubspot
Search for postal mail objects in HubSpot CRM. Use this tool to search for postal mail records in HubSpot CRM based on specific criteria. This is useful when you need to retrieve details about postal interactions stored within the CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/postal_mail/search_doSearch'.HubspotCrmApi.SearchQuotesInHubspot
Search for quotes in HubSpot CRM. Use this tool to perform a search for quotes stored in HubSpot CRM. Useful for retrieving information about sales quotes based on specific criteria or parameters. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/quotes/search_doSearch'.HubspotCrmApi.SearchTaxes
Search for tax entries within HubSpot CRM. Use this tool to find specific tax records in HubSpot CRM based on search criteria. It returns relevant tax entries from the CRM database. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/taxes/search_doSearch'.HubspotCrmApi.SearchTickets
Search and filter CRM tickets based on properties and associations. Utilize this tool to search for tickets within the CRM by applying specific filters on properties, examining associations, and sorting the results. Ideal for retrieving detailed ticket information based on particular criteria. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tickets/search_doSearch'.HubspotCrmApi.SendEventToHubspot
Send event data to a specified HubSpot event type. This tool is used to send a single instance of event data to a specified event type in HubSpot CRM. It should be called when there's a need to submit event data to HubSpot for tracking or analysis. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/integrators/timeline/v3/events_create'.HubspotCrmApi.TranslateLegacyListIdsBatch
Translate legacy list IDs to new list IDs in batch. Use this tool to convert a large number (up to 10,000) of legacy list IDs to the current list ID format. This tool is essential for data migration purposes and is available until May 30th, 2025.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
legacy_list_ids | array<string> | Required | An array of legacy list IDs to be translated to new IDs, supporting up to 10,000 strings. |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/lists/idmapping_translateLegacyListIdToListIdBatch'.HubspotCrmApi.TranslateLegacyToNewListId
Translate legacy list ID to the new list ID format. This tool translates a legacy list ID to the new list ID format using HubSpot CRM's temporary API. It is useful for mapping old list IDs to new ones before the API expires on May 30th, 2025.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
legacy_list_id | string | Optional | The legacy list ID from the lists v1 API to be translated to the new format. |
Requirements
Output
json— Response from the API endpoint 'get-/crm/v3/lists/idmapping_translateLegacyListIdToListId'.HubspotCrmApi.UpdateBatchCalls
Update multiple calls in HubSpot CRM by ID. This tool updates a batch of call records in HubSpot CRM using their IDs. Use it to modify details of multiple calls efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/calls/batch/update_update'.HubspotCrmApi.UpdateBatchContacts
Update a batch of contacts in HubSpot CRM. Use this tool to update multiple contacts simultaneously in HubSpot CRM. It is helpful when you need to make changes to several contact records at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/contacts/batch/update'.HubspotCrmApi.UpdateBatchEmails
Update a batch of emails by their IDs or unique properties. Use this tool to update multiple emails in bulk using their internal IDs or unique property values in HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/emails/batch/update_update'.HubspotCrmApi.UpdateBatchFees
Update multiple fees by internal ID or unique properties. Use this tool to update a batch of fees in HubSpot CRM by specifying internal IDs or unique property values. Call this tool when you need to make bulk updates to fee records. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/fees/batch/update'.HubspotCrmApi.UpdateBatchGoalTargets
Update multiple goal targets in HubSpot CRM. Use this tool to update several goal targets simultaneously in HubSpot CRM using their internal IDs or unique property values. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/goal_targets/batch/update_update'.HubspotCrmApi.UpdateBatchOfCompanies
Update multiple company records in HubSpot by ID. This tool allows batch updating of company records in the HubSpot CRM. It should be called when there is a need to update information for multiple companies at once, using their unique IDs. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/companies/batch/update_update'.HubspotCrmApi.UpdateBatchTasks
Update a batch of tasks in HubSpot CRM. Use this tool to update multiple tasks in HubSpot CRM by their internal ID or unique property values. It should be called when you need to modify several tasks at once, such as changing task details or status across multiple entries. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tasks/batch/update_update'.HubspotCrmApi.UpdateBatchTaxes
Update taxes in batch using IDs or unique values. Call this tool to update multiple tax records at once in HubSpot CRM using either internal IDs or unique property values. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/taxes/batch/update_update'.HubspotCrmApi.UpdateCallInfo
Update details of a specific call record in the CRM. Use this tool to perform a partial update of a call object in the HubSpot CRM using its `{callId}` or a unique property. Only provided properties will be updated. Read-only and non-existent properties will cause errors. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
call_identifier | string | Optional | The identifier for the call object you wish to update. This can be the internal call ID or a unique value defined by the `idProperty`. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of a unique property for identifying the call object, other than the default ID. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/calls/{callId}_update'.HubspotCrmApi.UpdateCartProperties
Update specific properties of a cart in HubSpot CRM. This tool updates specified properties of a cart identified by `cartId` within HubSpot CRM. It's used to perform partial updates, where provided property values are overwritten, and any attempt to modify read-only or non-existent properties will result in an error. Properties can be cleared by passing an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
cart_identifier | string | Optional | The unique identifier of the cart to be updated. This is required to specify which cart's properties will be modified. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_identifier_property | string | Optional | The name of the property with unique values for this cart object to identify it. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/carts/{cartId}'.HubspotCrmApi.UpdateCartsBatch
Update a batch of carts by internal ID or unique properties. Use this tool to update multiple carts in HubSpot CRM by their internal IDs or unique property values. Useful for synchronizing cart information in bulk. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/carts/batch/update'.HubspotCrmApi.UpdateCommercePayment
Partially update a commerce payment by ID or unique property. Use this tool to perform a partial update of a commerce payment object identified by its internal ID or a unique property specified by `idProperty`. Ensure provided property values exist and are not read-only; this will overwrite them. To clear a value, pass an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
commerce_payment_id | string | Optional | The internal ID of the commerce payment to update. This ID identifies the specific payment object within the system. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of a unique property for identifying the object. Use this if not using the default internal ID. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/commerce_payments/{commercePaymentId}'.HubspotCrmApi.UpdateCommercePaymentsBatch
Update a batch of commerce payments by internal ID or unique values. Use this tool to update multiple commerce payments in HubSpot CRM by providing their internal IDs or unique property values, allowing for efficient bulk modifications. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/commerce_payments/batch/update'.HubspotCrmApi.UpdateCommunicationDetails
Update communication object details in HubSpot CRM. Perform a partial update of a HubSpot CRM communication object using its `communicationId` or a unique property value. This tool overwrites provided property values, with errors for read-only or non-existent properties. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
communication_id | string | Optional | The internal object ID of the communication. Used to identify which communication object to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The unique property name used to identify the communication object if not using `communicationId`. It must refer to a property with unique values for the object. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/communications/{communicationId}_update'.HubspotCrmApi.UpdateContactInformation
Update specific fields of a contact in HubSpot CRM. Use this tool to perform a partial update of a contact's information in HubSpot CRM. Identify the contact by `{contactId}` and specify fields to update. Properties not intended for update are ignored. Pass an empty string to clear values. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
contact_id | string | Optional | The unique ID or property value used to identify the contact for the update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | Specify the property name with unique values for identifying the contact, such as email or phone number. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/contacts/{contactId}'.HubspotCrmApi.UpdateCoursesBatch
Update multiple courses in a batch by ID or unique properties. Use this tool to update a batch of courses in the CRM system by specifying their internal IDs or unique property values. This is useful for making bulk updates efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-410/batch/update'.HubspotCrmApi.UpdateCrmObjectSchema
Update a CRM object's schema in HubSpot. This tool updates the schema of a specified CRM object type in HubSpot. Call this tool when you need to modify the structure or attributes of an existing CRM object schema.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type_identifier | string | Required | Fully qualified name or object type ID of your CRM schema for updates. |
clear_description | boolean | Optional | Set to true to clear the description field for the object type schema. |
object_description | string | Optional | A description for the CRM object schema, providing details about its purpose or usage in HubSpot. |
object_singular_name | string | Optional | The word representing a single object. This cannot be changed later. |
plural_labels | string | Optional | Specify the word representing multiple instances of the object type. This value is permanent and cannot be changed after setting. |
primary_display_property | string | Optional | The primary property's name for this object, displayed prominently on the HubSpot record page. |
required_properties | array<string> | Optional | List of property names that must be provided when creating an object of this type in HubSpot. |
restorable | boolean | Optional | Indicates if the object can be restored after deletion. Accepts a boolean value. |
searchable_properties | array<string> | Optional | List of property names to be indexed for HubSpot's product search, enhancing searchability of the CRM object type. |
secondary_display_properties | array<string> | Optional | Names of secondary properties displayed on the HubSpot record page for this object type. |
Requirements
Output
json— Response from the API endpoint 'patch-/crm-object-schemas/v3/schemas/{objectType}_update'.HubspotCrmApi.UpdateDiscountDetails
Update specific properties of a discount in HubSpot CRM. Use this tool to perform a partial update on a discount object in HubSpot CRM. Specify the discount using its internal ID or by a unique property using `idProperty`. Only overwrite existing properties. Errors occur with read-only or non-existent properties. Clear properties by passing an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
discount_identifier | string | Optional | The unique identifier for the discount object. This can be the internal ID or a unique property specified by `idProperty`. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of a unique property to identify the discount object. Use this instead of the internal discount ID if needed. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/discounts/{discountId}'.HubspotCrmApi.UpdateDiscountsBatch
Update multiple discounts by ID or unique properties. Use this tool to update a batch of discounts in HubSpot CRM by specifying internal IDs or unique property values. It is suitable for scenarios where multiple discount records need to be updated simultaneously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/discounts/batch/update'.HubspotCrmApi.UpdateEmailInHubspotCrm
Updates an email object in HubSpot CRM with new property values. This tool updates properties of an email object in HubSpot CRM, identified by the internal ID or a unique property. Read-only or nonexistent properties will cause errors, and properties can be cleared by passing an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
email_identifier | string | Optional | The unique identifier for the email object, either the internal ID or a unique property value. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | Name of a unique property for identifying the email object, used instead of default ID. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/emails/{emailId}_update'.HubspotCrmApi.UpdateFeeDetails
Update specific details of a fee in the CRM. This tool performs a partial update of a fee record identified by its internal ID or another unique property. Use it to overwrite existing property values or clear them by passing an empty string. Be aware that read-only or non-existent properties will cause an error. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
fee_identifier | string | Optional | The ID or unique property value that identifies the fee object to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | Specify the unique property name to identify the object instead of the default ID. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/fees/{feeId}'.HubspotCrmApi.UpdateGoalTarget
Update properties of a HubSpot goal target. Use this tool to perform a partial update on a HubSpot goal target object using its ID or a unique property. This is useful for editing specific properties of a goal target. Ensure only modifiable properties are included, as read-only or non-existent properties will cause errors. Clear properties by passing an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
goal_target_id | string | Optional | The internal ID of the goal target to update. Use this to specify which goal target object to modify. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of a unique property for the goal target object used for identification or update. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/goal_targets/{goalTargetId}_update'.HubspotCrmApi.UpdateHubspotCompany
Update a company's details in HubSpot CRM using its ID. Use this tool to update a company's information in HubSpot CRM by specifying the `companyId` or a unique property. Only existing and writable properties can be updated. Properties can be cleared by passing an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
company_unique_identifier | string | Optional | The unique identifier for the company to be updated, either the companyId or a unique property value. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | Specify the name of the unique property used to identify the company. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/companies/{companyId}_update'.HubspotCrmApi.UpdateHubspotCourse
Update specific properties of a HubSpot course object. Use this tool to perform a partial update on a course object in HubSpot CRM. Update is identified by either the `{courseId}` or a unique property via `idProperty`. Only properties provided will be changed, while read-only or non-existent properties will cause an error. Properties can be cleared by providing an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
course_identifier | string | Optional | The unique identifier for the HubSpot course. It can be the internal course ID or a unique property value specified by `idProperty`. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The property name with unique values for identifying the object to update. Use it if not using `courseId`. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/0-410/{courseId}'.HubspotCrmApi.UpdateHubspotDeal
Update a specific deal in HubSpot CRM. Use this tool to perform a partial update on a deal in HubSpot CRM by specifying the deal's internal ID or a unique property value. Only existing properties can be updated, and read-only properties will not be accepted. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
deal_identifier | string | Optional | The unique identifier of the deal to be updated in HubSpot CRM. Can be internal ID or unique property value. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of a unique property to identify the deal instead of `dealId`. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/0-3/{dealId}_update'.HubspotCrmApi.UpdateHubspotMeeting
Update specific properties of a HubSpot meeting. Use this tool to perform a partial update on a HubSpot CRM meeting object. Identify the meeting using `{meetingId}` or a unique property with `idProperty`. Overwrite specified property values, but note that read-only or non-existent properties will cause an error. Properties can be cleared by sending an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
meeting_id | string | Optional | The internal ID of the meeting or a property name with unique values for identification. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of the unique property for identifying the meeting. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/meetings/{meetingId}_update'.HubspotCrmApi.UpdateHubspotNote
Update a HubSpot note with new property values. Use this tool to update specific properties of a HubSpot CRM note. Identify the note by its ID or a unique property value and provide new values for properties you wish to change. Read-only and non-existent properties cannot be updated. Clear properties by passing an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
note_identifier | string | Optional | The ID or unique property value of the note to update. Use `noteId` for internal ID or specify a unique property via `idProperty`. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of a property with unique values for this object, used to identify the note. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/notes/{noteId}_update'.HubspotCrmApi.UpdateHubspotObject
Update specific properties of a HubSpot CRM object. This tool performs a partial update of an object in HubSpot CRM, identified by the internal object ID or a unique property value. It overwrites provided property values, errors out on read-only or non-existent properties, and allows clearing values by passing an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
object_type | string | Optional | The type of CRM object to update (e.g., contacts, companies). Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
object_identifier | string | Optional | A string representing the internal object ID or unique property value used to identify the HubSpot CRM object for updating. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of a property whose values are unique for the object, used to identify the object for the update. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/objects/v3/{objectType}/{objectId}'.HubspotCrmApi.UpdateHubspotObjectsBatch
Update multiple HubSpot CRM objects in a batch. Use this tool to update a batch of objects in HubSpot CRM using internal IDs or unique property values. Useful for synchronizing or modifying multiple CRM records at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
object_type | string | Optional | The type of HubSpot CRM object to update, such as 'contacts', 'companies', 'deals', or 'tickets'. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/{objectType}/batch/update_update'.HubspotCrmApi.UpdateHubspotOrdersBatch
Update multiple HubSpot CRM orders in a batch. Use this tool to update a batch of orders in HubSpot CRM by their internal ID or unique property values. Useful for modifying multiple order records at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/orders/batch/update'.HubspotCrmApi.UpdateHubspotProductsBatch
Update a batch of HubSpot products by ID or unique properties. Use this tool to update multiple products in HubSpot CRM with new details by internal IDs or unique property values. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/products/batch/update_update'.HubspotCrmApi.UpdateHubspotTask
Update properties of a HubSpot task using its ID. This tool allows partial updates to a task in HubSpot CRM by specifying a `{taskId}` or a unique property defined by `idProperty`. It overwrites specified properties, with read-only and non-existent properties triggering errors. To clear a property, pass an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
task_identifier | string | Optional | The internal ID or unique property name of the task to update. Defaults to internal ID. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | Specify the name of the property with unique values. Used for identifying the object instead of `taskId`. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/tasks/{taskId}_update'.HubspotCrmApi.UpdateHubspotUser
Update user details in HubSpot CRM. This tool updates specific user information in HubSpot CRM for a given user ID or a unique property value if specified. Use this tool when you need to modify or clear user property values, bearing in mind read-only and non-existent properties will cause errors. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
user_id | string | Optional | The internal user ID or unique property value to identify the user for updating. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | Specifies the name of a property with unique values for identifying the user object. Use this if not using userId. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/users/{userId}'.HubspotCrmApi.UpdateInvoiceDetails
Update invoice details in HubSpot CRM. Use this tool to perform a partial update of an invoice in HubSpot CRM. The invoice can be identified by its internal ID or a unique property. Only existing properties with provided values will be updated, and any read-only or non-existent properties will cause an error. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
invoice_identifier | string | Optional | Unique identifier for the invoice, either the internal ID or specified unique property value, to update in HubSpot CRM. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | Name of the unique property for identifying the invoice object. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/invoices/{invoiceId}_update'.HubspotCrmApi.UpdateInvoicesBatch
Updates multiple invoices in the HubSpot CRM. This tool updates a batch of invoices in HubSpot CRM using either internal IDs or unique property values. It should be called when you need to modify multiple invoice records simultaneously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/invoices/batch/update_update'.HubspotCrmApi.UpdateLeadDetails
Update details of a specific lead in HubSpot CRM. Use this tool to perform a partial update to the details of a specific lead in the HubSpot CRM. You can specify the lead using their internal object ID or a unique property value. Only provided properties will be updated. This tool should be called when you need to update certain fields of a lead without altering others. Ensure that read-only and non-existent properties are not included, as these will result in an error. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
lead_identifier | string | Optional | The internal object ID or unique property value used to identify the lead in HubSpot CRM. Required for updating the lead details. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | Specify the name of a unique property to identify the lead, instead of using the internal ID. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/leads/{leadsId}_update'.HubspotCrmApi.UpdateLeadsBatch
Update multiple leads in a batch by ID or unique properties. Use this tool to update a set of leads in HubSpot CRM using their internal IDs or unique property values. This is useful for making bulk changes efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/leads/batch/update_update'.HubspotCrmApi.UpdateLineItem
Update properties of a CRM line item using its ID. Use this tool to perform a partial update of a CRM line item identified by its internal ID or a unique property value. Only provided properties will be updated, and passing an empty string can clear property values. Make sure not to include read-only or non-existent properties as they will result in errors. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
line_item_id | string | Optional | The internal ID of the line item to update. This ID identifies the object to be modified. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | Specify a property with unique values to identify the line item instead of using the internal ID. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/line_items/{lineItemId}_update'.HubspotCrmApi.UpdateLineItemsBatch
Update multiple line items in CRM using internal IDs or unique properties. This tool updates a batch of line items in HubSpot CRM. It's useful when needing to modify multiple line items at once using their internal IDs or unique property values. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/line_items/batch/update_update'.HubspotCrmApi.UpdateListMemberships
Add or remove records from a manual or snapshot list. This tool is used to add and/or remove records from a manual or snapshot list in the HubSpot CRM. It facilitates managing list memberships by updating existing records according to specified changes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_identifier | string | Required | The unique ILS ID of the MANUAL or SNAPSHOT list to update. |
record_ids_to_add | array<string> | Required | An array of record IDs to be added to the specified list. Ensure these records are already created in the system. |
record_ids_to_remove | array<string> | Required | An array of record IDs to remove from the list. Each ID should be a string. |
Requirements
Output
json— Response from the API endpoint 'put-/crm/v3/lists/{listId}/memberships/add-and-remove_addAndRemove'.HubspotCrmApi.UpdateListName
Update the name of a CRM list in HubSpot. Call this tool to update the name of a CRM list in HubSpot, ensuring the new name is globally unique.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
list_id | string | Required | The unique ILS ID of the list to update. |
include_filter_branch_definition | boolean | Optional | Set to true to include filter branch definitions in the response list definition, or false to exclude them. |
new_list_name | string | Optional | The new name for the CRM list. It must be globally unique relative to other public lists. |
Requirements
Output
json— Response from the API endpoint 'put-/crm/v3/lists/{listId}/update-list-name_updateName'.HubspotCrmApi.UpdateMeetingsBatch
Update a batch of meetings in HubSpot CRM. This tool updates multiple meetings in HubSpot CRM using internal IDs or unique property values. It should be called when you need to modify details for several meetings at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/meetings/batch/update_update'.HubspotCrmApi.UpdateMessagesBatch
Update a batch of messages in HubSpot CRM. Use this tool to update multiple messages at once in HubSpot CRM by specifying either the communication ID or a unique property value. Only provided property values will be updated, and non-existent properties or read-only fields will cause errors. Include empty strings to clear properties. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/communications/batch/update_update'.HubspotCrmApi.UpdateMultipleCrmListings
Update multiple CRM listings using internal IDs or unique properties. This tool updates multiple listings in the CRM using their internal IDs or unique property values. It should be called when there is a need to modify several records in bulk within the CRM system. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-420/batch/update'.HubspotCrmApi.UpdateMultipleDeals
Update multiple deals in the CRM system. This tool updates multiple deals using their internal IDs or unique property values in the CRM. It should be called when you need to modify several deals at once within the HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-3/batch/update_update'.HubspotCrmApi.UpdateMultipleHubspotAppointments
Update multiple appointments in HubSpot CRM. Use this tool to update multiple appointments by their internal IDs or unique property values within HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
hubspot_object_type | string | Optional | Specify the type of HubSpot CRM object to update, e.g., 'appointments'. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/objects/v3/{objectType}/batch/update'.HubspotCrmApi.UpdateMultiplePostalMails
Update multiple postal mail records at once in HubSpot CRM. Use this tool to update several postal mail objects within HubSpot CRM in a single request, streamlining batch modifications. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/postal_mail/batch/update_update'.HubspotCrmApi.UpdateMultipleUsers
Update multiple users in HubSpot CRM by internal ID or unique properties. This tool updates a batch of users in HubSpot CRM using either their internal IDs or unique property values. Use this tool to efficiently update information for multiple users at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/users/batch/update'.HubspotCrmApi.UpdateOrCreateHubspotRecords
Create or update HubSpot CRM records in bulk. This tool is used to batch upsert records in HubSpot CRM based on a unique identifier. It's ideal for managing large datasets where records may need to be created or updated if they already exist. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
crm_object_type | string | Optional | Specifies the type of CRM object to act upon, such as 'contacts', 'companies', etc. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/{objectType}/batch/upsert'.HubspotCrmApi.UpdateOrderDetails
Update specific details of an order using its ID. This tool performs a partial update of an order in HubSpot CRM, identified by the order's internal ID or a unique property value. Use it to modify existing order properties; read-only or non-existent properties cannot be updated and will cause errors. Properties can be cleared by providing empty values. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
order_id | string | Optional | The internal ID of the order to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | Specify the name of a unique property to identify the order object instead of using the order ID. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/orders/{orderId}'.HubspotCrmApi.UpdatePartnerClient
Update details of a partner client in HubSpot CRM. This tool is used to modify the information of a specified partner client in HubSpot CRM. It should be called when there is a need to update or change details related to a partner client using their unique ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
partner_client_id | string | Optional | The unique identifier for the partner client to be updated in HubSpot CRM. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
identifier_property | string | Optional | Specify the property name used to identify the partner client for update operations. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/partner_clients/{partnerClientId}'.HubspotCrmApi.UpdatePartnerClientsBatch
Update multiple partner clients in a batch. Use this tool to update information for multiple partner clients simultaneously in HubSpot CRM. It should be called when you need to make bulk updates to partner client records. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/partner_clients/batch/update'.HubspotCrmApi.UpdatePartnerService
Partially update a partner service object in HubSpot CRM. Use this tool to update specific properties of a partner service object identified by `partnerServiceId` in HubSpot CRM. You can also use a unique property value specified by `idProperty`. Only existing, non-read-only properties can be updated. To clear a property, pass an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
partner_service_id | string | Optional | The internal object ID of the partner service to update. Use this to specify the object you want to partially update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | Specify the name of a unique property for the partner service object to identify it. This is used instead of the default internal ID. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/partner_services/{partnerServiceId}'.HubspotCrmApi.UpdatePartnerServicesBatch
Update multiple partner services in CRM by ID or unique properties. Use this tool to update a batch of partner services in the HubSpot CRM using internal IDs or unique property values. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/partner_services/batch/update'.HubspotCrmApi.UpdatePipelineInCrm
Partially update a pipeline in the CRM. Use this tool to perform a partial update of a pipeline identified by its pipeline ID within a specified object type in the CRM. The tool will return the updated pipeline details.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
crm_object_type | string | Required | Specify the type of CRM object (e.g., deals, tickets) to update the pipeline for. |
pipeline_identifier | string | Required | The unique identifier for the pipeline to be updated. This is required to specify which pipeline to modify. |
is_pipeline_archived | boolean | Optional | Set to true if the pipeline is currently archived and you intend to restore it. Use only for restoration calls. |
pipeline_display_order | integer | Optional | The display order number to determine the position of the pipeline in the CRM. Pipelines with the same display order are sorted alphabetically by label. |
pipeline_label | string | Optional | A unique label to organize and identify the pipeline within HubSpot's UI. |
validate_deal_stage_usages_before_delete | boolean | Optional | Indicate if deal stage usages should be validated before deletion. A boolean value is expected. |
validate_references_before_deletion | boolean | Optional | Set to true to validate references before deletion. |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/pipelines/{objectType}/{pipelineId}_update'.HubspotCrmApi.UpdatePipelineStage
Update a stage in a CRM pipeline. Use this tool to update the details of a specific stage within a CRM pipeline. It is useful when you need to modify the attributes of a pipeline stage, such as its name or order, to reflect changes in the sales or business process. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
pipeline_object_type | string | Optional | The type of CRM object in the pipeline, such as 'deals' or 'tickets'. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
pipeline_id | string | Optional | A unique identifier for the pipeline to be updated. This is necessary to specify which pipeline contains the stage you want to modify. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
stage_id | string | Optional | The unique identifier of the stage to be updated within the pipeline. This is required to specify which stage's details need modification. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}_update'.HubspotCrmApi.UpdatePostalMailRecord
Update a postal mail record in HubSpot CRM. Use this tool to update an existing postal mail record in HubSpot CRM by specifying the postalMailId of the record to be updated. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
postal_mail_id | string | Optional | A unique identifier for the postal mail record to be updated in HubSpot CRM. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
property_identifier | string | Optional | Specify the property key of the postal mail record to identify which field to update. This is typically the name of the field in the CRM record. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/postal_mail/{postalMailId}_update'.HubspotCrmApi.UpdateProductInfo
Partially update product information in HubSpot CRM. This tool updates specific properties of a product identified by `productId` in HubSpot CRM. It will override existing property values, and returning errors for read-only or non-existent properties. Use when you need to modify product attributes such as name, price, or description. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
product_id | string | Optional | The internal object ID of the product to be updated. This identifies the specific product in HubSpot CRM for the update operation. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The unique property name used to identify the product. It should be a string representing a property with unique values. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/products/{productId}_update'.HubspotCrmApi.UpdatePropertyGroup
Update fields in a specified property group. This tool performs a partial update on a property group identified by {groupName} in HubSpot CRM. It overwrites the provided fields in the property group. Useful for modifying specific attributes within a property group without altering the entire group.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
object_type | string | Required | Specifies the type of object in HubSpot CRM (e.g., contacts, companies). |
property_group_name | string | Required | The unique name of the property group to be updated in HubSpot CRM. |
property_group_display_order | integer | Optional | Set the display order of the property group. Use positive integers for ordering, or -1 to display after positive values. |
property_group_label | string | Optional | A human-readable label for the property group in HubSpot. |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/properties/{objectType}/groups/{groupName}'.HubspotCrmApi.UpdatePropertyValue
Update specific fields of a CRM property partially. Use this tool to partially update specific fields of a CRM property identified by its name. Only the specified fields will be overwritten. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
crm_object_type | string | Optional | Specify the type of CRM object (e.g., 'contacts', 'deals') to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
property_identifier | string | Optional | The unique name of the CRM property to be updated. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/properties/{objectType}/{propertyName}'.HubspotCrmApi.UpdateQuoteBatch
Update a batch of quotes using internal ID or property values. Use this tool to update multiple quotes at once in the CRM. It should be called when you need to modify details of several quotes by their internal IDs or unique property values. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/quotes/batch/update_update'.HubspotCrmApi.UpdateQuoteInformation
Update a quote's details in HubSpot CRM. Use this tool to perform a partial update of a quote in HubSpot CRM identified by `quoteId` or a unique property value. It allows overwriting specific property values, but read-only or invalid properties will cause an error. Properties can be cleared by passing an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
quote_identifier | string | Optional | The identifier of the quote to be updated. This can be the internal ID or a unique property value specified by `idProperty`. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of a property with unique values for identifying the quote object. Used instead of `quoteId`. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/quotes/{quoteId}_update'.HubspotCrmApi.UpdateServicesBatch
Update multiple service records in HubSpot CRM. Use this tool to update a batch of service records in the HubSpot CRM by their internal IDs or unique property values. Suitable for synchronizing or modifying multiple records efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/0-162/batch/update'.HubspotCrmApi.UpdateSubscription
Update subscription details using provided property values. Use this tool to perform a partial update of a subscription object in HubSpot CRM. Identify the object by its internal ID or a unique property value using the `idProperty` query parameter. Overwrite properties by providing new values; clear them by passing an empty string. Errors occur for read-only or non-existent properties. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
subscription_id | string | Optional | The identifier for the subscription to update, typically the internal object ID. Specify this to target the right subscription. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of a unique property to identify the subscription object for updating. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/subscriptions/{subscriptionId}'.HubspotCrmApi.UpdateSubscriptionBatch
Update multiple subscriptions by ID or property values. This tool updates a batch of subscriptions using their internal IDs or unique property values in HubSpot CRM. Use it when you need to modify details for multiple subscriptions simultaneously. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/subscriptions/batch/update'.HubspotCrmApi.UpdateTaxObject
Update properties of a tax object in HubSpot CRM. This tool updates specified properties of a tax object in HubSpot CRM using its ID or a unique property value. It's used to perform partial updates where only certain fields need modification. Fields to be updated are specified in the request, and read-only or non-existent fields will cause errors. To clear a property, pass an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
tax_object_identifier | string | Optional | The identifier for the tax object. Use the internal `taxId` by default or provide a unique property value specified by the `idProperty`. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of a property uniquely identifying this tax object. Used instead of `taxId` if specified. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/taxes/{taxId}_update'.HubspotCrmApi.UpdateTicketBatch
Update multiple tickets in HubSpot CRM by ID or property. This tool updates a batch of tickets in the HubSpot CRM using their IDs or a unique property value. Use it when you need to modify several tickets at once. Properties that are read-only or non-existent will cause an error, and providing an empty string will clear a property value. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tickets/batch/update_update'.HubspotCrmApi.UpdateTicketInfo
Partially update ticket details in HubSpot CRM. Use this tool to perform a partial update on a ticket identified by its `{ticketId}` or a unique property value specified by `idProperty` in HubSpot CRM. Read-only and non-existent properties will cause errors. Clear property values by passing an empty string. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path, query parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path, query parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
ticket_id | string | Optional | The internal ID of the ticket to be updated. This is used to identify the specific ticket in HubSpot CRM. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
unique_property_name | string | Optional | The name of a property whose values are unique for the ticket object. Specify if not using the default ticket ID. Only used when mode is 'execute'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'patch-/crm/v3/objects/tickets/{ticketId}_update'.HubspotCrmApi.UploadCallTranscripts
Upload call transcripts to HubSpot CRM. Use this tool to upload call transcripts to HubSpot CRM. It should be called when you need to store transcripts for CRM purposes. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/extensions/calling/transcripts'.HubspotCrmApi.UpsertCallRecords
Create or update call records in HubSpot CRM. This tool allows you to create or update call records in HubSpot CRM. It uses a unique property value specified by the `idProperty` query parameter to identify records that need to be updated or created. Use this tool when you need to batch upsert call records. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/calls/batch/upsert_upsert'.HubspotCrmApi.UpsertCartRecords
Create or update cart records in HubSpot CRM. Use this tool to create or update cart records based on a unique property value specified by the `idProperty`. Ideal for managing cart data in bulk within the HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/carts/batch/upsert'.HubspotCrmApi.UpsertCommercePayments
Create or update unique commerce payment records in HubSpot. Use this tool to create new commerce payment records or update existing ones in HubSpot CRM. The tool identifies records by a unique property value specified by the `idProperty` query parameter. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/commerce_payments/batch/upsert'.HubspotCrmApi.UpsertCommunicationsRecords
Create or update communication records in bulk. This tool allows you to batch create or update communication records in HubSpot CRM based on a unique property value. Utilize this tool when you need to synchronize communication data and ensure records are accurately up-to-date. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/communications/batch/upsert_upsert'.HubspotCrmApi.UpsertContactBatch
Upsert a batch of contacts in HubSpot CRM. This tool is used to upsert a batch of contacts in HubSpot CRM. It allows you to define property values for each contact record, making it ideal for updating or creating multiple contacts at once. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/contacts/batch/upsert'.HubspotCrmApi.UpsertCrmTickets
Create or update CRM tickets in bulk using unique identifiers. This tool allows you to create or update ticket records in HubSpot CRM by using a unique identifier specified through the `idProperty` query parameter. This is useful for ensuring ticket data is up-to-date or for adding new ticket entries in bulk. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tickets/batch/upsert_upsert'.HubspotCrmApi.UpsertDiscountRecords
Create or update discount records in HubSpot CRM. This tool allows the creation or update of discount records in HubSpot CRM using unique property values specified by the `idProperty` query parameter. It is useful for ensuring that discount data is up-to-date and accurately maintained. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/discounts/batch/upsert'.HubspotCrmApi.UpsertGoalTargets
Create or update goal target records in HubSpot CRM. This tool allows creation or updating of goal target records in HubSpot CRM using a unique property for identification. Use it to ensure goal targets are up-to-date. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/goal_targets/batch/upsert_upsert'.HubspotCrmApi.UpsertHubspotFees
Create or update fee records in HubSpot CRM. This tool should be called to create new fee records or update existing ones in HubSpot CRM. It uses a unique property value specified by the `idProperty` query parameter to identify records. Ideal for batch processing of fee information. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/fees/batch/upsert'.HubspotCrmApi.UpsertHubspotInvoices
Create or update HubSpot invoice records in batch. This tool creates or updates HubSpot invoice records using a unique property identifier specified by the `idProperty` parameter. It should be called when you need to ensure invoice records are accurately reflected in HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/invoices/batch/upsert_upsert'.HubspotCrmApi.UpsertHubspotProductsBatch
Batch create or update HubSpot product records. This tool is used to create or update HubSpot product records in bulk, identified by a unique property value specified by the `idProperty`. It should be called when there's a need to synchronize or modify multiple product entries in the HubSpot CRM. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/products/batch/upsert_upsert'.HubspotCrmApi.UpsertHubspotRecords
Create or update HubSpot CRM records in batch mode. Use this tool to create or update records in HubSpot CRM by specifying a unique property value. The `idProperty` parameter helps identify records uniquely for batch operations. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
object_type | string | Optional | The type of object in HubSpot CRM (e.g., contacts, companies) to create or update. Specify the object type relevant to your operation. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/objects/v3/{objectType}/batch/upsert'.HubspotCrmApi.UpsertHubspotTasks
Create or update tasks in HubSpot using a unique property. This tool creates or updates HubSpot CRM tasks identified by a unique property value specified by the `idProperty` query parameter. Use this tool when you need to batch upsert tasks based on unique identifiers. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/tasks/batch/upsert_upsert'.HubspotCrmApi.UpsertHubspotUsers
Create or update user records in HubSpot CRM. This tool is used to create or update user records in HubSpot CRM by specifying a unique property value through the `idProperty` query parameter. It is helpful for maintaining and synchronizing user data in HubSpot. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/users/batch/upsert'.HubspotCrmApi.UpsertLineItemsBatch
Batch create or update line items by unique ID. This tool creates or updates line item records in batches using a unique property to identify each item, as specified by the `idProperty` query parameter. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/line_items/batch/upsert_upsert'.HubspotCrmApi.UpsertMeetings
Create or update meeting records in HubSpot CRM. Use this tool to create new meetings or update existing ones in HubSpot CRM by specifying a unique identifier for each record. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/meetings/batch/upsert_upsert'.HubspotCrmApi.UpsertNotesHubspot
Create or update notes in HubSpot CRM by unique property. This tool is used to create or update multiple notes in HubSpot CRM in a single request. It identifies records using a unique property value specified by the `idProperty` query parameter. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/notes/batch/upsert_upsert'.HubspotCrmApi.UpsertOrdersInHubspot
Create or update orders in HubSpot CRM. This tool calls the HubSpot CRM API to create or update multiple order records based on a unique property value. Use it when you need to batch insert or update orders by specifying a unique identifier for each order. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/orders/batch/upsert'.HubspotCrmApi.UpsertPostalMailInHubspot
Create or update postal mail records in HubSpot CRM. This tool creates or updates postal mail records in HubSpot CRM based on a unique property value specified by the `idProperty` query parameter. Use it to ensure postal mail records are up-to-date and accurately maintained. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/postal_mail/batch/upsert_upsert'.HubspotCrmApi.UpsertSubscriptionsInHubspotCrm
Batch create or update subscription records in HubSpot CRM. Use this tool to create or update subscription records based on a unique property value in HubSpot CRM. It's ideal for ensuring your subscription data is up-to-date by specifying an `idProperty` for uniquely identifying existing records. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'post-/crm/v3/objects/subscriptions/batch/upsert'.