Skip to content

CLI command

tinbox create-segment

Save a multi-condition SEGMENT of an audience (a reusable rule-based slice, e.g. 'members tagged vip who opened the last campaign'). Requires a human approval step in chat — the approval card shows the segment name and how many members currently match (a live preview of the conditions). For a 'saved' segment, provide `conditions` (a match mode + rules); a 'static' segment has none (members are added manually later). To just PREVIEW reach without saving, use preview_segment instead. `newsletter:send` permission is required.

Generated from tool: create_segment

Usage

sh
tinbox create-segment --audienceId <audienceId> --name <name> --type <type> --conditions <conditions>

Flags

NameTypeRequiredDefaultDescription
--audienceIdstringyes—The audience the segment belongs to.
--namestringyes—A name for the segment.
--typestringyes—'saved' (rule-based, default) or 'static' (manual membership).
--conditionsstringyes—The rule tree for a saved segment (omit for static).