HubSpot: Update batch objects — partner Clients batch Update

← Partner clients operations · Get started

Operation hubspot.partner_clients_batch_update

Provider route: POST /crm/objects/2026-09/partner_clients/batch/update. 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"]["batchUpdate"]>[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.batchUpdate(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_update(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 Update batch objects — partner Clients batch Update — request body — body

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

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

Schemas

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

Batch create objects — partnerClients.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Clients Batch Response Simple Public Object

Field	Type	Presence	Description and constraints
$	object	Root	A public object batch response object
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 resources or documentation 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 simple public objects that were processed in the batch operation.
results[]	Model	Each item	Expand Create — partner Clients create — response body
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: Create — partner Clients create — response body

Batch create objects — partnerClients.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Clients Batch Response Simple Public Object With Errors

Field	Type	Presence	Description and constraints
$	object	Root	Represents the result of a batch operation on CRM objects, including the processing status, batch results, timestamps, and a list of any errors encountered during the operation.
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 StandardError objects that describe any errors encountered during the batch operation.
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 for additional information 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 SimplePublicObject items that represent the successful results of the batch operation.
results[]	Model	Each item	Expand Create — partner Clients create — response body
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: Create — partner Clients create — response body, Batch create objects — partnerClients.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Update batch objects — partner Clients batch Update — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Represents a batch input component used to handle multiple simple public objects in a single API request. This component is typically used when performing batch operations to create, update, or delete multiple records simultaneously.
inputs	array	Required within parent	An array of SimplePublicObjectBatchInput objects, each containing the properties and identifiers for a single CRM object to be updated.
inputs[]	Model	Each item	Expand Update batch objects — partner Clients batch Update — request body — body inputs item

Referenced models: Update batch objects — partner Clients batch Update — request body — body inputs item

Create — partner Clients create — response body

Field	Type	Presence	Description and constraints
$	object	Root	A simple public object.
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, represented as a string.
objectWriteTraceId	string	Optional	A string representing the trace ID for write operations on this 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 their historical values, where each value is an array of objects containing the value and its timestamp. 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 this object was last updated, in ISO 8601 format. Format: date-time
url	string	Optional	A string containing the URL associated with this object.
warnings	array	Optional	An array of warnings related to this object, where each warning includes a category, message, and context.
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

Update batch objects — partner Clients batch Update — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root	Contains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties.
id	string	Required within parent	A string representing the unique identifier for the CRM object.
idProperty	string	Optional	A string specifying the name of a property whose values are unique for this object type, used to identify the object.
objectWriteTraceId	string	Optional	A string used to trace the write operation for the object, useful for debugging and tracking changes.
properties	object	Required within parent	An object containing key-value pairs representing the properties of the CRM object. Each key is a property name and each value is the property's value. Additional keys: see wildcard field
properties.*	string	Additional keys

Read — projects get Project — response body — warnings item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
category	string	Required within parent	A string representing the category of the warning.
context	object	Required within parent	An object providing additional context about the warning, with string properties. Additional keys: see wildcard field
context.*	string	Additional keys
message	string	Required within parent	A string containing the warning message.

Policy, approvals and errors

SDK function policy ID: hubspot.partner_clients_batch_update. Catalog operation: partner_clients_batch_update. 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