Skip to content

HubSpot: Associate records (labelled) — associations update Association Labeled

HubSpot associations.updateAssociationLabeled: arguments, response, policy and SDK examples.

← Associations operations · Get started

Operation hubspot.associations_update_association_labeled

Provider route: PUT /crm/objects/2026-09/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}. Alter supplies the connection’s credentials and routing.

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"]["updateAssociationLabeled"]>[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.updateAssociationLabeled(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.update_association_labeled(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.objectIdstringRequired within parent
path.objectTypestringRequired within parent
path.toObjectIdstringRequired within parent
path.toObjectTypestringRequired within parent
bodyarrayRequired within parent
body[]ModelEach itemExpand Associate records (labelled) — associations update Association Labeled — request body — body item

Referenced models: Associate records (labelled) — associations update Association Labeled — request body — body item

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Associate records (labelled) — associations update Association Labeled — response body

Referenced models: Associate records (labelled) — associations update Association Labeled — response body

Associate records (labelled) — associations update Association Labeled — request body — body item
FieldTypePresenceDescription and constraints
$objectRootDefines the type, direction, and details of the relationship between two CRM objects.
associationCategorystringRequired within parentThe category of the association, such as "HUBSPOT_DEFINED".
One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK
associationTypeIdintegerRequired within parentThe ID representing the specific type of association.
Format: int32
Associate records (labelled) — associations update Association Labeled — response body
FieldTypePresenceDescription and constraints
$objectRootThe relationship descriptors applicable between two object types.
fromObjectIdstringRequired within parentThe ID of the source object in the association.
fromObjectTypeIdstringRequired within parentThe type ID of the source object in the association.
labelsarrayRequired within parentAn array of labels associated with the relationship between the objects.
labels[]stringEach item
toObjectIdstringRequired within parentThe ID of the target object in the association.
toObjectTypeIdstringRequired within parentThe type ID of the target object in the association.

SDK function policy ID: hubspot.associations_update_association_labeled. Catalog operation: associations_update_association_labeled. 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", "oauth", "tickets", "tickets.highly_sensitive.v2", "tickets.sensitive.v2"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.