Skip to content

HubSpot: Update a campaign

HubSpot campaigns.updateCampaign: arguments, response, policy and SDK examples.

← Campaigns operations · Get started

Operation hubspot.campaigns_update_campaign

Provider route: PATCH /marketing/campaigns/2026-09/{campaignGuid}. 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["campaigns"]["updateCampaign"]>[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.updateCampaign(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.update_campaign(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.campaignGuidstringRequired within parent
bodyModelRequired within parentExpand Create a campaign — request body — body

Referenced models: Create a campaign — 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
$ModelRootExpand Create a campaign — response body

Referenced models: Create a campaign — response body

Create a campaign — response body
FieldTypePresenceDescription and constraints
$objectRoot
businessUnitsarrayRequired within parentAn array of business units associated with the campaign, where each business unit is represented by its unique identifier.
businessUnits[]ModelEach itemExpand Create a campaign — response body — business Units item
createdAtstringRequired within parentThe date and time when the campaign was created, in ISO 8601 format.
Format: date-time
idstringRequired within parentThe unique identifier for the campaign.
propertiesobjectRequired within parentA map of custom property names to their values, representing specific attributes of the campaign.
Additional keys: see wildcard field
properties.*stringAdditional keys
updatedAtstringRequired within parentThe 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

Create a campaign — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
propertiesobjectRequired within parentAn object containing key-value pairs where each key is a property name and each value is a string representing the property's value. This object holds the various attributes of the campaign.
Additional keys: see wildcard field
properties.*stringAdditional keys
Create a campaign — response body — business Units item
FieldTypePresenceDescription and constraints
$objectRoot
idJSONRequired within parent
id (anyOf 1)integerAlternativeThe unique identifier for the business unit, represented as a 64-bit integer.
Format: int64
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

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.