HubSpot: Cancel an active import

← Imports operations · Get started

Operation hubspot.imports_cancel_import

Provider route: POST /crm/imports/2026-09/{importId}/cancel. 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["imports"]["cancelImport"]>[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.imports.cancelImport(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.imports.cancel_import(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.importId	integer	Required within parent	Format: int64

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 Cancel an active import — response body

Referenced models: Cancel an active import — response body

Schemas

Cancel an active import — response body

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The timestamp when the action was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs containing documentation about the error or recommended remediation steps Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The timestamp when the export request was made, in ISO 8601 format. Format: date-time
startedAt	string	Required within parent	The timestamp when the action was started, in ISO 8601 format. Format: date-time
status	string	Required within parent	An enum representing the lifecycle state of the action. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Policy, approvals and errors

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

Official provider source