Replaces a campaign's editable fields.

Replaces a campaign's editable fields. It is a full write, not a patch: every field takes the value in the body, and an omitted one is cleared.

PUT /v1/marketing/campaigns/{id}

Marketing → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/marketing/campaigns/{id}`
Method	`PUT`
Operation	`put_marketing_campaigns_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Replaces a campaign's editable fields. It is a full write, not a patch: every field takes the value in the body, and an omitted one is cleared. The id comes from the path — the body cannot retarget another campaign — and createdAt is never rewritten.

Request

11 fields, body application/json (required).

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the server-assigned campaign id ("camp_" + 128 random bits).
`budget`	body	integer	—	Budget is what the campaign is allowed to cost, in USD cents.
`channel`	body	string	—	Channel is the delivery surface: email, sms, social, meta, google or tiktok.
`createdAt`	body	integer	—	CreatedAt is unix seconds when the campaign was registered.
`id`	body	string	—	ID is the server-assigned campaign id ("camp_" + 128 random bits).
`name`	body	string	—	Name is the campaign's label.
`objective`	body	string	—	Objective is the free-text goal ("signups"), capped at 1024 bytes.
`scheduledAt`	body	integer	—	ScheduledAt is the unix send time; 0 means unscheduled.
`spend`	body	integer	—	Spend is what the campaign has cost so far, in USD cents, clamped to >= 0.
`status`	body	string	—	Status is the lifecycle: draft, scheduled, active, paused or completed.
`updatedAt`	body	integer	—	UpdatedAt is unix seconds of the last write.

Response

Status	Body	Meaning
`200`	Campaign	ok

200 body — 10 fields.

Field	In	Type	Always	Description
`budget`	body	integer	—	Budget is what the campaign is allowed to cost, in USD cents.
`channel`	body	string	—	Channel is the delivery surface: email, sms, social, meta, google or tiktok.
`createdAt`	body	integer	—	CreatedAt is unix seconds when the campaign was registered.
`id`	body	string	—	ID is the server-assigned campaign id ("camp_" + 128 random bits).
`name`	body	string	—	Name is the campaign's label.
`objective`	body	string	—	Objective is the free-text goal ("signups"), capped at 1024 bytes.
`scheduledAt`	body	integer	—	ScheduledAt is the unix send time; 0 means unscheduled.
`spend`	body	integer	—	Spend is what the campaign has cost so far, in USD cents, clamped to >= 0.
`status`	body	string	—	Status is the lifecycle: draft, scheduled, active, paused or completed.
`updatedAt`	body	integer	—	UpdatedAt is unix seconds of the last write.

Failure carries the platform error shape — see Errors.

Examples

hanzo marketing campaigns set <id>

import { Configuration, MarketingApi } from 'hanzoai';

const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.putMarketingCampaignsById({ id: 'id', budget: 0, channel: "<channel>" });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import MarketingApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MarketingApi(client).put_marketing_campaigns_by_id(id='id', budget=0, channel="<channel>")

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.MarketingAPI.PutMarketingCampaignsById(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_cloud::apis::{configuration::Configuration, marketing_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = marketing_api::put_marketing_campaigns_by_id(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MarketingApi;

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new MarketingApi(client).putMarketingCampaignsById();

curl -X PUT https://api.hanzo.ai/v1/marketing/campaigns/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "budget": 0,
       "channel": "<channel>"
     }'

The door reaches marketing through the marketing tool, which names its 35 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_marketing_audiences"
         }
       }
     }'

Marketing API · All Hanzo APIs · Interactive reference

Replaces a campaign's editable fields.

Request

Response

Examples

On this page