Campaign (editor: <campaign name>)

This page is one campaign from draft to done. While it is a Draft (or Scheduled) you can change its details and audience, build the recipient list, preview the merged email for a real contact, send a test to yourself and then send now or schedule. While it is Sending you watch the log fill in; once Sent or Cancelled the page is read-only and keeps the log.

Where to find it

From the Campaigns list, click the campaign name or the pencil icon. You also land here straight after Create campaign on New campaign, and from links in the audit log and notifications. The breadcrumbs read Campaigns > <campaign name>.

You need the View permission on Campaigns to open the page (otherwise "No access" and "You do not have permission to view campaigns. Ask your administrator."). Changing the details, the audience and the recipient list needs the Edit permission on Campaigns; sending a test, sending, scheduling and cancelling need the send permission on Campaigns. In the default roles the Administrator and the Sales Manager hold all of these.

If the campaign can't be loaded (for example from a link to a deleted campaign) the page shows "That item could not be found." instead.

What you see

Header

The campaign name with its status badge. Under it: "Completed <date and time>." for a Sent campaign, "Goes out <date and time>." for a Scheduled one, or "Sending now…" while it sends. If the last send hit an error, a yellow alert reads "Last error: <text>".

Four tiles follow: Recipients (people on the list), Sent, Failed (shown in red when above zero) and Skipped with the hint "no email or unsubscribed".

Details and Audience cards

The same fields as on New campaign: Name, Project, Email template, Reply-to, Description, and the Audience card with its source, checklists, Cities, dates and Name, email or company contains. They are editable only while the campaign is Draft or Scheduled and you hold the Edit permission; otherwise every field is disabled.

Recipients card

Under the heading, either "Build the list from the audience above (Send does it for you if you skip this)." when no list exists, or "N on the list; rebuild after changing the audience." once one does. When a list exists the grid shows, ten per page:

Column	What it shows
Recipient	The contact's name, with the email address (or "no email") underneath.
Status	The recipient's status badge and, under it, the reason when there is one (see Statuses).
Sent	When the mail went out, or "—".

Above the grid: a Status filter (placeholder "Any status"; Pending, Sent, Failed, Skipped, Unsubscribed) and a search "Search by name or email". The list is sorted by name. When nothing matches it reads "No recipients match".

Preview card

Preview for the first contact renders the email for the first contact the audience finds and shows "To <name> · <email>", the subject, and the body (as the recipient will see it, or as plain text for a plain template). Under a divider, Send a test with an address box (placeholder "you@example.com"), the Send test button and the note "Merged for the first contact of the audience; the subject is prefixed with [TEST]." The test row appears only if you hold the send permission.

While the campaign is Sending, the page refreshes itself every three seconds so the tiles and the log keep up.

What you can do

Save

Saves the changed details and audience and shows "Campaign saved."

• Who: anyone with the Edit permission on Campaigns, on a Draft or Scheduled campaign. The button isn't shown otherwise.
• When it is greyed out: until you change something. No hover reason is shown.
• What can go wrong: "A campaign named <name> already exists" if the new name is taken (shown in the page alert and in the form banner). A template that is no longer usable is reported under Email template (see New campaign), with the page alert reading "Please correct the highlighted fields." A campaign that is Sending, Sent or Cancelled answers "A <status> campaign cannot be changed".

Build list / Rebuild list

The button on the Recipients card (it reads Build list the first time and Rebuild list after). Unsaved changes are saved first. The old list is thrown away and a new one is written from the audience: one row per matched contact, marked Pending, or Unsubscribed ("Contact unsubscribed") when the person is on the unsubscribe list, or Skipped ("No valid email address"). The counters reset and a message reads "N reachable recipient(s) (N skipped)."

• Who: anyone with the Edit permission on Campaigns, on a Draft or Scheduled campaign. The button isn't shown otherwise.
• What can go wrong: the page alert shows "A <status> campaign cannot be changed" if the campaign moved on while you were editing.

Count audience

Same as on New campaign: shows "N reachable of M matched (N without email, N unsubscribed)." with up to ten samples. Works in every status.

• Who: anyone with the View permission on Campaigns.

Preview for the first contact

Renders the subject and body for the first contact the audience finds, with the footer and unsubscribe link in place. Works in every status. If the audience finds nobody the card shows "No contact matches the audience yet".

• Who: anyone with the View permission on Campaigns.

Send test

Sends the email, merged for the first contact of the audience, to the address you typed, with the subject prefixed "[TEST]". A message confirms "Test sent to <address>." When no mail server is configured the message instead reads "MAIL_SERVER is not configured; the message was logged".

• Who: anyone with the send permission on Campaigns. Works in every status, so you can re-send a test from a campaign that already went out.
• When it is greyed out: while the address box is empty.
• What can go wrong: a badly formed address is refused; the card then shows only the terse message "validation error", so check the address and try again. "No contact matches the audience yet" appears when the audience is empty. If a configured mail server refuses the test, the message still reads "Logged (mail is not configured)."; ask your administrator to check the mail server.

Send

Opens the dialog "Send <campaign name>". It says "N reachable recipient(s) on the list." (or "The recipient list is built from the audience when you send." if no list exists) and, when you have unsaved changes, "Unsaved changes are saved first." Choose Send now or Schedule for with a date and time, then click Send now or Schedule (greyed out until a time is picked). The note reads "Mail goes out through the workflow worker in batches; the log below updates as it runs."

Afterwards: a scheduled campaign becomes Scheduled ("Scheduled for <date and time>."); an immediate send becomes Sending ("Sending started.") and the log fills in as batches go out. If the mail is sent inline rather than by the worker, the message reads "Sent to N recipient(s)." once it is done.

A Scheduled campaign still shows Send: open the dialog again to pick a new time or to send now.

• Who: anyone with both the Edit and the send permission on Campaigns, on a Draft or Scheduled campaign. The button isn't shown otherwise.
• When it is greyed out: when the list has no reachable recipient (nobody on it, or everyone skipped or unsubscribed) and you have no unsaved change. No hover reason is shown. Click Build list first; see Things to know.
• What can go wrong: "No reachable recipient in the audience" when nobody on the list can be mailed; "A <status> campaign cannot be changed" when the campaign is no longer Draft or Scheduled.

Cancel campaign

Asks "Cancel this campaign?": "Scheduled sends are dropped; a campaign in progress stops before the next recipient. Mail already sent cannot be recalled." Confirm with Cancel campaign. The campaign becomes Cancelled and a message reads "Campaign cancelled."

• Who: anyone with the send permission on Campaigns, on a Scheduled or Sending campaign. The button isn't shown for a Draft (there is nothing to stop; delete it from the list instead) or once the campaign is Sent or Cancelled.
• What can go wrong: if the campaign finished or was cancelled meanwhile, the page alert reads "A <status> campaign cannot be cancelled".

Statuses

Campaign:

• Draft: created; everything can be changed. Send > Schedule moves it to Scheduled; Send > Send now moves it to Sending.
• Scheduled: waits for its time, then moves to Sending on its own (checked every minute). Cancel campaign moves it to Cancelled. Details and audience can still be changed.
• Sending: mail is going out in batches of fifty. When the last pending recipient is processed it becomes Sent. Cancel campaign moves it to Cancelled.
• Sent and Cancelled are final. There is no reopen or resend; create a new campaign.

Recipient (in the log):

• Pending: on the list, not yet sent.
• Sent: delivered to the mail server, with the time in the Sent column. When no mail server is configured the row still reads Sent, with the note "MAIL_SERVER not configured; logged only".
• Failed: "Mail server refused the message", or the error text when something else went wrong.
• Skipped: "No valid email address" when the list was built.
• Unsubscribed: "Contact unsubscribed" when the list was built.

Things to know

• Build the list before you send. The Recipients card says Send builds the list for you, but the Send button stays greyed out until a list with at least one reachable recipient exists (or you have an unsaved change). Click Build list first; then Send lights up.
• A stale list is sent as it is. Changing the audience does not clear the list. If you change the audience after building, click Rebuild list before you send, or the old list goes out.
• Opt-outs are honoured when the list is built, not when the mail goes. A contact who unsubscribes after you built the list, or while a scheduled campaign waits, is still mailed. Rebuild the list just before sending a scheduled campaign if that matters.
• Cancel stops between batches. Mail goes out in batches of fifty; a cancel takes effect before the next batch, so up to fifty more mails may leave after you cancel. Mail already sent cannot be recalled.
• A scheduled campaign needs the background worker. Scheduled campaigns are picked up by the workflow scheduler every minute; if it is not running the campaign stays Scheduled. See Workflow health.
• The preview and test use the first matched contact, who may themselves have no email or be unsubscribed. The audience count tells you how many are reachable.
• Two contacts with the same address each get a mail. The unsubscribe list is kept per contact, not per address.
• Every mail carries an unsubscribe link. If the template body does not place {{ unsubscribe_url }} itself, a footer is added: "You receive this because you are in touch with <organization>. Unsubscribe" (or "Unsubscribe: <link>" in a plain-text template). The subject comes from the template, or the campaign name when the template has none.
• Recipient names link to a contact page the app does not have, so the link opens a page that cannot be found. Look the person up under Contacts instead.
• There is no History button on this page. Changes to a campaign are recorded and can be read in Settings > Audit log under the Sales component.

Related

• Campaigns
• New campaign
• Unsubscribes
• Contacts
• Message templates
• Workflow health
• Audit log