HubSpot: Clone a campaign

← Campaigns operations · Get started

Operation hubspot.campaigns_clone_campaign

Provider route: POST /marketing/campaigns/2026-09/clone. 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"]["cloneCampaign"]>[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.cloneCampaign(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.clone_campaign(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 Clone a campaign — request body — body

Referenced models: Clone a campaign — 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
$	Model	Root	Expand Clone a campaign — response body

Referenced models: Clone a campaign — response body

Schemas

Clone a campaign — response body

Field	Type	Presence	Description and constraints
$	object	Root
campaignGuid	string	Required within parent	The unique identifier for the newly cloned campaign.
status	string	Required within parent	The status of the cloning operation. Valid values include 'PENDING', 'COMPLETE', 'FAILED', and 'PARTIAL_FAILURE'. Known values: COMPLETE, FAILED, PARTIAL_FAILURE, PENDING

Clone a campaign — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
assetsToClone	object	Required within parent	A map of asset types to be cloned, where each key is an asset type and the value is an array of asset identifiers. It is an object. Additional keys: see wildcard field
assetsToClone.*	array	Additional keys
assetsToClone.*[]	string	Each item
audience	string	Optional	The target audience for the cloned campaign. It is a string.
currencyCode	string	Optional	The currency code for the cloned campaign's budget. It is a string. This value is optional.
endDate	string	Optional	The end date for the cloned campaign. It is a string in ISO 8601 format (YYYY-MM-DD). If omitted, this will match the start date of the source campaign.
name	string	Required within parent	The name for the new cloned campaign. It is a string. The name needs to be unique compared to other campaigns in the portal.
notes	string	Optional	Additional notes or comments about the cloned campaign. It is a string. This value is optional.
shouldCloneDraftNodes	boolean	Required within parent	A boolean indicating whether draft nodes should be cloned. By default this is true.
shouldCloneEdges	boolean	Required within parent	A boolean indicating whether edges should be cloned. By default this is true.
shouldCloneStickyNotes	boolean	Required within parent	A boolean indicating whether sticky notes should be cloned. By default this is true.
shouldCloneTasks	boolean	Required within parent	A boolean indicating whether tasks should be cloned. By default this is true.
shouldCloneTrackingUrls	boolean	Required within parent	A boolean indicating whether tracking URLs should be cloned. By default this is true.
sourceCampaignGuid	string	Required within parent	The unique identifier of the campaign to be cloned. It is a string.
startDate	string	Optional	The start date for the cloned campaign. It is a string in ISO 8601 format (YYYY-MM-DD). If omitted, this will match the start date of the source campaign.

Policy, approvals and errors

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