HubSpot: Batch update campaigns

← Campaigns operations · Get started

Operation hubspot.campaigns_batch_update_campaigns

Provider route: POST /marketing/campaigns/2026-09/batch/update. Alter supplies the connection’s credentials and routing.

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["campaigns"]["batchUpdateCampaigns"]>[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.campaigns.batchUpdateCampaigns(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.campaigns.batch_update_campaigns(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Batch update campaigns — request body — body

Referenced models: Batch update campaigns — request body — body

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 campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign
$ (anyOf 2)	Model	Alternative	Expand Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign With Errors

Referenced models: Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign, Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign With Errors

Schemas

Batch update campaigns — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of PublicCampaignBatchUpdateItem objects, each containing the details required to update a specific campaign.
inputs[]	Model	Each item	Expand Batch update campaigns — request body — body inputs item

Referenced models: Batch update campaigns — request body — body inputs item

Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign

Field	Type	Presence	Description and constraints
$	object	Root
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 that provide additional 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 public campaign objects that represent the results of the batch operation.
results[]	Model	Each item	Expand Create a campaign — 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 campaign — response body

Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign With Errors

Field	Type	Presence	Description and constraints
$	object	Root
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 standard error objects detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Batch create campaigns — 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 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 public campaign objects representing the results of the batch operation.
results[]	Model	Each item	Expand Create a campaign — 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: Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Create a campaign — response body

Batch update campaigns — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the campaign to be updated. It is a string.
properties	object	Required within parent	An object containing key-value pairs of the campaign properties to be updated. Each key is a property name, and each value is the new value for that property, represented as a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Create a campaign — response body

Field	Type	Presence	Description and constraints
$	object	Root
businessUnits	array	Required within parent	An array of business units associated with the campaign, where each business unit is represented by its unique identifier.
businessUnits[]	Model	Each item	Expand Create a campaign — response body — business Units item
createdAt	string	Required within parent	The date and time when the campaign was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the campaign.
properties	object	Required within parent	A map of custom property names to their values, representing specific attributes of the campaign. Additional keys: see wildcard field
properties.*	string	Additional keys
updatedAt	string	Required within parent	The date and time when the campaign was last updated, in ISO 8601 format. Format: date-time

Referenced models: Create a campaign — response body — business Units item

Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	A string categorizing the type of error.
context	object	Required within parent	An object containing additional context about the error, with keys as context names and values 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 providing further information about the error.
errors[]	Model	Each item	Expand Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item
id	string	Optional	A string representing a unique identifier for the error.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation or remediation steps related to the error. 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 categorization of the error.

Referenced models: Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item

Create a campaign — response body — business Units item

Field	Type	Presence	Description and constraints
$	object	Root
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	The unique identifier for the business unit, represented as a 64-bit integer. Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents 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.
code	string	Optional	The status code associated with the error detail. This is a string.
context	object	Optional	Context about the error condition, provided as an object where each key is a context name and the value is an array of strings providing additional information. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
in	string	Optional	The name of the field or parameter in which the error was found. This is a string.
message	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate. This is a string.
subCategory	string	Optional	A specific category that contains more specific detail about the error. This is a string.

Policy, approvals and errors

SDK function policy ID: hubspot.campaigns_batch_update_campaigns. Catalog operation: campaigns_batch_update_campaigns. 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: ["marketing.campaigns.write"]

Official provider source