Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HubSpot Batch Association Operations API

Perform bulk create, read, and archive operations on multiple associations

HubSpot Batch Association 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 Association Operations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, and 652 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 16 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.

3 operations 3 paths 16 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

HubSpot Batch Association Operations API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Batch Association Operations 3

Perform bulk create, read, and archive operations on multiple associations

POST
/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/read
Hubspot Batch Read Associations for Multiple Objects
batchReadAssociations 2 params body → 200default
POST
/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/create
Hubspot Batch Create Associations
batchCreateAssociations 2 params body → 200default
POST
/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/archive
Hubspot Batch Archive Associations
batchArchiveAssociations 2 params body → 204default

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are BatchAssociationResponse (8 properties), StandardError (7 properties), Error (7 properties), ErrorDetail (5 properties). Each schema is shown below with its type and property counts.

StandardError
object
Standard error in batch operations
7 properties 3 required
BatchAssociationReadInput
object
Input for batch reading associations
1 property 1 required
Association
object
Represents an association between two CRM objects
2 properties 2 required
ErrorDetail
object
Details about a specific error
5 properties 1 required
Paging
object
Pagination information
1 property
AssociationResult
object
Result of an association query
3 properties 2 required
ObjectReference
object
Reference to a CRM object by ID
1 property 1 required
BatchAssociationCreateInput
object
Input for batch creating associations
1 property 1 required
BatchAssociationArchiveItem
object
Single item in a batch association archive request
3 properties 2 required
BatchAssociationCreateItem
object
Single item in a batch association create request
3 properties 3 required
BatchAssociationResponse
object
Response from batch association operations
8 properties 4 required
AssociationTypeInput
object
Input for specifying an association type
2 properties 2 required
Error
object
Standard error response
7 properties 3 required
AssociationType
object
Defines the type of association
3 properties 2 required
PagingNext
object
Pagination cursor for next page
2 properties
BatchAssociationArchiveInput
object
Input for batch archiving associations
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hubspot-batch-association-operations-api-openapi.yml Raw ↑

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