Skip to content

HubSpot: Update a batch of tasks by internal ID, or unique property values

HubSpot tasks.batchUpdateTasks: arguments, response, policy and SDK examples.

← Tasks operations · Get started

Operation hubspot.tasks_batch_update_tasks

Provider route: POST /crm/objects/2026-09/tasks/batch/update. 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["tasks"]["batchUpdateTasks"]>[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.tasks.batchUpdateTasks(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.tasks.batch_update_tasks(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
bodyModelRequired within parentExpand Update a batch of tasks by internal ID, or unique property values — request body — body

Referenced models: Update a batch of tasks by internal ID, or unique property values — 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 Create a batch of tasks — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tasks Batch Response Simple Public Object
$ (anyOf 2)ModelAlternativeExpand Create a batch of tasks — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tasks Batch Response Simple Public Object With Errors

Referenced models: Create a batch of tasks — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tasks Batch Response Simple Public Object, Create a batch of tasks — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tasks Batch Response Simple Public Object With Errors

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

Create a batch of tasks — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tasks Batch Response Simple Public Object
FieldTypePresenceDescription and constraints
$objectRootA public object batch response object
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 that provide 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 SimplePublicObject items that represent the results of the batch operation.
results[]ModelEach itemExpand Create — tasks create Task — response body
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: Create — tasks create Task — response body

Create a batch of tasks — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Tasks Batch Response Simple Public Object With Errors
FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
completedAtstringRequired within parentThe date and time when the batch operation was completed, in ISO 8601 format.
Format: date-time
errorsarrayOptionalAn array of errors encountered during the batch operation, each represented as a StandardError.
errors[]ModelEach itemExpand Create a batch of tasks — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
linksobjectOptionalA map of link names to associated URIs, providing additional context or resources related to the batch operation.
Additional keys: see wildcard field
links.*stringAdditional keys
numErrorsJSONOptional
numErrors (anyOf 1)integerAlternativeThe number of errors that occurred during the batch 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 results from the batch operation, each represented as a SimplePublicObject.
results[]ModelEach itemExpand Create — tasks create Task — response body
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: Create — tasks create Task — response body, Create a batch of tasks — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Update a batch of tasks by internal ID, or unique property values — request body — body
FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
inputsarrayRequired within parentAn array of SimplePublicObjectBatchInput items, each representing an object to be updated. Each item contains the properties and identifiers necessary for the update.
inputs[]ModelEach itemExpand Update a batch of tasks by internal ID, or unique property values — request body — body inputs item

Referenced models: Update a batch of tasks by internal ID, or unique property values — request body — body inputs item

Create — tasks create Task — response body
FieldTypePresenceDescription and constraints
$objectRootA simple public object.
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.
objectWriteTraceIdstringOptionalA string used to trace the write operations for this object.
propertiesobjectRequired within parentA map of property names to their values, where each value is a string.
Additional keys: see wildcard field
properties.*stringAdditional keys
propertiesWithHistoryobjectOptionalA map of property names to arrays of historical values, each containing a value and its timestamp.
Additional keys: see wildcard field
propertiesWithHistory.*arrayAdditional keys
propertiesWithHistory.*[]ModelEach itemExpand Read — tasks get Task — 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 associated with this object.
warningsarrayOptionalAn array of warnings related to this object, each containing a category, message, and context.
warnings[]ModelEach itemExpand Read — tasks get Task — response body — warnings item

Referenced models: Read — tasks get Task — response body — warnings item, Read — tasks get Task — response body — properties With History value item

Create a batch of tasks — 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 categorizing the type of error.
contextobjectRequired within parentAn object containing additional context about the error, with keys as context names and values as arrays of strings.
Additional keys: see wildcard field
context.*arrayAdditional keys
context.*[]stringEach item
errorsarrayRequired within parentAn array of ErrorDetail objects providing additional information about the error.
errors[]ModelEach itemExpand Batch insert events — response body — errors item errors item
idstringOptionalA string representing a unique identifier for this error instance.
linksobjectRequired within parentAn object mapping link names to associated URIs that provide documentation or remediation steps related to 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

Update a batch of tasks by internal ID, or unique property values — request body — body inputs item
FieldTypePresenceDescription and constraints
$objectRootContains an array of CRM object records to be processed in a batch operation, each defined by their ID and properties.
idstringRequired within parentThe id to be updated. This can be the object id, or the unique property value of the idProperty property
idPropertystringOptionalThe name of a property whose values are unique for this object
objectWriteTraceIdstringOptionalA string identifier used to trace the write operation for the object. This can be useful for debugging and tracking purposes.
propertiesobjectRequired within parentA map of property names to their values, representing the data fields of the CRM object. Each property is a key-value pair where the key is the property name and the value is a string.
Additional keys: see wildcard field
properties.*stringAdditional keys
Read — tasks get Task — response body — warnings item
FieldTypePresenceDescription and constraints
$objectRootRepresents a warning message related to a public object in HubSpot, providing details about the nature and context of the warning.
categorystringRequired within parentA string indicating the category of the warning.
contextobjectRequired within parentAn object providing additional context about the warning. This object can contain various key-value pairs, where each value is a string.
Additional keys: see wildcard field
context.*stringAdditional keys
messagestringRequired within parentA string containing the warning message.

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