Hanzo AIDocs
Sign inAPI key

Create audiences

Saves a cohort filter for the caller's org.

POST /v1/marketing/audiences

Marketing → · All API references → · Get started →

Addresshttps://api.hanzo.ai/v1/marketing/audiences
MethodPOST
Operationpost_marketing_audiences
AuthAuthorization: Bearer $HANZO_API_KEY

Saves a cohort filter for the caller's org. Name is required. Omitting event saves the WHOLE-ORG audience — every mailable customer — which needs no analytics warehouse; naming one narrows that roster to the customers who fired it within windowDays.

Request

6 fields, body application/json (required).

FieldInTypeRequiredDescription
createdAtbodyinteger (int64)—CreatedAt is unix seconds when the filter was saved, server-assigned.
eventbodystring—Event is the analytics event a member must have fired.
idbodystring—ID is the server-assigned audience id ("aud_" + 128 random bits).
namebodystring—Name is the audience's label.
updatedAtbodyinteger (int64)—UpdatedAt is unix seconds of the last write, server-assigned, and the key the audience list is ordered by (newest first).
windowDaysbodyinteger (int64)—WindowDays is how far back the event counts, ending now.

Response

StatusBodyMeaning
200marketing.Audienceok
defaultproblem-detailsrefused

200 body — 6 fields.

FieldInTypeAlwaysDescription
createdAtbodyinteger (int64)—CreatedAt is unix seconds when the filter was saved, server-assigned.
eventbodystring—Event is the analytics event a member must have fired.
idbodystring—ID is the server-assigned audience id ("aud_" + 128 random bits).
namebodystring—Name is the audience's label.
updatedAtbodyinteger (int64)—UpdatedAt is unix seconds of the last write, server-assigned, and the key the audience list is ordered by (newest first).
windowDaysbodyinteger (int64)—WindowDays is how far back the event counts, ending now.

Failure carries the platform error shape — see Errors.

Examples

hanzo marketing audiences create
import { Configuration, MarketingApi } from 'hanzoai';

const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postMarketingAudiences({ createdAt: 0, event: "<event>" });
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_audiences(created_at=0, event="<event>")
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.MarketingAPI.PostMarketingAudiences(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_audiences(&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).postMarketingAudiences();
curl -X POST https://api.hanzo.ai/v1/marketing/audiences \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "createdAt": 0,
       "event": "<event>"
     }'

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?
PreviousList unsubscribeNextCreate calendar