Create Audience Segment
create_segmentCreate a new audience segment (named group of people) for the authenticated user. Set type='manual' for a hand-curated list (use add_to_segment to populate it), type='smart' with a config predicate (e.g. {title_contains:'VP'}) to define a dynamic segment resolved on-demand by resolve_segment, or pass template to pre-fill config from a built-in template (type defaults to 'smart'). Free — costs 0 credits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | User-facing segment name. Optional when `template` is supplied — the template's default name is used. | |
| type | No | Segment type. 'manual' = hand-curated person list. 'smart' = dynamic predicate (requires `config`). 'auto_stream' = system-managed from a stream. Defaults to 'smart' when `template` is provided. | |
| config | No | Predicate object for smart segments. Supported keys: title_contains, company_contains, company_industry, engaged_with_topics. Required when type='smart' and no template is supplied. | |
| template | No | Optional pre-built template id. Available: 'vp_plus' (VP+ decision-makers), 'c_suite' (C-suite executives), 'heads_of' ('Head of' leaders), 'founders' (Founders & co-founders), 'fintech_leaders' (Fintech leaders), 'agency_owners' (Agency owners). Pre-fills `config` and defaults `type` to 'smart'. Explicit `config` overrides template values on collision. | |
| description | No | Optional longer description | |
| source_stream_id | No | Optional stream that produced this segment (for traceability) |