HubSpot: Create Default Associations

← Associations operations · Get started

Operation hubspot.associations_batch_create_associations

Provider route: POST /crm/associations/2026-09/{fromObjectType}/{toObjectType}/batch/associate/default. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["associations"]["batchCreateAssociations"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.associations.batchCreateAssociations(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.associations.batch_create_associations(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.fromObjectType	string	Required within parent
path.toObjectType	string	Required within parent
body	Model	Required within parent	Expand Create Default Associations — request body — body

Referenced models: Create Default Associations — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Associate records (default) — response body

Referenced models: Associate records (default) — response body

Schemas

Create Default Associations — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of PublicDefaultAssociationMultiPost objects, each specifying the details of the default association to be created between two objects. This property is required.
inputs[]	Model	Each item	Expand Create Default Associations — request body — body inputs item

Referenced models: Create Default Associations — request body — body inputs item

Associate records (default) — response body

Field	Type	Presence	Description and constraints
$	object	Root	The response returned after performing a batch operation on associations.
completedAt	string	Required within parent	The timestamp when the batch process was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of errors that occurred during the batch operation, if any.
errors[]	Model	Each item	Expand Remove associations — response body — errors item
links	object	Optional	An object containing relevant links related to the batch request. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the batch processing. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The timestamp when the batch process was initiated, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of results from the batch operation, each representing a default association created between objects.
results[]	Model	Each item	Expand Associate records (default) — response body — results item
startedAt	string	Required within parent	The timestamp when the batch process began execution, in ISO 8601 format. Format: date-time
status	string	Required within parent	The status of the batch processing request: "PENDING", "PROCESSING", "CANCELLED", or "COMPLETE". Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Remove associations — response body — errors item, Associate records (default) — response body — results item

Create Default Associations — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
from	Model	Required within parent	Expand Associate records (default) — response body — results item to
to	Model	Required within parent	Expand Associate records (default) — response body — results item to

Referenced models: Associate records (default) — response body — results item to

Remove associations — response body — errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
category	string	Required within parent	The main category of the error.
context	object	Required within parent	Additional context-specific information related to the error. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	The detailed error objects.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A unique ID for the error instance.
links	object	Required within parent	URLs linking to documentation or resources associated with the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A human-readable string describing the error and possible remediation steps.
status	string	Required within parent	The HTTP status code associated with the error.
subCategory	object	Optional	A more specific error category within each main category.

Referenced models: Batch insert events — response body — errors item errors item

Associate records (default) — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root	The PublicDefaultAssociation component represents the default association configuration between two objects in HubSpot. It is used to define how objects are related to each other within the platform.
associationSpec	Model	Required within parent	Expand Associate records (default) — response body — results item association Spec
from	Model	Required within parent	Expand Associate records (default) — response body — results item to
to	Model	Required within parent	Expand Associate records (default) — response body — results item to

Referenced models: Associate records (default) — response body — results item to, Associate records (default) — response body — results item association Spec

Associate records (default) — response body — results item to

Field	Type	Presence	Description and constraints
$	object	Root	Contains the Id of a Public Object
id	string	Required within parent	ID of the object

Batch insert events — response body — errors item errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
code	string	Optional	The status code associated with the error detail
context	object	Optional	Context about the error condition Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
in	string	Optional	The name of the field or parameter in which the error was found.
message	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate
subCategory	string	Optional	A specific category that contains more specific detail about the error

Associate records (default) — response body — results item association Spec

Field	Type	Presence	Description and constraints
$	object	Root	Defines the type, direction, and details of the relationship between two CRM objects.
associationCategory	string	Required within parent	The category of the association, such as "HUBSPOT_DEFINED". Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
associationTypeId	JSON	Required within parent
associationTypeId (anyOf 1)	integer	Alternative	The ID representing the specific type of association. Format: int32
associationTypeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: hubspot.associations_batch_create_associations. Catalog operation: associations_batch_create_associations. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["crm.objects.appointments.sensitive.write.v2", "crm.objects.appointments.write", "crm.objects.carts.write", "crm.objects.commercepayments.write", "crm.objects.companies.highly_sensitive.write.v2", "crm.objects.companies.sensitive.write.v2", "crm.objects.companies.write", "crm.objects.contacts.highly_sensitive.write.v2", "crm.objects.contacts.sensitive.write.v2", "crm.objects.contacts.write", "crm.objects.courses.write", "crm.objects.custom.highly_sensitive.write.v2", "crm.objects.custom.sensitive.write.v2", "crm.objects.custom.write", "crm.objects.deals.highly_sensitive.write.v2", "crm.objects.deals.sensitive.write.v2", "crm.objects.deals.write", "crm.objects.goals.write", "crm.objects.invoices.write", "crm.objects.leads.write", "crm.objects.line_items.write", "crm.objects.listings.write", "crm.objects.orders.write", "crm.objects.partner-clients.write", "crm.objects.partner-services.write", "crm.objects.products.write", "crm.objects.projects.highly_sensitive.write", "crm.objects.projects.sensitive.write", "crm.objects.projects.write", "crm.objects.quotes.write", "crm.objects.services.write", "crm.objects.subscriptions.write", "crm.objects.users.write", "e-commerce", "tickets", "tickets.highly_sensitive.v2", "tickets.sensitive.v2"]

Official provider source