Skip to content

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.

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 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_delete_association_labels(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.fromObjectTypestringRequired within parent
path.toObjectTypestringRequired within parent
bodyModelRequired within parentExpand Delete Specific Labels — request body — body

Referenced models: Delete Specific Labels — request body — body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Remove associations — response body

Referenced models: Remove associations — response body

Delete Specific Labels — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
inputsarrayRequired within parentAn 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[]ModelEach itemExpand Delete Specific Labels — request body — body inputs item

Referenced models: Delete Specific Labels — request body — body inputs item

Remove associations — response body
FieldTypePresenceDescription and constraints
$objectRoot
completedAtstringRequired within parentThe date and time when the batch operation was completed, in ISO 8601 format.
Format: date-time
errorsarrayOptionalAn array of errors encountered during the batch operation. Each item is a StandardError object detailing the error.
errors[]ModelEach itemExpand Remove associations — response body — errors item
linksobjectOptionalAn 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.*stringAdditional keys
numErrorsJSONOptional
numErrors (anyOf 1)integerAlternativeThe number of errors encountered during the batch operation.
Format: int32
numErrors (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAtstringOptionalThe date and time when the batch operation was requested, in ISO 8601 format.
Format: date-time
resultsarrayRequired within parentAn array containing the results of the batch operation. Each item is an object representing the outcome of an individual operation.
results[]objectEach item
startedAtstringRequired within parentThe date and time when the batch operation started, in ISO 8601 format.
Format: date-time
statusstringRequired within parentThe 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
FieldTypePresenceDescription and constraints
$objectRoot
fromModelRequired within parentExpand Associate records (default) — response body — results item to
toModelRequired within parentExpand Associate records (default) — response body — results item to
typesarrayRequired within parentAn array of AssociationSpec objects that define the types of associations to be created between the source and target objects.
types[]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, Associate records (default) — response body — results item to

Remove associations — response body — errors item
FieldTypePresenceDescription and constraints
$objectRootRepresents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
categorystringRequired within parentThe main category of the error.
contextobjectRequired within parentAdditional context-specific information related to the error.
Additional keys: see wildcard field
context.*arrayAdditional keys
context.*[]stringEach item
errorsarrayRequired within parentThe detailed error objects.
errors[]ModelEach itemExpand Batch insert events — response body — errors item errors item
idstringOptionalA unique ID for the error instance.
linksobjectRequired within parentURLs linking to documentation or resources associated with the error.
Additional keys: see wildcard field
links.*stringAdditional keys
messagestringRequired within parentA human-readable string describing the error and possible remediation steps.
statusstringRequired within parentThe HTTP status code associated with the error.
subCategoryobjectOptionalA 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
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 (default) — response body — results item to
FieldTypePresenceDescription and constraints
$objectRootContains the Id of a Public Object
idstringRequired within parentID of the object
Batch insert events — response body — errors item errors item
FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
codestringOptionalThe status code associated with the error detail
contextobjectOptionalContext about the error condition
Additional keys: see wildcard field
context.*arrayAdditional keys
context.*[]stringEach item
instringOptionalThe name of the field or parameter in which the error was found.
messagestringRequired within parentA human readable message describing the error along with remediation steps where appropriate
subCategorystringOptionalA specific category that contains more specific detail about the error

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"]

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.