HubSpot: Batch upsert objects — partner Clients batch Upsert

← Partner clients operations · Get started

Operation hubspot.partner_clients_batch_upsert

Provider route: POST /crm/objects/2026-09/partner_clients/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["partnerClients"]["batchUpsert"]>[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.partnerClients.batchUpsert(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.partner_clients.batch_upsert(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Batch upsert objects — partner Clients batch Upsert — request body — body

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

Referenced models: Batch upsert objects — partnerClients.batchUpsert — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Clients Batch Response Simple Public Upsert Object, Batch upsert objects — partnerClients.batchUpsert — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Clients Batch Response Simple Public Upsert Object With Errors

Schemas

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

Batch upsert objects — partnerClients.batchUpsert — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Clients 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 SimplePublicUpsertObject items representing the results of the upsert operation for each object in the batch.
results[]	Model	Each item	Expand Batch upsert objects — partnerClients.batchUpsert — 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: Batch upsert objects — partnerClients.batchUpsert — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item

Batch upsert objects — partnerClients.batchUpsert — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Clients 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 represented by a StandardError.
errors[]	Model	Each item	Expand Batch create objects — partnerClients.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
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
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 results from the batch upsert operation, each represented by a SimplePublicUpsertObject.
results[]	Model	Each item	Expand Batch upsert objects — partnerClients.batchUpsert — 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: Batch upsert objects — partnerClients.batchUpsert — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item, Batch create objects — partnerClients.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Batch upsert objects — partner Clients batch Upsert — 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 property is required.
inputs[]	Model	Each item	Expand Batch upsert objects — partner Clients batch Upsert — request body — body inputs item

Referenced models: Batch upsert objects — partner Clients batch Upsert — request body — body inputs item

Batch upsert objects — partnerClients.batchUpsert — 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 the object is archived.
archivedAt	string	Optional	The date and time when the object was archived, in ISO 8601 format. Format: date-time
createdAt	string	Required within parent	The date and time when the object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the object, represented as a string.
new	boolean	Required within parent	A boolean indicating whether the object is newly created.
objectWriteTraceId	string	Optional	A string used to trace the write operations on the object.
properties	object	Required within parent	A map of property names to their values, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
propertiesWithHistory	object	Optional	A map of property names to an array of values with timestamps, showing the history of changes for each property. Additional keys: see wildcard field
propertiesWithHistory.*	array	Additional keys
propertiesWithHistory.*[]	Model	Each item	Expand Create — partner Clients create — response body — properties With History value item
updatedAt	string	Required within parent	The date and time when the object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string representing the URL of the object.
warnings	array	Optional	An array of warnings related to the object, each represented by a PublicObjectWarning.
warnings[]	Model	Each item	Expand Read — projects get Project — response body — warnings item

Referenced models: Read — projects get Project — response body — warnings item, Create — partner Clients create — response body — properties With History value item

Batch create objects — partnerClients.batchCreate — 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 indicating the category of the error.
context	object	Required within parent	An object containing additional context about the error, with keys as context names and values as arrays 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 information about the error.
errors[]	Model	Each item	Expand Batch insert events — response body — errors item errors item
id	string	Optional	A string that uniquely identifies the error instance.
links	object	Required within parent	An object mapping link names to associated URIs, which may contain documentation about the error or recommended remediation steps. 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 representing the status of the error.
subCategory	object	Optional	An object providing more specific categorization of the error.

Referenced models: Batch insert events — response body — errors item errors item

Batch upsert objects — partner Clients batch Upsert — 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 CRM object. This is required for identifying the object in upsert operations.
idProperty	string	Optional	A string representing the name of a property whose values are unique for this object type. This is used to identify the object uniquely by a property other than the default ID.
objectWriteTraceId	string	Optional	A string identifier used for tracing the write operation of the object. This is optional and can be used for debugging or tracking purposes.
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and each value is the property value. These properties define the attributes of the CRM object. Additional keys: see wildcard field
properties.*	string	Additional keys

Policy, approvals and errors

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

Official provider source