HubSpot: Record a subscriber state by contact email

← Marketing events operations · Get started

Operation hubspot.marketing_events_subscriber_state_changes_set_subscriber_state

Provider route: POST /marketing/marketing-events/2026-09/events/{externalEventId}/{subscriberState}/email-upsert. 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["marketingEvents"]["subscriberStateChangesSetSubscriberState"]>[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.marketingEvents.subscriberStateChangesSetSubscriberState(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.marketing_events.subscriber_state_changes_set_subscriber_state(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.externalEventId	string	Required within parent
path.subscriberState	string	Required within parent
query	object	Required within parent	Additional keys: not allowed
query.externalAccountId	string	Required within parent
body	Model	Required within parent	Expand Record a subscriber state by contact email — request body — body

Referenced models: Record a subscriber state by contact email — 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
$	JSON	Root

Schemas

Record a subscriber state by contact email — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	List of marketing event details to create or update
inputs[]	Model	Each item	Expand Record a subscriber state by contact email — request body — body inputs item

Referenced models: Record a subscriber state by contact email — request body — body inputs item

Record a subscriber state by contact email — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
contactProperties	object	Required within parent	The key-value set that contains properties of the contact. Additional keys: see wildcard field
contactProperties.*	string	Additional keys
email	string	Required within parent	The email address of the contact in HubSpot to associate with the event.
interactionDateTime	integer	Required within parent	Timestamp in milliseconds at which the contact subscribed to the event. Format: int64
properties	object	Required within parent	The key-value set that contains properties of the marketing event. Additional keys: see wildcard field
properties.*	string	Additional keys

Policy, approvals and errors

SDK function policy ID: hubspot.marketing_events_subscriber_state_changes_set_subscriber_state. Catalog operation: marketing_events_subscriber_state_changes_set_subscriber_state. 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.marketing_events.write"]

Official provider source