Delete campaign

Removes one campaign of the caller's org and answers 204 with no body.

DELETE /v1/campaign/{id}

Campaign → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/campaign/{id}`
Method	`DELETE`
Operation	`delete_campaign_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Removes one campaign of the caller's org and answers 204 with no body. 404 when the org has no campaign with that id.

It deletes the RECORD, not the executions: a campaign whose channels are live on a provider should be paused first, or those executions keep running with nothing here to report them.

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the campaign's server-minted handle, "cmp_"-prefixed.

Response

Status	Body	Meaning
`204`	—	no content
`default`	problem-details	refused

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo campaign rm <id>

.ts

.py

.go

.rs

.java

import { Configuration, CampaignApi } from 'hanzoai';

const api = new CampaignApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.deleteCampaignById({ id: 'id' });

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CampaignApi(client).delete_campaign_by_id(id='id')

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

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

use hanzo_client::apis::{configuration::Configuration, campaign_api};

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

let result = campaign_api::delete_campaign_by_id(&cfg, Default::default()).await?;

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

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new CampaignApi(client).deleteCampaignById();

curl -X DELETE https://api.hanzo.ai/v1/campaign/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches campaign through the campaign tool, which names its 9 operations with its own verbs — this one among them, under a name only MCP 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_campaigns"
         }
       }
     }'

Campaign API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousDelete channels NextList metrics