Skip to content

HubSpot: Upsert batch objects — tickets batch Upsert Tickets

HubSpot tickets.batchUpsertTickets: arguments, response, policy and SDK examples.

← Tickets operations · Get started

Operation hubspot.tickets_batch_upsert_tickets

Provider route: POST /crm/objects/2026-09/tickets/batch/upsert. 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["tickets"]["batchUpsertTickets"]>[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.tickets.batchUpsertTickets(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.tickets.batch_upsert_tickets(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Upsert batch objects — tickets batch Upsert Tickets — request body — body

Referenced models: Upsert batch objects — tickets batch Upsert Tickets — 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 Upsert batch objects — tickets.batchUpsertTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tickets Batch Response Simple Public Upsert Object
$ (anyOf 2)ModelAlternativeExpand Upsert batch objects — tickets.batchUpsertTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tickets Batch Response Simple Public Upsert Object With Errors

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

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

Upsert batch objects — tickets.batchUpsertTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tickets Batch Response Simple Public Upsert Object
FieldTypePresenceDescription and constraints
$objectRootRepresents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.
completedAtstringRequired within parentThe date and time when the batch operation was completed, in ISO 8601 format.
Format: date-time
linksobjectOptionalA map of link names to associated URIs providing additional information or actions related to the batch operation.
Additional keys: see wildcard field
links.*stringAdditional keys
requestedAtstringOptionalThe date and time when the batch operation was requested, in ISO 8601 format.
Format: date-time
resultsarrayRequired within parentAn array of objects representing the results of the upsert operation. Each object is a SimplePublicUpsertObject.
results[]ModelEach itemExpand Upsert batch objects — tickets.batchUpsertTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAtstringRequired within parentThe date and time when the batch operation started, in ISO 8601 format.
Format: date-time
statusstringRequired within parentThe status of the batch processing request. The expected value is "COMPLETE".
Known values: CANCELED, COMPLETE, PENDING, PROCESSING

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

Upsert batch objects — tickets.batchUpsertTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tickets Batch Response Simple Public Upsert Object With Errors
FieldTypePresenceDescription and constraints
$objectRootRepresents the response from a batch upsert operation, including the status, timestamps, successfully processed objects, and any errors that occurred during processing.
completedAtstringRequired within parentThe date and time when the batch operation was completed, in ISO 8601 format.
Format: date-time
errorsarrayOptionalAn array of StandardError objects detailing any errors that occurred during the batch upsert operation.
errors[]ModelEach itemExpand Read batch objects — tickets.batchGetTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
linksobjectOptionalA map of link names to associated URIs, providing additional resources or documentation related to the batch operation.
Additional keys: see wildcard field
links.*stringAdditional keys
numErrorsJSONOptional
numErrors (anyOf 1)integerAlternativeThe total number of errors encountered during the batch upsert operation.
Format: int32
numErrors (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAtstringOptionalThe date and time when the batch operation was requested, in ISO 8601 format.
Format: date-time
resultsarrayRequired within parentAn array of SimplePublicUpsertObject items representing the results of the batch upsert operation.
results[]ModelEach itemExpand Upsert batch objects — tickets.batchUpsertTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
startedAtstringRequired within parentThe date and time when the batch operation started, in ISO 8601 format.
Format: date-time
statusstringRequired within parentThe 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 — tickets.batchUpsertTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item, Read batch objects — tickets.batchGetTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Upsert batch objects — tickets batch Upsert Tickets — request body — body
FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
inputsarrayRequired within parentAn array of SimplePublicObjectBatchInputUpsert objects, each containing the properties and unique identifiers needed to create or update a CRM object.
inputs[]ModelEach itemExpand Upsert batch objects — tickets batch Upsert Tickets — request body — body inputs item

Referenced models: Upsert batch objects — tickets batch Upsert Tickets — request body — body inputs item

Upsert batch objects — tickets.batchUpsertTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING results item
FieldTypePresenceDescription and constraints
$objectRootRepresents a CRM object that has either been created or updated (upserted)
archivedbooleanRequired within parentA boolean indicating whether this object is archived.
archivedAtstringOptionalThe date and time when this object was archived, in ISO 8601 format.
Format: date-time
createdAtstringRequired within parentThe date and time when this object was created, in ISO 8601 format.
Format: date-time
idstringRequired within parentThe unique identifier for this object, represented as a string.
newbooleanRequired within parentA boolean indicating whether this object was newly created (true) or updated (false) during the upsert operation.
objectWriteTraceIdstringOptionalA string used to trace the write operation that affected this object.
propertiesobjectRequired within parentA map of property names to their current values, with each value represented as a string.
Additional keys: see wildcard field
properties.*stringAdditional keys
propertiesWithHistoryobjectOptionalA map of property names to their historical values, where each value is an array of objects containing the value and the timestamp of when it was set.
Additional keys: see wildcard field
propertiesWithHistory.*arrayAdditional keys
propertiesWithHistory.*[]ModelEach itemExpand Read — tickets get Ticket — response body — properties With History value item
updatedAtstringRequired within parentThe date and time when this object was last updated, in ISO 8601 format.
Format: date-time
urlstringOptionalA string representing the URL of this object.
warningsarrayOptionalAn array of warnings related to this object, where each warning includes a category, message, and context.
warnings[]ModelEach itemExpand Read — fees get Fee — response body — warnings item

Referenced models: Read — fees get Fee — response body — warnings item, Read — tickets get Ticket — response body — properties With History value item

Read batch objects — tickets.batchGetTickets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
FieldTypePresenceDescription and constraints
$objectRootRepresents a standard error response in the HubSpot API, providing detailed information about an error that occurred during an API request.
categorystringRequired within parentA string that categorizes the type of error.
contextobjectRequired within parentAn object containing additional context about the error, with each key mapping to an array of strings.
Additional keys: see wildcard field
context.*arrayAdditional keys
context.*[]stringEach item
errorsarrayRequired within parentAn array of ErrorDetail objects, each providing further information about specific aspects of the error.
errors[]ModelEach itemExpand Batch insert events — response body — errors item errors item
idstringOptionalA string representing the unique identifier for the error.
linksobjectRequired within parentAn object mapping link names to associated URIs that contain documentation or recommended remediation steps for the error.
Additional keys: see wildcard field
links.*stringAdditional keys
messagestringRequired within parentA string containing a human-readable message describing the error.
statusstringRequired within parentA string indicating the status of the error.
subCategoryobjectOptionalAn object providing more specific categorization of the error.

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

Upsert batch objects — tickets batch Upsert Tickets — request body — body inputs item
FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
idstringRequired within parentA string representing the unique identifier for the CRM object.
idPropertystringOptionalThe name of a property whose values are unique for this object
objectWriteTraceIdstringOptionalA string used to trace the write operation for the object, useful for debugging or tracking changes.
propertiesobjectRequired within parentAn object containing key-value pairs where keys are property names and values are property values for the CRM object. Each property is a string.
Additional keys: see wildcard field
properties.*stringAdditional keys

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