HubSpot Batch Operations API
Perform bulk operations on multiple blog authors simultaneously
HubSpot Batch Operations 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 Operations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, and 652 JSON Schemas.
This API exposes 20 operations across 20 paths, and defines 70 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.
20 operations
20 paths
70 schemas
20 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
HubSpot Batch Operations API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.
Paths & Operations 20
Across 20 paths, the API surfaces 20 operations — 20 POST. Each is listed below with its method, path, parameters, and response codes.
Batch Operations 20
Perform bulk operations on multiple blog authors simultaneously
POST
/cms/v3/blogs/authors/batch/read
Hubspot Read Multiple Blog Authors
POST
/cms/v3/blogs/authors/batch/create
Hubspot Create Multiple Blog Authors
POST
/cms/v3/blogs/authors/batch/update
Hubspot Update Multiple Blog Authors
POST
/cms/v3/blogs/authors/batch/archive
Hubspot Archive Multiple Blog Authors
POST
/cms/v3/blogs/posts/batch/read
Hubspot Read Multiple Blog Posts
POST
/cms/v3/blogs/posts/batch/create
Hubspot Create Multiple Blog Posts
POST
/cms/v3/blogs/posts/batch/update
Hubspot Update Multiple Blog Posts
POST
/cms/v3/blogs/posts/batch/archive
Hubspot Archive Multiple Blog Posts
POST
/crm/v3/objects/commerce_payments/batch/read
Hubspot Read a Batch of Commerce Payments
POST
/crm/v3/objects/commerce_payments/batch/archive
Hubspot Archive a Batch of Commerce Payments
POST
/crm/v3/objects/commerce_payments/batch/create
Hubspot Create a Batch of Commerce Payments
POST
/crm/v3/objects/commerce_payments/batch/update
Hubspot Update a Batch of Commerce Payments
POST
/crm/v3/objects/calls/batch/create
Hubspot Create a Batch of Calls
POST
/crm/v3/objects/calls/batch/read
Hubspot Read a Batch of Calls
POST
/crm/v3/objects/calls/batch/update
Hubspot Update a Batch of Calls
POST
/crm/v3/objects/calls/batch/archive
Hubspot Archive a Batch of Calls
POST
/crm/v3/objects/notes/batch/create
Hubspot Create a Batch of Notes
POST
/crm/v3/objects/notes/batch/read
Hubspot Read a Batch of Notes
POST
/crm/v3/objects/notes/batch/update
Hubspot Update a Batch of Notes
POST
/crm/v3/objects/notes/batch/archive
Hubspot Archive a Batch of Notes
Schemas 70
The contract defines 70 schemas that model the data the API accepts and returns. The most detailed are BlogPost (32 properties), BlogPostInput (15 properties), BlogAuthor (15 properties), BlogAuthorInput (9 properties). Each schema is shown below with its type and property counts.
BatchUpdateCallsRequest
object
Request body for batch updating calls
1 property
1 required
BatchInput
object
Input for batch update operations
1 property
1 required
Error_3
object
An error response
7 properties
3 required
BatchResponseWithErrors
BatchInputItem_2
object
Single item in a batch archive operation
1 property
1 required
ErrorDetail_4
object
Detailed error information
5 properties
1 required
BatchCreateResponse
object
Response from a batch create operation
8 properties
4 required
Error_5
object
Error response
7 properties
3 required
AssociationInput_3
object
Association to create with another object
2 properties
2 required
AssociationType
object
An association type definition
2 properties
2 required
BatchCreateInput
object
Input for batch create operations
1 property
1 required
BatchReadCallsRequest
object
Request body for batch reading calls
4 properties
1 required
BatchResponse
object
Response from batch operations
6 properties
4 required
BatchCreateCallsRequest
object
Request body for batch creating calls
1 property
1 required
AssociationType_2
object
Type of association
2 properties
2 required
BatchReadNotesRequest
object
Request body for batch reading notes
4 properties
1 required
ErrorDetail
object
Detailed information about a specific error
5 properties
1 required
AssociationType_3
object
Type of association
2 properties
2 required
BatchReadInputItem
object
A single input item for batch read
1 property
1 required
ErrorDetail_2
object
Detailed error information
5 properties
1 required
PropertyHistory_3
object
Historical value of a property
6 properties
BlogAuthorInput
object
Input data for creating or updating a blog author
9 properties
1 required
BatchArchiveInput
object
Input for batch archive operations
1 property
1 required
ErrorDetail_3
object
Detailed error information
5 properties
1 required
BatchUpdateResponse
object
Response from a batch update operation
8 properties
4 required
BatchArchiveNotesRequest
object
Request body for batch archiving notes
1 property
1 required
BatchReadInput
object
Input for batch read operations
1 property
1 required
Error_2
object
Standard error response
7 properties
3 required
BatchResponse_2
object
Response from batch operations
6 properties
4 required
BatchError_2
object
Error information for a batch operation item
5 properties
BlogPost
object
Represents a blog post with all content and metadata
32 properties
4 required
PropertyHistory_2
object
Historical value of a property
6 properties
BatchReadRequest
object
Request body for batch reading commerce payments
4 properties
2 required
CommercePayment
object
A commerce payment object representing a payment transaction
8 properties
4 required
BatchResponseWithErrors_2
BatchInput_2
object
Input for batch archive operations
1 property
1 required
PropertyHistory
object
A historical property value
6 properties
3 required
BatchUpdateInput
object
Input for updating a single item in a batch
2 properties
2 required
StandardError
object
Standard error in batch operations
7 properties
3 required
AssociationInput_2
object
Association to create with another object
2 properties
2 required
BatchArchiveCallsRequest
object
Request body for batch archiving calls
1 property
1 required
BatchError_3
object
Error information for a batch operation item
5 properties
BatchReadInput_2
object
Input for reading a single item in a batch
1 property
1 required
BatchUpdateInputItem
object
A single input item for batch update
3 properties
2 required
BatchArchiveRequest
object
Request body for batch archiving commerce payments
1 property
1 required
BatchCreateNotesRequest
object
Request body for batch creating notes
1 property
1 required
AssociationResult
object
Association results for an object
2 properties
Error_4
object
Error response
7 properties
3 required
BatchUpdateNotesRequest
object
Request body for batch updating notes
1 property
1 required
BatchUpdateInput_2
object
Input for updating a single item in a batch
2 properties
2 required
BatchInputItem
object
Single item in a batch update operation
2 properties
1 required
NoteCreateRequest
object
Request body for creating a note
2 properties
1 required
StandardError_2
object
Standard error in batch operations
7 properties
3 required
CallCreateRequest
object
Request body for creating a call
2 properties
1 required
Call
object
Represents a call engagement in the CRM
7 properties
5 required
BatchCallsResponse
object
Response for batch call operations
7 properties
4 required
BatchReadResponse
object
Response from a batch read operation
8 properties
4 required
BatchUpdateRequest
object
Request body for batch updating commerce payments
1 property
1 required
BatchCreateRequest
object
Request body for batch creating commerce payments
1 property
1 required
BatchNotesResponse
object
Response for batch note operations
7 properties
4 required
ErrorDetail_5
object
Detailed error information
5 properties
1 required
Note
object
Represents a note engagement in the CRM
7 properties
5 required
Paging
object
Pagination information
2 properties
BatchReadInput_3
object
Input for reading a single item in a batch
1 property
1 required
BatchError
object
An error from a batch operation
8 properties
2 required
AssociationInput
object
Input for creating an association
2 properties
2 required
BlogPostInput
object
Input data for creating or updating a blog post
15 properties
2 required
Error
object
Standard error response returned when an API request fails
7 properties
3 required
BlogAuthor
object
Represents a blog author profile with biographical and social information
15 properties
4 required
CommercePaymentInput
object
Input for creating a new commerce payment
2 properties
1 required
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 Operations