HubSpot: Batch unsubscribe contacts from all subscriptions

← Communication preferences operations · Get started

Operation hubspot.communication_preferences_status_unsubscribe_contacts_batch

Provider route: POST /communication-preferences/2026-09/statuses/batch/unsubscribe-all. 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["communicationPreferences"]["statusUnsubscribeContactsBatch"]>[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.communicationPreferences.statusUnsubscribeContactsBatch(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.communication_preferences.status_unsubscribe_contacts_batch(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.channel	string	Required within parent	One of: EMAIL
query.businessUnitId	integer	Optional	Format: int64
query.verbose	boolean	Optional	Default: false
body	Model	Required within parent	Expand Batch retrieve subscription statuses — request body — body

Referenced models: Batch retrieve subscription statuses — 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 Batch unsubscribe contacts from all subscriptions — response body

Referenced models: Batch unsubscribe contacts from all subscriptions — response body

Schemas

Batch retrieve subscription statuses — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	A list of strings representing the inputs for batch operations.
inputs[]	string	Each item

Batch unsubscribe contacts from all subscriptions — response body

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the bulk opt-out operation was completed. Format: date-time
errors	array	Optional	An array of error objects detailing any issues encountered during the bulk opt-out operation.
errors[]	Model	Each item	Expand Batch update subscription status — response body — errors item
links	object	Optional	A collection of URLs linking to related resources or documentation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The total number of errors encountered during the bulk opt-out 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 bulk opt-out request was made. Format: date-time
results	array	Required within parent	An array containing the results of the bulk opt-out from all communications operation.
results[]	Model	Each item	Expand Batch unsubscribe contacts from all subscriptions — response body — results item
startedAt	string	Required within parent	The date and time when the bulk opt-out operation began. Format: date-time
status	string	Required within parent	The current status of the bulk opt-out operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Batch update subscription status — response body — errors item, Batch unsubscribe contacts from all subscriptions — response body — results item

Batch update subscription status — response body — errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	A string that categorizes the type of error.
context	object	Required within parent	An object containing additional context about the error condition, with keys as context names and values as arrays 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 of the 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 categorization of the error.

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

Batch unsubscribe contacts from all subscriptions — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
statuses	array	Optional	An array of subscription status objects for the contact.
statuses[]	Model	Each item	Expand Batch update subscription status — response body — results item
subscriberIdString	string	Required within parent	The email address of the contact.

Referenced models: Batch update subscription status — response body — results 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

Batch update subscription status — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
businessUnitId	JSON	Optional
businessUnitId (anyOf 1)	integer	Alternative	The ID of the business unit associated with the subscription. Format: int64
businessUnitId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
channel	string	Required within parent	The type of communication channel, with 'EMAIL' as the only supported option. Known values: EMAIL
legalBasis	string	Optional	The legal basis for communication, with options including 'LEGITIMATE_INTEREST_PQL', 'LEGITIMATE_INTEREST_CLIENT', 'PERFORMANCE_OF_CONTRACT', 'CONSENT_WITH_NOTICE', 'NON_GDPR', 'PROCESS_AND_STORE', and 'LEGITIMATE_INTEREST_OTHER'. Known values: CONSENT_WITH_NOTICE, LEGITIMATE_INTEREST_CLIENT, LEGITIMATE_INTEREST_OTHER, LEGITIMATE_INTEREST_PQL, NON_GDPR, PERFORMANCE_OF_CONTRACT, PROCESS_AND_STORE
legalBasisExplanation	string	Optional	An explanation for the legal basis used for communication.
setStatusSuccessReason	string	Optional	The reason for the successful change in subscription status, such as 'RESUBSCRIBE_OCCURRED' or 'NO_STATUS_CHANGE'. Known values: NO_STATUS_CHANGE, REQUESTED_CHANGE_OCCURRED, RESUBSCRIBE_OCCURRED, UNSUBSCRIBE_FROM_ALL_OCCURRED
source	string	Required within parent	The origin or method through which the subscription status was set.
status	string	Required within parent	The current subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'. Known values: NOT_SPECIFIED, SUBSCRIBED, UNSUBSCRIBED
subscriberIdString	string	Required within parent	The contact's email address.
subscriptionId	JSON	Required within parent
subscriptionId (anyOf 1)	integer	Alternative	The unique identifier of the subscription. Format: int64
subscriptionId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
subscriptionName	string	Optional	The name of the subscription.
timestamp	string	Required within parent	The date and time when the subscription status was last updated. Format: date-time

Policy, approvals and errors

SDK function policy ID: hubspot.communication_preferences_status_unsubscribe_contacts_batch. Catalog operation: communication_preferences_status_unsubscribe_contacts_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: ["communication_preferences.statuses.batch.write"]

Official provider source