CLI Common Flows

# 1. Get contacts in (one batch in Import History, named contacts.csv)
brew-cli contacts import-csv --file contacts.csv --consent-source import \
  --mapping "Email=email" --mapping "First Name=firstName"

# 2. Segment them
brew-cli audiences create --name "Newsletter" \
  --input '{"filters":{"filters":[{"field":"subscribed","operator":"equals","value":true}],"logicalOperator":"and"}}'

# 3. Generate the design with AI (30 to 90 seconds)
brew-cli emails generate --prompt "October product newsletter: three updates, one CTA to the changelog"

# 4. Send yourself a test before anything real happens
brew-cli emails send zavwOzhfWqE9HvALKd9bw --test --to you@yourcompany.com --subject "October newsletter preview"

# 5. Schedule the real send (the CLI asks you to confirm)
brew-cli emails send zavwOzhfWqE9HvALKd9bw --subject "What's new in October" \
  --audience m3ll218tvnk53pzei1axvn75fowpmvqd --domain tbfyoxx1bhlo563mqdeujwmx6afod8bk --schedule-at 2099-01-01T14:00:00Z

# 6. Watch it, or change your mind
brew-cli sends get VDDDYjldT4wLfJaaqQCoN
brew-cli sends cancel VDDDYjldT4wLfJaaqQCoN

# Read the design and its version history
brew-cli emails get zavwOzhfWqE9HvALKd9bw --include html,versions

# Tweak it with AI and keep iterating
brew-cli emails edit zavwOzhfWqE9HvALKd9bw --prompt "Tighten the intro to two sentences"

# Audit the saved design and inbox copy, then render it in real clients
brew-cli emails audit --email-id zavwOzhfWqE9HvALKd9bw \
  --subject "What's new in October" --sending-purpose marketing
brew-cli emails preview-clients zavwOzhfWqE9HvALKd9bw

# Where does it land: inbox or spam?
brew-cli emails create-inbox-placement-test zavwOzhfWqE9HvALKd9bw --domain tbfyoxx1bhlo563mqdeujwmx6afod8bk
brew-cli emails get-inbox-placement-results zavwOzhfWqE9HvALKd9bw --test-id ibp_xyz

# 1. Define the event your systems will send. Every payload needs an email field.
brew-cli automations triggers create --title "User signed up" \
  --input '{"payloadSchema":{"type":"object","fields":[{"key":"email","type":"string","required":true},{"key":"plan","type":"string","required":false}]}}'

# 2. Create the automation graph: trigger, then send
brew-cli automations create --input '{
  "name": "Welcome flow",
  "triggerEventId": "tev_abc123",
  "nodes": [
    {"id":"t1","label":"Signup","type":"trigger","config":{"mode":"event","triggerEventId":"tev_abc123"}},
    {"id":"s1","label":"Welcome email","type":"sendEmail","config":{"emailId":"zavwOzhfWqE9HvALKd9bw","emailVersionId":"iRTEW3YhFGh6j3ZYd2Ql6","domainId":"tbfyoxx1bhlo563mqdeujwmx6afod8bk","subject":"Welcome aboard","previewText":"Here is how to get started"}}
  ],
  "connections": [{"from":"t1","to":"s1"}]
}'

# 3. Test it safely (no real mail)
brew-cli automations test OcTszWzAApTlgdJWcSF0P --input '{"payload":{"email":"qa@yourcompany.com"}}'
# Read the returned automationRunId, replacing the example below
brew-cli automations runs get RUN_ID_FROM_TEST --include logs

brew-cli automations publish OcTszWzAApTlgdJWcSF0P

# 4. Check readiness, then fire the event
brew-cli automations triggers ready tev_abc123
brew-cli automations triggers fire tev_abc123 --input '{"payload":{"email":"jane@example.com","plan":"pro"}}' --idempotency-key signup-event-001
brew-cli automations runs list --limit 5

# Add or update one contact with custom fields
brew-cli contacts upsert --email jane@example.com --first-name Jane --custom plan=pro

# Define a reusable custom field
brew-cli fields create --name lifecycleStage --type string

# Check deliverability for your opted-in contacts
brew-cli contacts validate --emails jane@example.com bob@example.com

# Find who you are about to email
brew-cli contacts search --audience m3ll218tvnk53pzei1axvn75fowpmvqd --limit 20
brew-cli contacts count --filter email:contains:@acme.com

# The account at a glance for a date range
brew-cli analytics overview --since 2026-08-01T00:00:00Z --until 2026-09-01T00:00:00Z

# Per-send results, with the per-recipient event feed
brew-cli sends get VDDDYjldT4wLfJaaqQCoN --include events

# One recipient's whole history
brew-cli analytics events --recipient jane@example.com --all

brew-cli sends list --kind campaign --all --json | jq '.data[] | {sendId, subject, stats}'

# Every command, flag, and example
brew-cli docs --agent

# The live API catalog
brew-cli docs api

# Raw access for anything without a dedicated command yet
brew-cli api GET '/v1/automations/trigger-instances?limit=5'