Skip to content

HubSpot: Create rows in batch

HubSpot hubdb.batchCreateRowsDraft: arguments, response, policy and SDK examples.

← Hubdb operations · Get started

Operation hubspot.hubdb_batch_create_rows_draft

Provider route: POST /cms/hubdb/2026-09/tables/{tableIdOrName}/rows/draft/batch/create. Alter supplies the connection’s credentials and routing.

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["hubdb"]["batchCreateRowsDraft"]>[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.hubdb.batchCreateRowsDraft(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.hubdb.batch_create_rows_draft(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.tableIdOrNamestringRequired within parent
bodyModelRequired within parentExpand Create rows in batch — request body — body

Referenced models: Create rows in batch — request body — body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Clone rows in batch — response body
$ (anyOf 2)ModelAlternativeExpand Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Clone rows in batch — response body, Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING

Create rows in batch — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
inputsarrayRequired within parentAn array of HubDbTableRowV3Request objects, each representing a row to be created. This property is required.
inputs[]ModelEach itemExpand Add a new row to a table — request body — body

Referenced models: Add a new row to a table — request body — body

Clone rows in batch — response body
FieldTypePresenceDescription and constraints
$objectRoot
completedAtstringRequired within parentThe timestamp indicating when the batch processing was completed.
Format: date-time
linksobjectOptionalA collection of related links associated with the batch response.
Additional keys: see wildcard field
links.*stringAdditional keys
requestedAtstringOptionalThe timestamp indicating when the batch request was made.
Format: date-time
resultsarrayRequired within parentAn array of HubDbTableRowV3 objects representing the results of the batch operation.
results[]ModelEach itemExpand Clone a row — response body
startedAtstringRequired within parentThe timestamp indicating when the batch processing began.
Format: date-time
statusstringRequired within parentThe current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.
Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Clone a row — response body

Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING
FieldTypePresenceDescription and constraints
$objectRoot
completedAtstringRequired within parentThe timestamp indicating when the batch processing was completed.
Format: date-time
errorsarrayOptionalAn array of StandardError objects detailing any errors encountered during the batch operation.
errors[]ModelEach itemExpand Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
linksobjectOptionalA collection of related links associated with the batch response.
Additional keys: see wildcard field
links.*stringAdditional keys
numErrorsJSONOptional
numErrors (anyOf 1)integerAlternativeThe number of errors encountered during the batch operation.
Format: int32
numErrors (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAtstringOptionalThe timestamp indicating when the batch request was made.
Format: date-time
resultsarrayRequired within parentAn array of HubDbTableRowV3 objects representing the successful results of the batch operation.
results[]ModelEach itemExpand Clone a row — response body
startedAtstringRequired within parentThe timestamp indicating when the batch processing began.
Format: date-time
statusstringRequired within parentThe current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.
Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Clone a row — response body, Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Add a new row to a table — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
childTableIdintegerRequired within parentSpecifies the value for the column child table id
Format: int64
displayIndexintegerRequired within parentThe index position for displaying the row within the table.
Format: int32
namestringOptionalSpecifies the value for `hs_name` column, which will be used as title in the dynamic pages
pathstringOptionalSpecifies the value for `hs_path` column, which will be used as slug in the dynamic pages
valuesobjectRequired within parentList of key value pairs with the column name and column value
Additional keys: see wildcard field
values.*ModelAdditional keysExpand List tags — response body

Referenced models: List tags — response body

Clone a row — response body
FieldTypePresenceDescription and constraints
$objectRoot
childTableIdstringRequired within parentSpecifies the value for the column child table id
createdAtstringRequired within parentTimestamp at which the row is created
Format: date-time
idstringRequired within parentThe id of the table row
namestringRequired within parentSpecifies the value for `hs_name` column, which will be used as title in the dynamic pages
pathstringRequired within parentSpecifies the value for `hs_path` column, which will be used as slug in the dynamic pages
publishedAtstringRequired within parentThe timestamp indicating when the row was last published, in date-time format.
Format: date-time
updatedAtstringRequired within parentTimestamp at which the row is updated last time
Format: date-time
valuesobjectRequired within parentList of key value pairs with the column name and column value
Additional keys: see wildcard field
values.*objectAdditional keys
Get a set of rows — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
FieldTypePresenceDescription and constraints
$objectRootYe olde error
categorystringRequired within parentSpecifies the main category of the error, determining the broad area of issue.
contextobjectRequired within parentAn object containing context-specific information pertinent to the error.
Additional keys: see wildcard field
context.*arrayAdditional keys
context.*[]stringEach item
errorsarrayRequired within parentThe detailed error objects.
errors[]ModelEach itemExpand Batch insert events — response body — errors item errors item
idstringOptionalThe unique ID of the error instance.
linksobjectRequired within parentAn object containing links related to the error, such as documentation URLs or support contact pages.
Additional keys: see wildcard field
links.*stringAdditional keys
messagestringRequired within parentA detailed message describing the error.
statusstringRequired within parentThe HTTP status code associated with the error.
subCategoryobjectOptionalIdentifies the subcategory of the error, providing more specific context within the main category.

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

List tags — response body
FieldTypePresenceDescription and constraints
$objectRoot
Batch insert events — response body — errors item errors item
FieldTypePresenceDescription and constraints
$objectRootRepresents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
codestringOptionalThe status code associated with the error detail
contextobjectOptionalContext about the error condition
Additional keys: see wildcard field
context.*arrayAdditional keys
context.*[]stringEach item
instringOptionalThe name of the field or parameter in which the error was found.
messagestringRequired within parentA human readable message describing the error along with remediation steps where appropriate
subCategorystringOptionalA specific category that contains more specific detail about the error

SDK function policy ID: hubspot.hubdb_batch_create_rows_draft. Catalog operation: hubdb_batch_create_rows_draft. 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: ["hubdb.rows.write"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.