Operator guideEN

Email Newsletters / Campaigns

Main newsletter program inventory with filters, status badges, active-state checks, and edit navigation.

How to use this guide

Start with the main guide

Follow the explanation and examples first. Extra definitions and formulas are available below when you need them.

What this page shows

This is the main campaign-program list for newsletter operations. Operators use it to find a campaign, confirm whether it is active, inspect schedule state, and open the full program editor.

How the page is organized

  • the header action starts a new program
  • the filters accordion stages name, status, active state, day of week, and creation-date filters until the operator presses Search
  • the main table shows the campaign identity, schedule summary, activation state, and the edit entrypoint
  • top and bottom pagination controls move through the same campaign result set

Important operator meanings

  • Status shows the current newsletter processing state, not just a visual badge
  • Is Active tells you whether the campaign is enabled to run
  • Scheduled Date and Created At are shown as timestamp fields on this grid
  • Clicking the program Name and clicking the pencil icon both open the same program editor
  • Date Range Preset only fills date filters; it does not apply the search until Search is pressed
  • Reset clears both the visible filter values and the applied table filters

Known caveats

  • The page contains sibling tabs for Distribution Lists and Send Logs; those are documented separately because they have different actions and meanings.
  • The list only opens the program editor. It does not expose a direct send-now action from the grid.
  • Date presets are shortcuts for building creation-date filter ranges before Search is pressed.
  • Created To (UTC) is normalized to the end of the selected day before the timestamp is serialized; timezone conversion can shift the exact request boundary.
  • Search applies the current draft filters; typing or choosing values in the accordion does not re-query the grid until Search runs.
  • If the newsletter connection settings are missing or invalid, the Campaigns list can show a configuration or loading error instead of campaign rows.
More details

Definitions and formulas

Open only the section you need. The relevant section opens automatically when you request help for a specific item on screen.

Calculations9 topicsOpen details

Staged filter apply

Logic
The filter accordion keeps separate draft and applied state for `Name`, `Status`, `Is Active`, `Day of Week`, `Created From`, and `Created To`., Editing filter controls does not re-query the grid immediately., `Search` copies the draft state into the applied query state and resets pagination to page `0`.

Reset clears draft and applied filters

Logic
`Reset` clears both the visible draft values and the currently applied request values., `Reset` also clears `Date Range Preset` and resets pagination to page `0`.

Date preset population

Logic
`Date Range Preset` only populates the draft `Created From` and `Created To` values., Changing the preset does not affect the backend query until `Search` is pressed., Manual changes to either date picker clear the selected preset.

Created To end-of-day normalization

Logic
The UI sets `Created To (UTC)` to end-of-day on the selected date before serializing the value., The applied request sends the value as a UTC ISO timestamp, so timezone conversion can shift the exact serialized boundary if the picker value was not already UTC., This happens even though the control is displayed as a date-time picker.

Status pill coloring

Logic
`DONE` renders as a success pill., `ERROR` renders as an error pill., All other status values render as an info pill.

Active pill labeling

Logic
`is_active = true` renders as `ACTIVE`., `is_active = false` renders as `NO ACTIVE`.

Campaign pagination request

Logic
The UI keeps a zero-based `page` value for the table., The campaign list hook sends `pageNo = page + 1` to the newsletter proxy., Changing rows per page updates `limit` and resets the UI page back to `0`., Top and bottom paginators share the same page and rows-per-page state.

Newsletter proxy settings

Logic
The list request is sent to `/api/newsletter/configs` from the browser., The backoffice proxy resolves `newsletterURL` and `newsletterMerchantKey` from core system settings before forwarding the request., If either setting is missing, the proxy falls back to `NEWSLETTER_SERVICE_URL` and `NEWSLETTER_MERCHANT_KEY`., The forwarded request goes to the newsletter service as `/api/configs` with `x-merchant-key`., If URL or merchant key is missing after both lookup steps, the proxy returns a configuration error and the Campaigns list cannot load.

Duplicate navigation entrypoints

Logic
Clicking the `Name` button and clicking the `Edit` icon both navigate to `/email-newsletters/program/:id`., The table does not expose a second detail-only route.
Columns9 topicsOpen details

ID

Internal newsletter program identifier.

Visual Type
grid-column

Name

Human-readable campaign program name. Clicking it opens the editor.

Visual Type
link

Type

Whether the program is `ONE_TIME` or `WEEKLY`.

Visual Type
badge

Status

Current processing state reported by the newsletter backend.

Visual Type
badge

Day

Weekday used for recurring programs.

Visual Type
grid-column

Time

Planned send time for recurring programs.

Visual Type
grid-column

Scheduled Date

UTC date-time for one-time execution.

Visual Type
datetime

Is Active

Whether the campaign remains enabled to run.

Visual Type
badge
Caveats
The FE badge text is `ACTIVE` or `NO ACTIVE`, not a raw boolean.

Created At

UTC creation timestamp for the program.

Visual Type
datetime
Filters7 topicsOpen details

Name

Filters newsletter programs by program name.

Type
text
Affects
list_results

Status

Narrows the grid to one campaign status such as `SCHEDULED`, `IN_PROGRESS`, or `DONE`.

Type
select
Affects
list_results
Values
All, (Empty), SCHEDULED, IN_PROGRESS, DONE, ERROR, CANCELLED, WAIT_NEXT

Is Active

Filters the list by campaigns that are enabled or disabled.

Type
select
Affects
list_results
Values
All, Active, Not Active

Day of Week

Narrows recurring weekly programs by scheduled weekday.

Type
select
Affects
list_results
Values
All, (Empty), MON, TUE, WED, THU, FRI, SAT, SUN

Date Range Preset

Populates Created From and Created To draft values with a common date range before Search is pressed.

Type
select
Affects
draft_filter_state
Values
Custom Range, Today, Yesterday, Last 7 Days, Previous Week, Previous Month, Current Year, Previous Year
Caveats
Presets do not re-query the grid until Search is pressed., Manual date changes clear the selected preset.

Created From

Lower bound for program creation time sent with the campaign-list request.

Type
datetime
Affects
list_results
Caveats
Editing this value changes draft filter state first; Search is required to apply it.

Created To (UTC)

Upper bound for program creation time sent with the campaign-list request.

Type
datetime
Affects
list_results
Caveats
The UI normalizes the selected value to the end of the chosen day before it serializes the request timestamp., Timezone conversion can shift the exact serialized boundary if the picker value was not already UTC., Editing this value changes draft filter state first; Search is required to apply it.
More help

Related pages

Email Newsletters

Operator workspace for newsletter campaigns, distribution lists, and send-log review.

Email Newsletters / Program

Full create and edit workflow for one newsletter campaign program, including recipients, templates, notifications, coupons, and delivery settings.

Activity Tag Rules / List

Main inventory for activity-driven tag rules, with search, activity and status filters, grouped rows, clone, edit, and run actions.

Affiliate Deals / List

Searchable table of affiliate deal rows with PID filter, create action, dashboard shortcut, and edit/delete row actions.

Affiliate Payment Settings / List

Affiliate payment settings inventory page for reviewing configured rows and opening saved records.

Affiliate Settings / List

Affiliate inventory list used to review saved affiliates and open detail or report flows.