HubSpot: Configure association limits

← Association labels operations · Get started

Operation hubspot.association_labels_create_associations_label_batch

Provider route: POST /crm/associations/2026-09/definitions/configurations/{fromObjectType}/{toObjectType}/batch/create. 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["associationLabels"]["createAssociationsLabelBatch"]>[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.associationLabels.createAssociationsLabelBatch(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.association_labels.create_associations_label_batch(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 Configure association limits — request body — body

Referenced models: Configure association limits — 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
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Configure association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Association Labels Batch Response Public Association Definition User Configuration
$ (anyOf 2)	Model	Alternative	Expand Configure association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Association Labels Batch Response Public Association Definition User Configuration With Errors

Referenced models: Configure association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Association Labels Batch Response Public Association Definition User Configuration, Configure association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Association Labels Batch Response Public Association Definition User Configuration With Errors

Schemas

Configure association limits — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of PublicAssociationDefinitionConfigurationCreateRequest objects. Each item in the array specifies the configuration details for creating an association definition.
inputs[]	Model	Each item	Expand Configure association limits — request body — body inputs item

Referenced models: Configure association limits — request body — body inputs item

Configure association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Association Labels Batch Response Public Association Definition User Configuration

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed. Format: date-time
links	object	Optional	A collection of URLs linking to related documentation or resources associated with the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested. Format: date-time
results	array	Required within parent	An array of user configurations for public association definitions, representing the outcome of the batch operation.
results[]	Model	Each item	Expand Retrieve association limits — response body — results item
startedAt	string	Required within parent	The date and time when the batch operation started. Format: date-time
status	string	Required within parent	The current status of the batch operation, which can be CANCELED, COMPLETE, PENDING, or PROCESSING. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Retrieve association limits — response body — results item

Configure association limits — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Association Labels Batch Response Public Association Definition User Configuration With Errors

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of errors encountered during the batch operation, each item detailing a specific error.
errors[]	Model	Each item	Expand Remove association limits — response body — errors item
links	object	Optional	An object containing key-value pairs where each key is a link name and each value is a URI string related to the operation. 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 operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of results from the batch operation, each item representing a public association definition user configuration.
results[]	Model	Each item	Expand Retrieve association limits — response body — results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Remove association limits — response body — errors item, Retrieve association limits — response body — results item

Configure association limits — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
category	string	Required within parent	Specifies the category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
maxToObjectIds	integer	Required within parent	The maximum number of target object IDs that can be associated with a single source object. Format: int32
typeId	integer	Required within parent	An integer used to uniquely identify a specific association type within its category. Format: int32

Retrieve association limits — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
category	string	Required within parent	The category of the association, which can be HUBSPOT_DEFINED, INTEGRATOR_DEFINED, or USER_DEFINED. Known values: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
label	string	Optional	A descriptor providing context about the relationship between associated records.
typeId	JSON	Required within parent
typeId (anyOf 1)	integer	Alternative	A unique integer identifier for the association type within its category. Format: int32
typeId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
userEnforcedMaxToObjectIds	JSON	Optional
userEnforcedMaxToObjectIds (anyOf 1)	integer	Alternative	The maximum number of target object IDs that a user can enforce in an association. Format: int32
userEnforcedMaxToObjectIds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Remove association limits — 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	A string that categorizes the error.
context	object	Required within parent	An object containing additional context about the error condition, with each key mapping to an array of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string representing the unique identifier for this error.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation about the error or recommended remediation steps. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message describing the error.
status	string	Required within parent	A string indicating the status of the error.
subCategory	object	Optional	An object providing more specific details about the error category.

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

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

Policy, approvals and errors

SDK function policy ID: hubspot.association_labels_create_associations_label_batch. Catalog operation: association_labels_create_associations_label_batch. 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.tickets.highly_sensitive.write", "crm.objects.tickets.sensitive.write", "crm.objects.users.write", "e-commerce", "tickets", "tickets.highly_sensitive.v2", "tickets.sensitive.v2"]

Official provider source