HubSpot: Generate subscription links

← Communication preferences operations · Get started

Operation hubspot.communication_preferences_links_generate

Provider route: POST /communication-preferences/2026-09/links/generate. 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"]["linksGenerate"]>[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.linksGenerate(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.links_generate(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	Default: 0 Format: int64
body	Model	Required within parent	Expand Generate subscription links — request body — body

Referenced models: Generate subscription links — 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 Generate subscription links — response body

Referenced models: Generate subscription links — response body

Schemas

Generate subscription links — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
language	string	Optional	The language in which the generated link should be presented, represented as a string.
subscriberIdString	string	Required within parent	A string representing the unique identifier of the subscriber. This property is required.
subscriptionId	integer	Optional	The unique identifier for the subscription, represented as an integer in int64 format. Format: int64

Generate subscription links — response body

Field	Type	Presence	Description and constraints
$	object	Root
managePreferencesUrl	string	Required within parent	The URL where the subscriber can manage their communication preferences.
subscriberIdString	string	Required within parent	A string representing the unique identifier of the subscriber.
unsubscribeAllUrl	string	Required within parent	A string containing the URL for unsubscribing the subscriber from all communications.
unsubscribeSingleUrl	string	Optional	A string containing the URL to unsubscribe the subscriber from a single communication.

Policy, approvals and errors

SDK function policy ID: hubspot.communication_preferences_links_generate. Catalog operation: communication_preferences_links_generate. 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.read_write"]

Official provider source