Create Audience
create_audienceCreate an audience from one or more existing segments. Audiences are the delivery payload — they have no subtype. To create typed cohorts (filter, matched, similarity, propensity), use create_segment instead. Accepts segment_refs: [{segment_id, role: include|exclude}] to compose the audience with per-segment inclusion/exclusion control. set_logic controls how include-role segments are combined (union or intersection). Returns audience_id, status and campaign_id immediately. Use record_count only for a verified count of this exact composition. Optional campaign_id links the new audience to that campaign (an audience belongs to at most one); omit it to leave the audience unlinked — link it later with link_audience_to_campaign. Requires 'creator' scope.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Human-readable audience name | |
| set_logic | No | How include-role segments are combined: 'union' (OR, default) or 'intersection' (AND) | union |
| campaign_id | No | Optional campaign to link the new audience to (see list_campaigns). An unknown ID is rejected with INVALID_CAMPAIGN_ID and nothing is created. | |
| record_count | No | Legacy caller-provided count for this exact composition. Prefer omitting it and calling recount_audience. The server may reuse a valid saved member count; otherwise record_count is null | |
| segment_refs | Yes | Array of segment references with roles. Must include at least one include-role segment. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| status | Yes | ||
| guidance | No | Interpretation or recovery guidance for this result | |
| set_logic | No | How included segments combine; excluded segments always subtract | |
| count_unit | No | ||
| page_count | No | Number of objects on this page, not the organization total | |
| audience_id | Yes | ||
| campaign_id | No | ||
| count_state | No | Unknown means no count; available does not guarantee freshness. Recount for a current value. | |
| segment_ids | Yes | ||
| next_actions | No | Suggested next calls using returned IDs and available scopes. Not executed and not user consent. | |
| record_count | No | Saved composition count; null is unknown. Use recount_audience for a current value. | |
| money_display | No | Currency amounts formatted once from source paths ending in _cents. Use verbatim; do not divide again. Null/missing source amounts are omitted, not zero. | |
| population_input | No | Population input used for the preview; IDs refer to their current saved definitions | |
| excluded_segment_ids | Yes |