Skip to main content
The formo segments command group lets you manage user segments. Segments are saved audience filter sets that you can use throughout the Formo platform.

​
formo segments list

List all user segments for the project.
Requires segments:read scope on your API key.
formo segments list

​
formo segments create

Create a new user segment.
Requires segments:write scope on your API key.

​
Options

OptionTypeRequiredDescription
--titlestring✅Segment title
--filterSetsstring✅JSON array of filter set strings defining the segment

​
Examples

# Create a high-value segment
formo segments create \
  --title "Whales" \
  --filterSets '["net_worth_usd > 100000"]'

# Create a power-user segment
formo segments create \
  --title "Power Users" \
  --filterSets '["tx_count > 100", "num_sessions > 10"]'

​
formo segments delete

Delete a user segment.
Requires segments:write scope on your API key.

​
Arguments

ArgumentTypeRequiredDescription
segmentIdstring✅Segment ID to delete
formo segments delete seg_abc123
Deleting a segment is permanent.