# Using npx (no install needed)
npx @sequenzy/cli --help

# Using Bun (no install needed)
bunx @sequenzy/cli --help

# Or install globally
npm install -g @sequenzy/cli

npx skills add Sequenzy/skills --skill sequenzy-email-marketing

sequenzy login

sequenzy whoami

sequenzy account
sequenzy account --json

sequenzy logout

# List subscribers
sequenzy subscribers list
sequenzy subscribers list --tag vip
sequenzy subscribers list --segment active-users
sequenzy subscribers list --list "Master List" --json

# Add a subscriber
sequenzy subscribers add user@example.com
sequenzy subscribers add user@example.com --first-name John --last-name Doe --tag premium --attr plan=pro
# Matching sequences are enrolled by default.

# Update a subscriber
sequenzy subscribers update user@example.com --first-name Ana --last-name Silva

# Get subscriber details
sequenzy subscribers get user@example.com

# Remove a subscriber
sequenzy subscribers remove user@example.com
sequenzy subscribers remove user@example.com --hard  # permanent delete

# Import full CRM records from CSV or JSON, then inspect progress
sequenzy subscribers import ./copper-export.csv --duplicate-strategy merge --list list_abc123 --opt-in-mode confirmed
sequenzy subscribers import-status import_abc123

# Create a list
sequenzy lists create "Monday Batch 01" --private

# Add subscribers to a list from an array
sequenzy lists add-subscribers list_123 --email one@example.com two@example.com

# Add subscribers to a list from JSON or CSV
sequenzy lists add-subscribers list_123 --emails-json '["one@example.com","two@example.com"]'
sequenzy lists add-subscribers list_123 --emails-file ./batch-001.csv
sequenzy lists import list_123 --emails-file ./batch-001.csv

# Update a list
sequenzy lists update list_123 --name "Weekly Newsletter" --private
sequenzy lists update list_123 --description "Sent every Monday" --no-private

# Remove subscribers from a list
sequenzy lists remove-subscribers list_123 --email one@example.com two@example.com
sequenzy lists remove-subscribers list_123 --emails-file ./churned.csv

# Delete a list
sequenzy lists delete list_123 --yes

# Using a template
sequenzy send user@example.com --template welcome --var name=John

# With nested array data for repeat blocks
sequenzy send user@example.com --template order-confirmation --vars-json '{"event":{"items":[{"title":"Pro plan","description":"Monthly subscription"}]}}'

# Using raw HTML
sequenzy send user@example.com --subject "Hello" --html "<h1>Hi!</h1>"

# From a file
sequenzy send user@example.com --subject "Report" --html-file ./email.html

# Overview stats
sequenzy stats
sequenzy stats --period 30d

# Campaign stats
sequenzy stats --campaign camp_abc123
sequenzy stats --campaign camp_abc123 --json

# Sequence stats
sequenzy stats --sequence seq_xyz789

# List campaigns
sequenzy campaigns list
sequenzy campaigns list --status draft

# Get campaign details
sequenzy campaigns get camp_abc123

# Inspect rejected campaigns and their reviewer feedback
sequenzy campaigns list --status rejected

# Update a draft campaign reply-to
sequenzy campaigns update camp_abc123 --reply-to support@example.com

# Create a draft campaign
sequenzy campaigns create "Launch" --prompt "Announce the new dashboard"
sequenzy campaigns create "Launch" --subject "Big News!" --preheader-text "A quick launch preview" --html-file ./launch.html
sequenzy campaigns create "Launch" --subject "Big News!" --blocks-file ./launch-blocks.json

# Update campaign subject or preheader
sequenzy campaigns update camp_abc123 --subject "Updated subject"
sequenzy campaigns update camp_abc123 --preheader-text "Updated preview"

# Schedule a campaign
sequenzy campaigns schedule camp_abc123 --at "2026-06-01T14:00:00Z"

# Schedule a recurring campaign (repeats weekly or monthly)
sequenzy campaigns schedule camp_abc123 --at "2026-06-01T14:00:00Z" --repeat monthly

# Send test email
sequenzy campaigns test camp_abc123 --to me@example.com

# Cancel a scheduled, paused, or sending campaign
sequenzy campaigns cancel camp_abc123

# Pause and resume delivery
sequenzy campaigns pause camp_abc123
sequenzy campaigns resume camp_abc123
sequenzy campaigns resume camp_abc123 --spread-over-hours 6

# Duplicate a campaign as a new draft
sequenzy campaigns duplicate camp_abc123
sequenzy campaigns duplicate camp_abc123 --mode ab_test
sequenzy campaigns duplicate camp_abc123 --mode variant --variant-id var_b

# Resend a sent campaign to people who didn't open it
sequenzy campaigns resend-to-non-openers camp_abc123

# Delete a campaign
sequenzy campaigns delete camp_abc123 --yes

# List landing pages
sequenzy landing-pages list
sequenzy landing-pages list --json

# Create a draft from a built-in template
sequenzy landing-pages create "Product Waitlist" --template waitlist
sequenzy landing-pages create "Launch Page" --template launch --slug launch

# Get or edit a page
sequenzy landing-pages get lp_abc123
sequenzy landing-pages update lp_abc123 --name "Updated Waitlist" --slug waitlist

# Publish or unpublish
sequenzy landing-pages publish lp_abc123
sequenzy landing-pages unpublish lp_abc123

# Connect or verify a custom landing page domain
sequenzy landing-pages connect-domain pages.example.com
sequenzy landing-pages update-domain-settings --verify

# Delete a page
sequenzy landing-pages delete lp_abc123

# List A/B tests, optionally scoped to a sequence
sequenzy ab-tests list
sequenzy ab-tests list --sequence seq_abc123

# Get variants and localization status
sequenzy ab-tests get ab_abc123

# Get aggregate and per-variant stats
sequenzy ab-tests stats ab_abc123 --period 30d

# Update a draft variant
sequenzy ab-tests update-variant ab_abc123 var_b --subject "Better subject"
sequenzy ab-tests update-variant ab_abc123 var_b --html-file ./variant-b.html
sequenzy ab-tests update-variant ab_abc123 var_b --blocks-file ./variant-b-blocks.json

# Create an A/B test for a draft campaign
sequenzy ab-tests create camp_abc123
sequenzy ab-tests create camp_abc123 --test-percentage 30 --duration-minutes 120 --winner-criteria click_rate
sequenzy ab-tests create camp_abc123 --variants-json '[{"subject":"Alternative subject"}]'
sequenzy ab-tests create --automation-node node_abc123 --test-type content --winner-threshold 100 --variants-json '[{"subject":"Variant B"}]'

# Add a variant to a draft campaign or sequence A/B test
sequenzy ab-tests add-variant ab_abc123 --subject "Alternative subject"
sequenzy ab-tests add-variant ab_abc123 --subject "Alternative subject" --blocks-file ./variant.json

# Remove a variant from a draft campaign or sequence A/B test
sequenzy ab-tests delete-variant ab_abc123 var_b --yes

# Delete a campaign A/B test
sequenzy ab-tests delete ab_abc123 --yes

# List sequences
sequenzy sequences list

# Get sequence details
sequenzy sequences get seq_abc123

# Create the same blank trigger-to-completion draft as the dashboard
sequenzy sequences create cancellation-feedback

# Filter the dashboard sequence list
sequenzy sequences list --status active --search cancellation --label Lifecycle --limit 25

# Create an AI-generated sequence with custom spacing and a plain, text-first style
sequenzy sequences create onboarding --trigger contact_added \
  --goal "Guide new users to activation" \
  --email-count 4 \
  --duration-days 10 \
  --email-style plain

# Create a purchase sequence scoped to one product (event property filters)
sequenzy sequences create deliver-ebook --trigger event_received \
  --event-name ecommerce.order_placed \
  --property-filters-json '[{"path":"lineItems[].providerProductId","operator":"equals","value":"prod_123"}]' \
  --steps-file ./steps.json

# Create a dynamic discount sequence (code generated per subscriber at runtime)
sequenzy sequences create win-back --trigger tag_added \
  --tag-name cancelled \
  --steps-json '[{"type":"create_discount","discount":{"provider":"shopify","discountType":"percent","percentOff":20,"appliesToAllPlans":true,"maxRedemptions":1,"codePrefix":"WINBACK"}},{"subject":"Come back with {{discount.code}}","html":"<p>Use {{discount.code}} for 20% off.</p>"}]'

# Create a sequence that copies purchase-event data onto the subscriber
sequenzy sequences create purchase-profile --trigger event_received \
  --event-name saas.purchase \
  --steps-json '[{"type":"update_subscriber","nodeType":"action_update_attributes","config":{"customAttributeUpdates":[{"name":"plan","value":"{{event.plan}}","valueType":"text"},{"name":"mrr","value":"{{event.amount}}","valueType":"number"}]}}]'

# Update sequence metadata and existing email steps
sequenzy sequences update seq_abc123 --name "Updated onboarding"
sequenzy sequences update seq_abc123 --steps-file ./sequence-updates.json
sequenzy sequences update seq_abc123 \
  --emails-json '[{"nodeId":"node_founder_note","emailPreset":"minimal"}]'
sequenzy sequences update seq_abc123 \
  --subscriber-update-steps-json '[{"nodeId":"node_update","config":{"customAttributeUpdates":[{"name":"active","value":"{{event.active}}","valueType":"boolean"}]}}]'
sequenzy sequences update seq_abc123 \
  --stop-condition-json '{"type":"has_tag","value":"customer"}'

# Atomically replace the trigger
sequenzy sequences update seq_abc123 --trigger inbound_webhook \
  --event-name summit.cancellation_feedback \
  --custom-integration-file ./heysummit-webhook.json \
  --confirm-live-change

# BCC team inboxes on every email the sequence sends
sequenzy sequences update seq_abc123 --bcc-emails "cs-team@yourcompany.com, founder@yourcompany.com"
sequenzy sequences update seq_abc123 --clear-bcc-emails

# Insert new linear steps after an existing node
sequenzy sequences update seq_abc123 \
  --insert-steps-json '{"afterNodeId":"node_email","steps":[{"delay":{"days":1},"subject":"Migration check-in","html":"<p>Need help migrating?</p>"}]}'

# Insert an if/else branch after an existing node
sequenzy sequences update seq_abc123 \
  --branch-file ./branch.json

# Wait for a reply, then continue or time out after five days
sequenzy sequences update seq_abc123 \
  --insert-steps-json '{"afterNodeId":"node_email_1","steps":[{"nodeType":"logic_wait_for_event","config":{"label":"Wait for reply","eventName":"email.replied","timeoutDays":5,"timeoutAction":"continue"}}]}'

# Route replies to completion and everyone else to the existing follow-up
sequenzy sequences update seq_abc123 \
  --branch-json '{"afterNodeId":"node_email_1","branches":[{"id":"replied","conditionType":"event_received","eventName":"email.replied","activityScope":"this_sequence","targetNodeId":"node_complete"}],"elseTargetNodeId":"node_email_2"}'

# Enable/disable
sequenzy sequences enable seq_abc123
sequenzy sequences disable seq_abc123
sequenzy sequences pause-enrollments seq_abc123
sequenzy sequences resume-enrollments seq_abc123

# Sequence-list actions
sequenzy sequences duplicate seq_abc123 --name "Welcome Series v2"
sequenzy sequences archive seq_abc123
sequenzy sequences unarchive seq_abc123

# Persisted dashboard conversion goals
sequenzy sequences goals create seq_abc123 Reactivated \
  --trigger-type event --trigger-event-name account.reactivated \
  --attribution-window-hours 168
sequenzy sequences goals create seq_abc123 Upgraded \
  --trigger-event-name plan.upgraded --inactive
sequenzy sequences goals list seq_abc123

# Configure and rotate an inbound-webhook sequence endpoint
sequenzy sequences webhook configure seq_abc123 \
  --field-mapping-file ./field-mapping.json \
  --sample-payload-file ./sample-payload.json
sequenzy sequences webhook get seq_abc123
sequenzy sequences webhook rotate seq_abc123

# Manually enroll subscribers in a sequence
sequenzy sequences enroll seq_abc123 --email one@example.com two@example.com
sequenzy sequences enroll seq_abc123 --subscriber-ids sub_123 sub_456 --target-node-id node_123
sequenzy sequences enroll seq_abc123 --emails-file ./vips.csv
sequenzy sequences enroll seq_abc123 --emails-json '["one@example.com"]' --target-node-id node_123

# Dry-run cancellation for enrollments with matching entry event values
sequenzy sequences cancel-enrollments seq_abc123 --field-path order.id --field-values ord_123,ord_456

# Apply cancellation for one subscriber enrollment
sequenzy sequences cancel-enrollments seq_abc123 --subscriber-id sub_abc123 --apply

# List templates
sequenzy templates list
sequenzy templates list --company comp_abc123
sequenzy templates list --json

# Get template
sequenzy templates get tmpl_abc123
sequenzy templates get tmpl_abc123 --company comp_abc123 --json

# Create or update with HTML
sequenzy templates create welcome --subject "Welcome" --html-file ./welcome.html
sequenzy templates update tmpl_abc123 --subject "Updated" --html-file ./welcome-v2.html

# Create or update with Sequenzy blocks
sequenzy templates create welcome --subject "Welcome" --blocks-file ./welcome-blocks.json
sequenzy templates update tmpl_abc123 --blocks-file ./welcome-v2-blocks.json

# Store a caller-supplied localized variant
sequenzy templates localizations set tmpl_abc123 es --subject "Bienvenido" --html-file ./welcome-es.html

# Queue AI translation for selected locales, or omit --locale to sync all
sequenzy templates localizations sync tmpl_abc123 --locale es fr
sequenzy templates localizations sync tmpl_abc123

[
  {
    "id": "intro",
    "type": "text",
    "content": "<p>Hello there</p>",
    "variant": "paragraph"
  },
  {
    "id": "pro-offer",
    "type": "text",
    "content": "<p>Your Pro upgrade is ready.</p>",
    "variant": "paragraph",
    "conditions": [
      { "id": "c1", "field": "variable", "operator": "is", "value": "plan:pro" }
    ]
  }
]

sequenzy companies list
sequenzy companies get comp_abc123
sequenzy companies get comp_abc123 --json
sequenzy companies update comp_abc123 --primary-color "#0ea5e9"
sequenzy companies update comp_abc123 --company-context-file ./product.md --tone-voice "clear, direct, warm"
sequenzy companies update comp_abc123 --email-theme-json '{"colors":{"mutedText":"#4b5563"},"typography":{"baseFontSize":16}}'

# List saved segments
sequenzy segments list

# Preview how many subscribers are in a segment
sequenzy segments count seg_abc123

# Create a Stripe-product segment
sequenzy segments create --name "Bought Pro" --stripe-product prod_pro

# Create a threshold-based Stripe-product segment
sequenzy segments create --name "3+ Pro Payments" \
  --stripe-product prod_pro \
  --purchase-operator at-least \
  --payments 3

# Create a purchased-product segment (Shopify, WooCommerce, or Commerce API orders)
sequenzy segments create --name "Starter Kit Buyers" --commerce-product api:prod-starter-kit

# Create a repeat-buyer segment by order count
sequenzy segments create --name "Repeat Kit Buyers" \
  --commerce-product api:prod-starter-kit \
  --purchase-operator at-least \
  --orders 2

# Create a segment that matches any filter instead of all filters
sequenzy segments create --name "VIP Or Gmail" \
  --match any \
  --filter-json '[{"field":"tag","operator":"contains","value":"vip"},{"field":"email","operator":"contains","value":"@gmail.com"}]'

# Create a segment from raw filter JSON
sequenzy segments create --name "Custom Filter" \
  --filter-json '[{"field":"stripeProduct","operator":"is","value":"prod_pro"}]'

# Combine campaign-specific engagement filters (bounced A but not B)
sequenzy segments create --name "Bounced A Not B" \
  --filter-json '[{"field":"emailBounced","operator":"is","value":"campaign:cmp_abc"},{"field":"emailBounced","operator":"is_not","value":"campaign:cmp_xyz"}]'

# Create a nested segment with an event filter
sequenzy segments create --name "Active Non Buyers" \
  --filter-json '{"root":{"kind":"group","joinOperator":"and","children":[{"kind":"filter","field":"attribute","operator":"lte","value":"last_login_days_ago:90"},{"kind":"group","joinOperator":"or","children":[{"kind":"filter","field":"event","operator":"is_not","value":"saas.purchase:30d"},{"kind":"filter","field":"segment","operator":"is_not","value":"seg_paying_customers"}]}]}}'

# Update a segment's name, filters, or join operator
sequenzy segments update seg_abc123 --name "Churn Risk"
sequenzy segments update seg_abc123 --filters-json '[{"field":"tag","operator":"contains","value":"vip"}]'
sequenzy segments update seg_abc123 --join-operator or

# Delete a segment
sequenzy segments delete seg_abc123 --yes

# List audience syncs with schedule and status
sequenzy audience-syncs list

# List the connected Meta ad accounts
sequenzy audience-syncs ad-accounts

# Create a sync from a ready-made segment template
sequenzy audience-syncs create --template recent-buyers \
  --ad-account act_1234567890 \
  --name "Sequenzy - Recent buyers"

# Create a sync from an existing segment, refreshed hourly
sequenzy audience-syncs create --segment seg_abc123 \
  --ad-account act_1234567890 \
  --name "Sequenzy - VIPs" \
  --frequency hourly

# Pause, resume, or change the schedule
sequenzy audience-syncs update sync_abc123 --active false
sequenzy audience-syncs update sync_abc123 --frequency weekly

# Trigger an immediate run
sequenzy audience-syncs sync sync_abc123

# Remove a sync (the Meta audience itself is kept)
sequenzy audience-syncs delete sync_abc123

# List tag definitions (bare `sequenzy tags` also lists)
sequenzy tags list

# Create a tag
sequenzy tags create vip
sequenzy tags create "VIP Customer" --color purple

# Update a tag's color
sequenzy tags update tag_abc123 --color red

# Delete a tag
sequenzy tags delete tag_abc123 --yes

# Show the store's browse-abandonment and price-drop automation settings
sequenzy shopify settings get
sequenzy shopify settings get --json

# Turn features on or off
sequenzy shopify settings update --price-drop off
sequenzy shopify settings update --browse-abandonment on

# Fine-tune behavior (partial update - omitted flags keep their values)
sequenzy shopify settings update --browse-delay-hours 4 --browse-cooldown-hours 48
sequenzy shopify settings update --price-drop-min-percent 10 --price-drop-lookback-days 14

# Reset a section to the platform defaults
sequenzy shopify settings update --reset-price-drop

# Show the effective sync rules (new workspaces start empty)
sequenzy sync-rules get
sequenzy sync-rules get --json

# Replace the full rule set from a file
sequenzy sync-rules update --rules-file ./sync-rules.json

# Replace it inline
sequenzy sync-rules update --rules-json '[{"triggerEvent":"ecommerce.order_placed","actions":{"addTags":["vinyl-collector"],"removeTags":[]},"conditions":{"purchasedProduct":{"tags":["Vinyl"]}}}]'

# Opt into the inherited SaaS/ecommerce platform preset
sequenzy sync-rules update --reset

# List team members and pending invitations
sequenzy team list

# Invite a team member
sequenzy team invite teammate@example.com --role admin
sequenzy team invite editor@example.com --role restricted
sequenzy team invite finance@example.com --role viewer --billing-access

# Cancel a pending invitation
sequenzy team cancel-invitation inv_abc123 --yes

# List conversations
sequenzy inbox list
sequenzy inbox list --status open --unread
sequenzy inbox list --search "refund" --limit 50

# Get a conversation with its full message history
sequenzy inbox get conv_abc123

# Reply to a conversation
sequenzy inbox reply conv_abc123 --text "Thanks for reaching out!"
sequenzy inbox reply conv_abc123 --html-file ./reply.html --subject "Re: your question"

# Add an internal note instead of emailing the subscriber
sequenzy inbox reply conv_abc123 --text "Customer asked for a refund" --note

# Triage
sequenzy inbox close conv_abc123
sequenzy inbox reopen conv_abc123
sequenzy inbox mark-read conv_abc123

# List webhook endpoints
sequenzy webhooks list

# Create a webhook endpoint
sequenzy webhooks create --name CI --url https://example.com/hook --event email.bounced
sequenzy webhooks create --name "All events" --url https://example.com/hook

# Update a webhook endpoint
sequenzy webhooks update wh_abc123 --url https://example.com/new-hook
sequenzy webhooks update wh_abc123 --event email.bounced email.complained
sequenzy webhooks update wh_abc123 --disable

# Delete a webhook endpoint
sequenzy webhooks delete wh_abc123 --yes

# Test and inspect deliveries
sequenzy webhooks test wh_abc123
sequenzy webhooks deliveries wh_abc123 --limit 50
sequenzy webhooks replay wh_abc123 del_456

# List synced products (Stripe, Shopify, WooCommerce, api)
sequenzy products list --provider stripe

# Queue a Stripe product catalog sync
sequenzy products sync

# Create or update a product (Commerce API, keyed by your productId)
# and attach its deliverable file in the same command
sequenzy products upsert my-ebook --title "The Ebook" --price-cents 1900 --currency USD --file ./ebook.pdf

# Bulk upsert products from a JSON file (up to 100)
sequenzy products upsert --products-file ./products.json

# Delete a product pushed via the Commerce API
sequenzy products delete my-ebook

# Upload a local file and attach it as the product's deliverable
sequenzy products attach-file prod_abc --file ./guide.pdf

# Attach an externally hosted file instead
sequenzy products attach-file prod_abc --url https://example.com/template.zip --name template.zip

# Remove the attached file
sequenzy products detach-file prod_abc

sequenzy account
sequenzy account --json
sequenzy websites

# List company API key metadata without returning secrets
sequenzy api-keys list --company comp_123

# Create a company API key (full access by default)
sequenzy api-keys create --name "CI deploy key" --company comp_123

# Create a key restricted to a permission preset
sequenzy api-keys create --preset transactional_sender --name "Order emails"

# Create a key with explicit permission scopes
sequenzy api-keys create --scopes "subscribers:read,subscribers:write,events:write"

# Permanently revoke an unused key by its exact ID
sequenzy api-keys revoke key_abc123 --company comp_123 --yes

# Generate email
sequenzy generate email "Welcome email for new SaaS trial users"
sequenzy generate email "Product launch announcement" --style branded --tone professional

# Deprecated compatibility alias (persists a disabled sequence draft)
sequenzy generate sequence "Onboarding for SaaS trial users"

# Generate subject lines
sequenzy generate subjects "Black Friday sale" --count 5

# Generate SMS message variants
sequenzy generate sms "Cart reminder with a free-shipping hook" --count 3

# Show SMS add-on status, credits, and phone numbers
sequenzy sms settings
sequenzy sms settings --json

# Send a real test SMS (charges credits, max 5/hour)
sequenzy sms send-test +15550100123 --text "Test from Sequenzy"

# Report a missing capability
sequenzy feedback "No command to bulk-delete campaigns by label" --category missing_capability

# Report a bug with context
sequenzy feedback "Segment count and list output disagree for seg_123" --category bug --context "Auditing a re-engagement segment"

#!/bin/bash

# Import subscribers from CSV into a list
sequenzy lists import list_123 --emails-file subscribers.csv

# Check if logged in
if ! sequenzy whoami > /dev/null 2>&1; then
  echo "Not logged in"
  exit 1
fi

bunx @sequenzy/cli login