HubSpot Batch API
Batch operations for subscriptions
HubSpot Batch API is one of 93 APIs that HubSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 652 JSON Schema definitions.
Tagged areas include Batch. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, and 652 JSON Schemas.
This API exposes 28 operations across 28 paths, and defines 53 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.
Requests are made against a single base URL, https://api.hubapi.com.
28 operations
28 paths
53 schemas
28 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
HubSpot Batch API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.
Paths & Operations 28
Across 28 paths, the API surfaces 28 operations — 28 POST. Each is listed below with its method, path, parameters, and response codes.
Batch 28
Batch operations for subscriptions
POST
/crm/v3/objects/subscriptions/batch/read
Hubspot Batch Read Subscriptions
POST
/crm/v3/objects/subscriptions/batch/create
Hubspot Batch Create Subscriptions
POST
/crm/v3/objects/subscriptions/batch/update
Hubspot Batch Update Subscriptions
POST
/crm/v3/objects/companies/batch/read
Hubspot Batch Read Companies
POST
/crm/v3/objects/companies/batch/create
Hubspot Batch Create Companies
POST
/crm/v3/objects/companies/batch/update
Hubspot Batch Update Companies
POST
/crm/v3/objects/companies/batch/archive
Hubspot Batch Archive Companies
POST
/crm/v3/objects/contacts/batch/read
Hubspot Batch Read Contacts
POST
/crm/v3/objects/contacts/batch/create
Hubspot Batch Create Contacts
POST
/crm/v3/objects/contacts/batch/update
Hubspot Batch Update Contacts
POST
/crm/v3/objects/contacts/batch/archive
Hubspot Batch Archive Contacts
POST
/crm/v3/objects/deals/batch/read
Hubspot Batch Read Deals
POST
/crm/v3/objects/deals/batch/create
Hubspot Batch Create Deals
POST
/crm/v3/objects/deals/batch/update
Hubspot Batch Update Deals
POST
/crm/v3/objects/deals/batch/archive
Hubspot Batch Archive Deals
POST
/crm/v3/objects/tickets/batch/read
Hubspot Batch Read Tickets
POST
/crm/v3/objects/tickets/batch/create
Hubspot Batch Create Tickets
POST
/crm/v3/objects/tickets/batch/update
Hubspot Batch Update Tickets
POST
/crm/v3/objects/tickets/batch/archive
Hubspot Batch Archive Tickets
POST
/crm/v3/objects/emails/batch/read
Hubspot Batch Read Email Engagements
POST
/crm/v3/objects/emails/batch/create
Hubspot Batch Create Email Engagements
POST
/crm/v3/objects/emails/batch/update
Hubspot Batch Update Email Engagements
POST
/crm/v3/objects/meetings/batch/read
Hubspot Batch Read Meetings
POST
/crm/v3/objects/meetings/batch/create
Hubspot Batch Create Meetings
POST
/crm/v3/objects/meetings/batch/update
Hubspot Batch Update Meetings
POST
/crm/v3/objects/tasks/batch/read
Hubspot Batch Read Tasks
POST
/crm/v3/objects/tasks/batch/create
Hubspot Batch Create Tasks
POST
/crm/v3/objects/tasks/batch/update
Hubspot Batch Update Tasks
Schemas 53
The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are Company (6 properties), Meeting (6 properties), Subscription (6 properties), Deal (6 properties). Each schema is shown below with its type and property counts.
BatchUpdateInput
object
1 property
BatchResponseCompany
object
Results from a batch operation on companies.
3 properties
BatchCreateInput
object
1 property
BatchCreateInput_2
object
Input for a batch create operation.
1 property
BatchResponseSubscription
object
3 properties
Association_5
object
An association between two CRM objects.
2 properties
Paging_4
object
Pagination information.
1 property
SimplePublicObjectInput_5
object
Input for creating or updating a CRM object.
1 property
SimplePublicObjectInput
object
1 property
Contact
object
A HubSpot contact record.
6 properties
Association_2
object
An association between two CRM objects.
2 properties
Association
object
2 properties
CollectionResponseAssociation_4
object
A list of associations.
2 properties
BatchUpdateInput_5
object
Input for a batch update operation.
1 property
BatchReadInput_2
object
Input for a batch read operation.
2 properties
Ticket
object
A HubSpot ticket record.
6 properties
BatchReadInput_5
object
Input for a batch read operation.
2 properties
BatchResponseMeeting
object
3 properties
EmailEngagement
object
A HubSpot email engagement record.
6 properties
BatchResponseTicket
object
Results from a batch operation on tickets.
3 properties
Subscription
object
A HubSpot commerce subscription record.
6 properties
BatchResponseEmailEngagement
object
3 properties
Paging
object
1 property
BatchCreateInput_4
object
Input for a batch create operation.
1 property
Paging_5
object
Pagination information.
1 property
CollectionResponseAssociation_5
object
A list of associations.
2 properties
SimplePublicObjectInput_2
object
Input for creating or updating a CRM object.
1 property
Deal
object
A HubSpot deal record.
6 properties
BatchReadInput_3
object
Input for a batch read operation.
2 properties
BatchArchiveInput
object
Input for a batch archive operation.
1 property
BatchUpdateInput_2
object
Input for a batch update operation.
1 property
BatchCreateInput_5
object
Input for a batch create operation.
1 property
BatchResponseTask
object
3 properties
SimplePublicObjectInput_4
object
Input for creating or updating a CRM object.
1 property
Meeting
object
A HubSpot meeting engagement record.
6 properties
Paging_2
object
Pagination information.
1 property
BatchResponseDeal
object
Results from a batch operation on deals.
3 properties
Task
object
A HubSpot task engagement record.
6 properties
BatchUpdateInput_4
object
Input for a batch update operation.
1 property
Paging_3
object
Pagination information.
1 property
BatchReadInput
object
2 properties
Association_4
object
An association between two CRM objects.
2 properties
Association_3
object
An association between two CRM objects.
2 properties
BatchReadInput_4
object
Input for a batch read operation.
2 properties
BatchResponseContact
object
Results from a batch operation on contacts.
3 properties
SimplePublicObjectInput_3
object
Input for creating or updating a CRM object.
1 property
Error
object
4 properties
CollectionResponseAssociation_3
object
A list of associations.
2 properties
CollectionResponseAssociation_2
object
A list of associations.
2 properties
Company
object
A HubSpot company record.
6 properties
BatchCreateInput_3
object
Input for a batch create operation.
1 property
BatchUpdateInput_3
object
Input for a batch update operation.
1 property
CollectionResponseAssociation
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HubSpot 12
Other APIs HubSpot publishes across the network.
HubSpot Posts API
HubSpot URL Redirects API
HubSpot Pipelines API
HubSpot Products API
HubSpot Line Items API
HubSpot Quotes API
HubSpot CRM Properties API
HubSpot Owners API
HubSpot CRM Imports API
HubSpot Custom Objects API
HubSpot Marketing Events API
HubSpot Forms API
#Batch