HubSpot: Update a batch of goal targets by internal ID, or unique property values
HubSpot goalTargets.batchUpdateGoalTargets: arguments, response, policy and SDK examples.
← Goal targets operations · Get started
Operation hubspot.goal_targets_batch_update_goal_targets
Provider route: POST /crm/objects/2026-09/goal_targets/batch/update. 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["goalTargets"]["batchUpdateGoalTargets"]>[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.goalTargets.batchUpdateGoalTargets(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.goal_targets.batch_update_goal_targets(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 Update a batch of goal targets by internal ID, or unique property values — request body — body |
Referenced models: Update a batch of goal targets by internal ID, or unique property values — 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 Create a batch of goal targets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Goal Targets Batch Response Simple Public Object |
$ (anyOf 2) | Model | Alternative | Expand Create a batch of goal targets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Goal Targets Batch Response Simple Public Object With Errors |
Referenced models: Create a batch of goal targets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Goal Targets Batch Response Simple Public Object, Create a batch of goal targets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Goal Targets Batch Response Simple Public Object With Errors
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
Update a batch of goal targets by internal ID, or unique property values — 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 optional associations for a CRM object to be processed in the batch. |
inputs[] | Model | Each item | Expand Update a batch of goal targets by internal ID, or unique property values — request body — body inputs item |
Referenced models: Update a batch of goal targets by internal ID, or unique property values — request body — body inputs item
Create a batch of goal targets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Goal Targets 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 are the result of the batch operation. |
results[] | Model | Each item | Expand Merge goal targets — 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: Merge goal targets — response body
Create a batch of goal targets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Goal Targets 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 errors that occurred during the batch operation, each represented by a StandardError object. |
errors[] | Model | Each item | Expand Create a batch of goal targets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item |
links | object | Optional | A map of link names to associated URIs, providing 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 that occurred 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 simple public objects that were processed in the batch operation. |
results[] | Model | Each item | Expand Merge goal targets — 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 a batch of goal targets — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Merge goal targets — response body
Update a batch of goal targets by internal ID, or unique property values — 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 | The id to be updated. This can be the object id, or the unique property value of the idProperty property |
idProperty | string | Optional | The name of a property whose values are unique for this object |
objectWriteTraceId | string | Optional | A string 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. Each property is a string. Additional keys: see wildcard field |
properties.* | string | Additional keys |
Merge goal targets — 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 an array of their historical values, each with a timestamp and source information. Additional keys: see wildcard field |
propertiesWithHistory.* | array | Additional keys | |
propertiesWithHistory.*[] | Model | Each item | Expand Merge goal targets — 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, each containing a category, message, and context. |
warnings[] | Model | Each item | Expand Merge goal targets — response body — warnings item |
Referenced models: Merge goal targets — response body — warnings item, Merge goal targets — response body — properties With History value item
Create a batch of goal targets — 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 context about the error condition, with additional properties 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 that provide additional 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 this error instance. |
links | object | Required within parent | An object mapping link names to associated URIs containing 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 details about the error category. |
Referenced models: Batch insert events — response body — errors item errors item
Merge goal targets — 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 indicating the category of the warning. |
context | object | Required within parent | An object providing additional context for the warning, with string values for each context key. Additional keys: see wildcard field |
context.* | string | Additional keys | |
message | string | Required within parent | A string containing the warning message. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: hubspot.goal_targets_batch_update_goal_targets. Catalog operation: goal_targets_batch_update_goal_targets. 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.goals.write"]