Skip to main content
Reference

Communications

Overview​

Your agent can build and edit the email, SMS and postcard marketing in StoreFront Communications: campaigns, flows, the emails and postcards in them, and the lists and segments they reach. It can show you an email as a mail client would display it, or a postcard as it would print, without sending or mailing anything.

The CLI never starts or sends a campaign. You do that in the admin. A few actions do reach real people, and each one needs an explicit --live flag and, for most, your approval:

  • Turning a flow on enrolls every customer its trigger fires for from then on, and sends them its emails.
  • A flow backfill enrolls and mails past customers who would have met the trigger.
  • Test sends go to a user on your account: a test email, a test SMS, or a test postcard that is printed and mailed.

What is covered​

  • Campaigns and flows: create, change, copy, archive and unarchive them, and turn a flow on or off.
  • Steps: add email, wait, split, condition and postcard steps, move or remove a step, and change a step's settings or audience filter, including an SMS step's message.
  • Emails: change the subject and preview text, edit the body, render it without sending, request a content review, and read link clicks.
  • Postcards: edit the front and back, proof them with the print vendor without mailing anything, and read tracking for cards already mailed.
  • Lists and segments: create, change and archive them, and read their members with email addresses masked.
  • Transactional emails, such as the order receipt: change the subject, sender and body, and render them.
  • Settings: the postcard return address, default senders and SMS number, the account's Twilio account and sending domains, and statistics.

Example requests​

  • "Create a draft flow for abandoned carts with a one-hour wait, then an email reminding them what they left. Leave it off."
  • "Render the welcome email as a phone would show it, and send me nothing."
  • "Proof the postcard step in the win-back flow."
  • "Create a segment of customers who bought outerwear in the last 90 days."
  • "Change the subject line of the second email in the spring campaign."

Commands​

CommandWhat it does
sf comms campaigns, sf comms flowsList, read, create, change, copy and archive campaigns and flows; turn a flow on or off
sf comms sequencesRead a campaign's or flow's steps, add, move and remove steps, change a step's settings or filter
sf comms emailsRead and change an email's subject and preview text, render it, request review, read clicks, send a test
sf containers pull, sf containers push with --owner-type emailEdit an email body
sf comms postcardsPull, push and proof a postcard, read mailing tracking, mail a test card
sf comms lists, sf comms segments, sf comms foldersManage lists, segments and their folders
sf comms transactionalRead, change and render transactional emails
sf comms settings, sf comms twilio, sf comms domainsSending settings, the Twilio account and sending domains
sf comms stats, sf comms sequences stats, sf comms planStatistics, and the account's plan and limits
sf secrets requestAsk you to enter a credential, such as a Twilio auth token, in the admin

Costs to be aware of​

  • A postcard step mails printed cards at the account's cost once it is on. It starts off.
  • SMS is billed per segment. A single emoji or other character outside the GSM-7 set can cut a segment from 160 characters to 70, and the CLI warns when a message takes more than one segment.

What it cannot do​

  • Start or send a campaign. You start a campaign in the admin.
  • Add or remove list or segment members, or subscribe and unsubscribe customers.
  • Copy a campaign or flow to another storefront, or edit experiment, resend and webhook steps. These are done in the admin.
  • Undo a send. Restoring an email's earlier version does not recall an email already delivered or a postcard already mailed.

Before the agent pushes an email body or a postcard side, it asks you to close that email or postcard in the admin's editor, because an editor left open can overwrite the CLI's change.

What needs approval​

  • Removing or moving a step in a live campaign or flow.
  • Changing the rule of a segment that a live campaign or flow uses.
  • Turning a postcard step on.
  • Mailing a test postcard, with a fresh authenticator code each time.
  • Backfilling a flow.
  • Changing a transactional email's subject, delivery option or sender.
  • Changing the default sender or SMS number.
  • Importing lists from an outside provider.
  • Removing the Twilio account or a sending domain.

Turning a flow on or off needs --live, and the skill tells the agent to get your OK first, but it does not ask for an approval in the admin. Any change to a live campaign or flow needs --live and publish permission. See Changes that need approval.

Was this page helpful?