HubSpot: Delete Specific Labels
HubSpot associations.batchDeleteAssociationLabels: arguments, response, policy and SDK examples.
← Associations operations · Get started
Operation hubspot.associations_batch_delete_association_labels
Provider route: POST /crm/associations/2026-09/{fromObjectType}/{toObjectType}/batch/labels/archive. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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"]["batchDeleteAssociationLabels"]>[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.batchDeleteAssociationLabels(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_delete_association_labels(arguments) result = await call.wait() return result.body_json()| 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 Delete Specific Labels — request body — body |
Referenced models: Delete Specific Labels — request body — body
Response
Section titled “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 Remove associations — response body |
Referenced models: Remove associations — response body
Schemas
Section titled “Schemas”Delete Specific Labels — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inputs | array | Required within parent | An array of PublicAssociationMultiPost objects, each specifying the details of an association to be created. This includes the source and target objects and the types of associations to be applied. |
inputs[] | Model | Each item | Expand Delete Specific Labels — request body — body inputs item |
Referenced models: Delete Specific Labels — request body — body inputs item
Remove associations — response body
| 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 is a StandardError object detailing the error. |
errors[] | Model | Each item | Expand Remove associations — response body — errors item |
links | object | Optional | An object containing additional links related to the batch operation, where each key is a link name and the value is a URL. 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 containing the results of the batch operation. Each item is an object representing the outcome of an individual operation. |
results[] | object | Each 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 associations — response body — errors item
Delete Specific Labels — 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 |
types | array | Required within parent | An array of AssociationSpec objects that define the types of associations to be created between the source and target objects. |
types[] | Model | Each item | Expand Associate records (labelled) — associations update Association Labeled — request body — body item |
Referenced models: Associate records (labelled) — associations update Association Labeled — request body — body item, 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 (labelled) — associations update Association Labeled — request body — body item
| 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". One of: HUBSPOT_DEFINED, INTEGRATOR_DEFINED, USER_DEFINED, WORK |
associationTypeId | integer | Required within parent | The ID representing the specific type of association. Format: int32 |
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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: hubspot.associations_batch_delete_association_labels. Catalog operation: associations_batch_delete_association_labels. 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"]