SegmentV2
A segment-v2 definition — a saved audience rule (static or dynamic) used to target customers for campaigns and automations.
Segments are versioned: a published SegmentV2 has an
activeVersion serving reads, while segmentV2SaveDraft
stages an unpublished draftVersion. Rebuilds are asynchronous — check
readyForCampaign or call segmentV2AssertReadyForCampaign
before targeting.
This is a read-only shadow surface (SEGMENTS_V2_ENABLED) — behavior may change before general availability.
SegmentV2Fields
Unique segment identifier.
Owning workspace/tenant id.
Display name shown in segment pickers.
Optional free-text description.
Lifecycle status (e.g. active, archived). See segmentV2Archive / segmentV2Unarchive.
Segment kind — static (explicit member list) or dynamic (rule-evaluated).
Version number currently serving reads and campaign targeting.
Unpublished version staged by segmentV2SaveDraft.
null when there is no pending draft.
Version currently being rebuilt, if any. Non-null means membership counts may be stale until the rebuild completes.
Internal keys this segment's rule depends on (e.g. referenced fields/segments).
Rebuild/evaluation state. See SegmentV2EvaluatorState.
How this segment is currently used (e.g. campaign targeting, general purpose).
Timestamp of the last time membership was read.
When true, membership enter/exit changes emit events for downstream
automations. Set via segmentV2SaveDraft.
User id that created this segment.
When this segment was created.
User id of the last editor.
When this segment was last modified.
true when the segment has a published active version and is not
currently rebuilding. Prefer segmentV2AssertReadyForCampaign
when checking multiple segments before launching a campaign.