HubSpot: Batch create objects — partner Services batch Create
HubSpot partnerServices.batchCreate: arguments, response, policy and SDK examples.
← Partner services operations · Get started
Operation hubspot.partner_services_batch_create
Provider route: POST /crm/objects/2026-09/partner_services/batch/create. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["partnerServices"]["batchCreate"]>[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.partnerServices.batchCreate(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_services.batch_create(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Required within parent | Expand Batch create objects — partner Services batch Create — request body — body |
Referenced models: Batch create objects — partner Services batch Create — request body — body
Response
Section titled “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 — partnerServices.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Services Batch Response Simple Public Object |
$ (anyOf 2) | Model | Alternative | Expand Batch create objects — partnerServices.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Services Batch Response Simple Public Object With Errors |
Referenced models: Batch create objects — partnerServices.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Services Batch Response Simple Public Object, Batch create objects — partnerServices.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Services Batch Response Simple Public Object With Errors
Schemas
Section titled “Schemas”5 more schemas are linked from the tables above, on the schema pages.
Batch create objects — partnerServices.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Services 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 information 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 SimplePublicObject items that represent the results of the batch operation. |
results[] | Model | Each item | Expand Create — partner Services 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 Services create — response body
Batch create objects — partnerServices.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Partner Services 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 detailing any errors that occurred during the batch operation. |
errors[] | Model | Each item | Expand Batch create objects — partnerServices.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item |
links | object | Optional | A map of link names to associated URIs that provide 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 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 representing the results of the batch operation. |
results[] | Model | Each item | Expand Create — partner Services 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 Services create — response body, Batch create objects — partnerServices.batchCreate — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
Batch create objects — partner Services batch Create — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a batch input for creating multiple simple public objects in a single request. This component is used to streamline the process of adding new objects to a HubSpot account by allowing multiple entries to be created at once. |
inputs | array | Required within parent | An array of objects to be created, each defined by the SimplePublicObjectBatchInputForCreate schema. |
inputs[] | Model | Each item | Expand Batch create objects — partner Services batch Create — request body — body inputs item |
Referenced models: Batch create objects — partner Services batch Create — request body — body inputs item
Create — partner Services 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 used to trace the write operations for 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 arrays of historical values, where each value includes a timestamp and source information. Additional keys: see wildcard field |
propertiesWithHistory.* | array | Additional keys | |
propertiesWithHistory.*[] | Model | Each item | Expand Create — partner Services 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 representing 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 Create — partner Services create — response body — warnings item |
Referenced models: Create — partner Services create — response body — warnings item, Create — partner Services create — response body — properties With History value item
Batch create objects — partnerServices.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 that categorizes the error. |
context | object | Required within parent | An object containing additional context about the error, with each key mapping to 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 information about the error. |
errors[] | Model | Each item | Expand Batch insert events — response body — 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 associated URIs that 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 indicating the status of the error. |
subCategory | object | Optional | An object providing more specific detail about the error category. |
Referenced models: Batch insert events — response body — errors item errors item
Batch create objects — partner Services batch Create — request body — body inputs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An input object that contains a collection of objects to be created together in a batch. |
associations | array | Required within parent | An array of associations that define relationships between the CRM objects being created and other objects. Each association is represented by a 'PublicAssociationsForObject' object. |
associations[] | Model | Each item | Expand Create — partner Services create — request body — body associations item |
objectWriteTraceId | string | Optional | A string identifier 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 the corresponding property values for the CRM objects to be created. Additional keys: see wildcard field |
properties.* | string | Additional keys |
Referenced models: Create — partner Services create — request body — body associations item
Create — partner Services create — request body — body associations item to
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the Id of a Public Object |
id | string | Required within parent | A string representing the unique identifier of the public object. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: hubspot.partner_services_batch_create. Catalog operation: partner_services_batch_create. 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-services.write"]