AlmondTill/G3N API

Segment

The Segment family — 7 operations.

A segment is a saved audience — a named group of shoppers for marketing and outreach. A static segment is curated by hand with the add/remove member actions; a dynamic segment stores a rule (interests, loyalty tier, consent purposes, preferred locations, upcoming birthdays, purchase history) and re-materializes its membership each time you refresh it, with manual exclusions subtracted after matching.

Operations

OperationKindWhat it does
createSegmentmutationCreate a customer segment for marketing — a named group of shoppers you add members to.
deactivateSegmentmutationStage a segment — it stays editable but marked inactive.
doomSegmentmutationPermanently retire a segment — its membership list dies with it.
reactivateSegmentmutationBring a staged segment back to active.
segmentqueryLook up one customer segment.
segmentsqueryYour organization group’s customer segments, newest first.
updateSegmentmutationRename a customer segment — the label only; membership is unchanged.