HubSpot: Enroll a contact

← Sequences operations · Get started

Operation hubspot.sequences_enrollment_enroll_a_contact

Provider route: POST /automation/sequences/2026-09/enrollments. 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["sequences"]["enrollmentEnrollAContact"]>[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.sequences.enrollmentEnrollAContact(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.sequences.enrollment_enroll_a_contact(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.userId	string	Required within parent
body	Model	Required within parent	Expand Enroll a contact — request body — body

Referenced models: Enroll a contact — 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 Enroll a contact — response body

Referenced models: Enroll a contact — response body

Schemas

Enroll a contact — response body

Field	Type	Presence	Description and constraints
$	object	Root
enrolledAt	string	Required within parent	The date and time when the contact was enrolled in the sequence, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the sequence enrollment.
toEmail	string	Required within parent	The email address of the contact who is enrolled in the sequence.
updatedAt	string	Required within parent	The date and time when the sequence enrollment was last updated, in ISO 8601 format. Format: date-time

Enroll a contact — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
contactId	string	Required within parent	The unique identifier of the contact to be enrolled in the sequence. It is a string.
senderAliasAddress	string	Optional	An optional alias email address that can be used as the sender's address. It is a string.
senderEmail	string	Required within parent	The email address of the sender responsible for the sequence enrollment. It is a string.
sequenceId	string	Required within parent	The unique identifier of the sequence in which the contact is to be enrolled. It is a string.

Policy, approvals and errors

SDK function policy ID: hubspot.sequences_enrollment_enroll_a_contact. Catalog operation: sequences_enrollment_enroll_a_contact. 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: ["automation.sequences.enrollments.write"]

Official provider source