Create suppressions

Records an opt-out for the org (admin / self-service management).

POST /v1/marketing/suppressions

Marketing → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/marketing/suppressions`
Method	`POST`
Operation	`post_marketing_suppressions`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Records an opt-out for the org (admin / self-service management). Address is required; channel defaults to email. It is idempotent: re-suppressing the same tuple keeps the original record rather than erroring. From here on the ONE send gate refuses that recipient on that channel.

Request

4 fields, body application/json (required).

Field	In	Type	Required	Description
`address`	body	string	—	Address is the recipient, normalized (lower-cased, trimmed) so an opt-out cannot be slipped past on a case or whitespace difference.
`channel`	body	string	—	Channel is the surface opted out of: email, sms, social, meta, google or tiktok.
`createdAt`	body	integer (int64)	—	CreatedAt is unix seconds, server-assigned.
`reason`	body	string	—	Reason is a free-text note, capped at 1024 bytes.

Response

Status	Body	Meaning
`200`	marketing.Suppression	ok
`default`	problem-details	refused

200 body — 4 fields.

Field	In	Type	Always	Description
`address`	body	string	—	Address is the recipient, normalized (lower-cased, trimmed) so an opt-out cannot be slipped past on a case or whitespace difference.
`channel`	body	string	—	Channel is the surface opted out of: email, sms, social, meta, google or tiktok.
`createdAt`	body	integer (int64)	—	CreatedAt is unix seconds, server-assigned.
`reason`	body	string	—	Reason is a free-text note, capped at 1024 bytes.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo marketing suppressions create

.ts

.py

.go

.rs

.java

import { Configuration, MarketingApi } from 'hanzoai';

const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postMarketingSuppressions({ address: "<address>", 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).post_marketing_suppressions(address="<address>", channel="<channel>")

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

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

use hanzo_client::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::post_marketing_suppressions(&cfg, Default::default()).await?;

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

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

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

curl -X POST https://api.hanzo.ai/v1/marketing/suppressions \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "address": "<address>",
       "channel": "<channel>"
     }'

MCP reaches marketing through the marketing tool, which names its 35 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_marketing_audiences"
         }
       }
     }'

Marketing API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousCreate sequences NextReplace calendar