Skip to content
Coritan Docs

Manage your audience in the staff console

Run the newsletter list, the suppression list, the automatic email flows, the review prompt and Discord announcements from the staff console's Marketing page.

View as Markdown

The Marketing page of the staff console holds the tools that keep your customers in touch with your brand. It has five tabs: "Campaigns", "Referrals", "Subscribers", "Email flows" and "Reviews and announcements". This page covers the last three. Make campaign links and read their results and Run a referral program cover the first two.

Each tab uses the same routes as the owner's dashboard. Collect newsletter sign-ups and manage unsubscribes, Send automatic emails to your customers and Set up review prompts and Discord announcements describe what the settings mean and the rules behind them.

  • You need the Admin or Owner role. A member with another role does not see these three tabs, and if one opens a tab's address, such as /staff/marketing?tab=flows, the tab says "Admins change these" in place of its content.
  • Open Marketing in the sidebar, under Insight, or press g then f. Choose the tab, or open /staff/marketing?tab=subscribers, /staff/marketing?tab=flows or /staff/marketing?tab=reviews.
  • The search, the filters and the page of each list stay in the address, so you can send a colleague a link to the view you are looking at.
  • A tab that says "is not available on this server" is talking to an older server that does not have the tool yet.

The "Subscribers" tab shows the newsletter form's settings, the people who signed up and the addresses that must get no marketing email.

  1. Open the "Subscribers" tab. Three figures sit at the top: "Leads" (everyone who gave the form an address), "Consenting customers" (active customers who agreed to marketing email) and "Suppressed" (addresses on the suppression list).
  2. In the "Newsletter form" card, turn on "Take sign-ups" to show the form in the storefront footer. Turn on "Check visitors with Turnstile" to ask for a check before a sign-up counts. It applies when the brand has Turnstile keys.
  3. Change "Words beside the checkbox" if you want words of your own. The card counts the characters out of 300. "Use the default words" puts the default back, and so does emptying the box. The default is shown under the box.
  4. Choose "Save settings". The button shows only while something changed, and "Discard" puts the saved values back. A toast names what changed, such as "Newsletter form saved · form switch". A value the server refuses shows its sentence under the box.
  5. In "Leads", read the newest sign-ups first, 25 to a page. Each row shows the address with the words the person agreed to under it, its source, "Agreed" or "Did not agree", a "Suppressed" badge when the address is on the suppression list, and a link to the customer when the address belongs to one.
  6. Search by part of an address, pick a source ("Any source" or one of the sources the page has seen), or choose "All", "Agreed" or "Did not agree". Chips show what is applied, and "Clear all" removes them.
  7. To delete a lead, open the row's menu, choose "Delete lead…" and confirm. Only the lead goes. The customer with that address, their consent and the suppression list stay as they were, so an address that unsubscribed stays unsubscribed.

Export the people you may mail

Section titled Export the people you may mail

Choose "Export CSV" at the top of the tab. The browser saves a file with the columns email, source, consent, kind and created_at.

  • It lists leads who agreed and active customers who agreed to marketing email, once for each address. It never lists an address on the suppression list.
  • A file holds at most 100,000 addresses. When the list is longer, the tab shows "The file holds the first 100,000 addresses" and the file name.
  • You can export 12 times an hour. After that, a toast says "Too many requests for this action. Try again within about an hour."
  • Every export is recorded in the activity log.

The "Suppression list" card shows each address with why it is there ("Unsubscribed", "Bounced", "Complained" or "Manual"), how it got there ("Unsubscribe link", "Customer account", "Console" or "API") and when.

  1. Type the address in "Add an address" and choose "Add address". The reason is always "Manual". An address already on the list stays as it was, and the toast says so.
  2. Adding an address cancels the flow emails still waiting for it, takes marketing consent back from a customer with that address and marks a lead with it as not agreeing.
  3. Search the list by part of an address. It shows 10 to a page.
  4. To take an address off, open the row's menu, choose "Take off the list…" and confirm. The address can get marketing email again, but this never gives consent back. The person is not mailed until they ask to be, by signing up to the newsletter again or by turning on marketing email in their account.

When it works, a new sign-up appears under "Leads" with "Agreed", and an address you add shows at the top of "Suppression list" and in the "Suppressed" figure.

The "Email flows" tab has one card for each of the six flows, then the log of every email they scheduled.

  1. Open the "Email flows" tab. The note at the top says what the two kinds mean. A "Service" flow is about a customer's own order, so it needs no marketing consent. A "Marketing" flow reaches only customers who agreed to marketing email. Every flow skips addresses on the unsubscribe list, and a customer gets at most one flow email in 3 days.
  2. The cards come in a fixed order: "Unpaid first invoice", "Stuck setup", "Free to paid nudge", "Win-back", "Onboarding" and "Review invitation". Each card shows its kind, an On or Off switch, what the flow does, its settings and its counts: "Scheduled", "Sent", "Skipped", "Failed", "Canceled" and "Last sent".
  3. To turn a flow on, use the switch in the card's top right corner and choose "Turn on" in the question that opens. The flow starts within ten minutes and writes only to customers who qualify from then on. Turning a flow off asks nothing.
  4. Change a setting by typing in its box. Each box says what it does and its range, such as "From 1 to 72". "Coupon code" on "Win-back" is optional and must be a coupon of this brand. Choose "Save settings" when it appears. A number outside its range is refused before anything is sent, and a coupon the server does not know shows its sentence under the box.
  5. To check an email, choose "Send a test to me". A flow with two emails opens a menu with "Email 1" and "Email 2". The test goes to your own address with made-up facts, and its subject starts with [Test]. It goes whether or not the flow is on. You can send 10 tests an hour.
  6. To read what a flow sent, choose "See its emails". The log below filters to that flow.

The "Review invitation" switch stays off, with the reason on the card, until the review prompt has a link and is on. Choose "Open Reviews" to set that up.

"Email log" lists every email the flows scheduled, newest first, 25 to a page. Pick "Every flow" or one flow and "Every status" or one status ("Scheduled", "Sent", "Skipped", "Failed" or "Canceled"). Each row shows the address, the flow and which of its emails it is, the status, when it was due and when it was sent, and a link to the customer.

A "Skipped", "Canceled" or "Failed" row says why under its status: the address is on the unsubscribe list, the customer no longer agrees to marketing email, another flow email went to the customer in the last 3 days, the invoice was paid, or the mail server did not accept the email. "Canceled" means the reason for the email went away. "Skipped" means we left it out on purpose.

When it works, a card's switch reads On and its counts move as the flow runs.

Set up reviews and announcements

Section titled Set up reviews and announcements

The "Reviews and announcements" tab has the Trustpilot review prompt, a Discord webhook, a form to post to it and the history of posts.

  1. Open the "Reviews and announcements" tab. In "Trustpilot reviews", paste your "Trustpilot review link". It starts with https:// and is on trustpilot.com. A link typed without https:// gets it.
  2. Turn on "Ask customers for a review". A signed-in customer then sees the prompt once their account is old enough. It cannot be on without a link.
  3. Set "Account age before asking" (0 to 365 days) and "Quiet after a dismissal" (1 to 365 days, how long the prompt stays away after a customer closes it).
  4. Choose "Save review settings". A toast names what changed. A link the server refuses, or the switch turned on with no link, shows its sentence under "Trustpilot review link". Removing the link while the prompt is on is refused too.
  5. Under "Review invitation email", read whether the invitation flow is on and how many emails are "Scheduled", "Sent", "Skipped" and "Failed", with "Last sent". "Open Email flows" goes to the flow's switch.
  1. In "Discord webhook", type a "Channel name" if you like. It is for your team, at most 80 characters, and names the channel in the question before a post.
  2. In "Set the webhook", paste the webhook address. In Discord, open the channel's settings, then Integrations, then Webhooks, and copy the address. It starts with https://discord.com/api/webhooks/. Choose "Set webhook".
  3. The tab never shows the address again. It says "A webhook is saved" and the last four digits of the webhook's ID. To use another webhook, paste its address under "Replace the webhook" and choose "Replace webhook". To stop announcements, choose "Remove webhook…" and confirm.
  4. In "Post an announcement", fill in "Title" (optional, 120 characters), "Message" (up to 1,800 characters, counted under the box) and "Link" (optional, starts with https://). The title, message and link together must fit Discord's 2,000 characters, and the card counts them in its footer.
  5. Choose "Post to Discord…". The question shows the text, the link and the channel. Choose "Post announcement" to send it. Nothing in the message can mention a role or a person, and you cannot take a post back from here.

When it works, a toast says "Announcement posted to" and the channel, the form empties and the post is first in "Announcement history".

The history lists posts and refused posts, newest first, with who sent them, the channel and when. It shows 20, and "Show older announcements" loads up to 100. A post that Discord did not take shows "Failed" with its reason.

If a post is refused, the card tells you why:

  • No webhook is saved: "Save a Discord webhook address before you post." Choose "Set the webhook".
  • You posted 10 times in an hour: the toast says "Too many requests for this action. Try again within about an hour."
  • Discord did not take the message: "Discord did not take the message" and a sentence, such as "Discord no longer accepts this webhook. Save a new webhook address and try again." Nothing was posted, and the attempt is in the history.

The tabs call the staff routes of the Organization API under /api/v1/orgs/{org_slug}/staff/marketing/: subscribers, flows, reviews and announcements. Each needs the Owner or Admin role. A value the server refuses answers 422 with detail, the sentence the tab shows, and field, the input it belongs to. The export answers 429 past 12 an hour, a flow test past 10 an hour and a post past 10 an hour.

The owner's routes under /api/v1/orgs/{org_slug}/subscribers, /flows, /reviews and /announcements answer alike, and Collect newsletter sign-ups and manage unsubscribes, Send automatic emails to your customers and Set up review prompts and Discord announcements describe their fields, limits and errors.

A tab says "Admins change these"

Section titled A tab says "Admins change these"

Your role is below Admin, or the server refused the read. Ask an admin or the owner for what you need.

The "Review invitation" switch is off and will not turn on

Section titled The "Review invitation" switch is off and will not turn on

The review prompt has no link or is off. Open the "Reviews and announcements" tab, save the "Trustpilot review link" and turn on "Ask customers for a review", then come back.

No webhook is saved. Set the webhook above the form, then post.

The export or the test says "Too many requests for this action"

Section titled The export or the test says "Too many requests for this action"

You reached the hourly limit. The message says how long to wait. The limit for exports is 12 an hour, and flow tests are 10 an hour for each member.

The test goes to the address of the account you are signed in with. When that address is on the unsubscribe list, the tab says so and nothing is sent. When the brand's mail server refuses the email, the tab says that too.

API operations on this page

MethodPathWhat it does
GET/api/v1/orgs/{org_slug}/staff/marketing/subscribersList the newsletter's leads and count who can be mailed
GET/api/v1/orgs/{org_slug}/staff/marketing/subscribers/settingsRead the newsletter form's settings
PUT/api/v1/orgs/{org_slug}/staff/marketing/subscribers/settingsTurn the newsletter form on or off and change its words
GET/api/v1/orgs/{org_slug}/staff/marketing/subscribers/export.csvDownload the addresses that can be mailed as a CSV file
GET/api/v1/orgs/{org_slug}/staff/marketing/subscribers/suppressionsList the addresses that get no marketing email
POST/api/v1/orgs/{org_slug}/staff/marketing/subscribers/suppressionsAdd an address to the suppression list
DELETE/api/v1/orgs/{org_slug}/staff/marketing/subscribers/suppressions/{suppression_id}Take an address off the suppression list
DELETE/api/v1/orgs/{org_slug}/staff/marketing/subscribers/{lead_id}Delete a lead
GET/api/v1/orgs/{org_slug}/staff/marketing/flowsList the automatic email flows, with their settings and how many emails each sent
GET/api/v1/orgs/{org_slug}/staff/marketing/flows/messagesRead the log of flow emails, newest first
PUT/api/v1/orgs/{org_slug}/staff/marketing/flows/{key}Turn an email flow on or off and change its settings
POST/api/v1/orgs/{org_slug}/staff/marketing/flows/{key}/testSend a flow's sample email to yourself
GET/api/v1/orgs/{org_slug}/staff/marketing/reviewsRead the Trustpilot review settings and how the invitations are doing
PUT/api/v1/orgs/{org_slug}/staff/marketing/reviewsChange the Trustpilot review settings
GET/api/v1/orgs/{org_slug}/staff/marketing/announcementsRead the Discord webhook settings for announcements
PUT/api/v1/orgs/{org_slug}/staff/marketing/announcementsSave or remove the Discord webhook for announcements
POST/api/v1/orgs/{org_slug}/staff/marketing/announcements/postPost an announcement to Discord
GET/api/v1/orgs/{org_slug}/staff/marketing/announcements/historyRead the announcements that were posted