HubSpot: Create a campaign
HubSpot campaigns.createCampaign: arguments, response, policy and SDK examples.
← Campaigns operations · Get started
Operation hubspot.campaigns_create_campaign
Provider route: POST /marketing/campaigns/2026-09. 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["campaigns"]["createCampaign"]>[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.createCampaign(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.campaigns.create_campaign(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 Create a campaign — request body — body |
Referenced models: Create a campaign — 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 |
|---|---|---|---|
$ | Model | Root | Expand Create a campaign — response body |
Referenced models: Create a campaign — response body
Schemas
Section titled “Schemas”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
Create a campaign — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
properties | object | Required within parent | An 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.* | string | Additional keys |
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]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: hubspot.campaigns_create_campaign. Catalog operation: campaigns_create_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"]