HubSpot: Upsert batch objects — objects batch Upsert Objects

← Objects operations · Get started

Operation hubspot.objects_batch_upsert_objects

Provider route: POST /crm/objects/2026-09/{objectType}/batch/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["objects"]["batchUpsertObjects"]>[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.objects.batchUpsertObjects(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.objects.batch_upsert_objects(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.objectType	string	Required within parent
body	Model	Required within parent	Expand Upsert batch objects — objects batch Upsert Objects — request body — body

Referenced models: Upsert batch objects — objects batch Upsert Objects — 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
$ (anyOf 1)	Model	Alternative	Expand Upsert batch objects — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Objects Batch Response Simple Public Upsert Object
$ (anyOf 2)	Model	Alternative	Expand Upsert batch objects — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Objects Batch Response Simple Public Upsert Object With Errors

Referenced models: Upsert batch objects — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Objects Batch Response Simple Public Upsert Object, Upsert batch objects — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Objects Batch Response Simple Public Upsert Object With Errors

Schemas

3 more schemas are linked from the tables above, on the schema pages.

Upsert batch objects — objects batch Upsert Objects — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input operation for upserting simple public objects in HubSpot. This component is used to process multiple upsert operations in a single request, improving efficiency and performance.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInputUpsert objects, each representing an object to be created or updated. This is a required field.
inputs[]	Model	Each item	Expand Upsert batch objects — objects batch Upsert Objects — request body — body inputs item

Referenced models: Upsert batch objects — objects batch Upsert Objects — request body — body inputs item

Upsert batch objects — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Objects Batch Response Simple Public Upsert Object

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs, providing additional information or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of objects representing the results of the batch upsert operation. Each object corresponds to a CRM object that was created or updated.
results[]	Model	Each item	Expand Upsert batch objects — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Upsert batch objects — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Objects Batch Response Simple Public Upsert Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing.
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of errors encountered during the batch operation, each detailing the specific issue and context.
errors[]	Model	Each item	Expand Read batch objects — objects.batchGetObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional resources or documentation related to the batch operation. 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 batch 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 batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of objects representing the results of the upsert operation for each object in the batch.
results[]	Model	Each item	Expand Upsert batch objects — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Read batch objects — objects.batchGetObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Upsert batch objects — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Upsert batch objects — objects batch Upsert Objects — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an object used in batch upsert operations, containing an object’s unique identifier, its properties, and optionally the unique property name and a write trace ID.
id	string	Required within parent	A string representing the unique identifier of the object to be upserted.
idProperty	string	Optional	A string specifying the name of a property whose values are unique for this object type. This is used to identify objects uniquely.
objectWriteTraceId	string	Optional	A string used to trace the write operation for debugging or logging purposes.
properties	object	Required within parent	An object containing key-value pairs where keys are property names and values are property values to be set on the CRM objects. Each property must be a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Upsert batch objects — objects.batchUpsertObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM object that has either been created or updated (upserted)
archived	boolean	Required within parent	A boolean indicating whether this object is archived.
archivedAt	string	Optional	The date and time when this object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when this object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this object.
new	boolean	Required within parent	A boolean indicating whether this object is newly created.
objectWriteTraceId	string	Optional	An identifier for tracing the write operation of this object.
properties	object	Required within parent	A map of property names to their values for the object. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to their values, including a history of previous values. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Read — objects get Object — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	The URL of the object.
warnings	array	Optional	An array of warnings associated with the object, detailing any issues or considerations.
warnings[]	Model	Each item	Expand Read — objects get Object — response body — warnings item

Referenced models: Read — objects get Object — response body — warnings item, Read — objects get Object — response body — properties With History value item

Read batch objects — objects.batchGetObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
category	string	Required within parent	A string categorizing the type of error.
context	object	Required within parent	An object containing additional context about the error, where each key is a context name and the value is an array 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 details about the error.
errors[]	Model	Each item	Expand Read batch objects — objects.batchGetObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item
id	string	Optional	A string representing the unique identifier for the error.
links	object	Required within parent	An object mapping link names to URIs that provide documentation or remediation steps related to the error. 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: Read batch objects — objects.batchGetObjects — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item

Policy, approvals and errors

SDK function policy ID: hubspot.objects_batch_upsert_objects. Catalog operation: objects_batch_upsert_objects. 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.appointments.sensitive.write.v2", "crm.objects.appointments.write", "crm.objects.carts.write", "crm.objects.commercepayments.write", "crm.objects.companies.highly_sensitive.write.v2", "crm.objects.companies.sensitive.write.v2", "crm.objects.companies.write", "crm.objects.contacts.highly_sensitive.write.v2", "crm.objects.contacts.sensitive.write.v2", "crm.objects.contacts.write", "crm.objects.courses.write", "crm.objects.custom.highly_sensitive.write.v2", "crm.objects.custom.sensitive.write.v2", "crm.objects.custom.write", "crm.objects.deals.highly_sensitive.write.v2", "crm.objects.deals.sensitive.write.v2", "crm.objects.deals.write", "crm.objects.goals.write", "crm.objects.invoices.write", "crm.objects.leads.write", "crm.objects.line_items.write", "crm.objects.listings.write", "crm.objects.orders.write", "crm.objects.partner-clients.write", "crm.objects.partner-services.write", "crm.objects.products.write", "crm.objects.projects.highly_sensitive.write", "crm.objects.projects.sensitive.write", "crm.objects.projects.write", "crm.objects.quotes.write", "crm.objects.services.write", "crm.objects.subscriptions.write", "crm.objects.tickets.highly_sensitive.write", "crm.objects.tickets.sensitive.write", "crm.objects.users.write", "e-commerce", "oauth", "tickets", "tickets.highly_sensitive.v2", "tickets.sensitive.v2"]

Official provider source