Operator guideENnewslettercampaignsdistribution-listssend-logs

Email Newsletters

Operator workspace for newsletter campaigns, distribution lists, and send-log review through the backoffice newsletter proxy.

Reader view

Clean portal guidance

This page keeps the operator explanation, field and action descriptions, and screenshots visible without exposing repo paths, raw sidecars, or editorial-only implementation details.

Narrative content

Page body

What this module is for

Use Email Newsletters to manage campaign programs that send emails or notifications to selected recipient groups.

The route combines three operator surfaces:

  • Campaigns: the main program inventory and launch point for create or edit
  • Distribution Lists: reusable contact lists and CSV upload flows
  • Send Logs: delivery history and troubleshooting surface

Main surfaces

  • List: campaign inventory with filters, status badges, active-state checks, and edit navigation
  • Detail: full create and edit workflow for one newsletter program
  • Distribution Lists: reusable recipient lists with CSV upload and add-contacts actions
  • Send Logs: log search for campaign delivery outcomes

Important caveats

  • This module is not backed by a direct gs-admin-backend CRUD surface. The FE talks to /api/newsletter/*, which proxies to nx-newsletter-service.
  • The proxy resolves newsletterURL and newsletterMerchantKey from core system settings before it forwards the request, so both the proxy and the core settings contract are part of the verified path.
  • Template selection, notification linking, and recipient calculation all happen inside the program editor and rely on several downstream services, not just one form submit.

Verification status

  • status: verified_backend_and_core
  • verified path:
    • FE route and hooks in nx-admin-fe-workspace
    • proxy route apps/backoffice/pages/api/newsletter/[...path].ts
    • core settings newsletterURL and newsletterMerchantKey
    • downstream nx-newsletter-service HTTP contract for configs, distribution-lists, send-logs, templates, and file upload helpers
Related references

Related pages

pageEmail Newsletters / Campaigns

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

pageEmail Newsletters / Program

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

pageDistribution Lists

Operator documentation for newsletter recipient lists, including detail, rename, contacts inspection, and CSV upload or attach flows.

pageDistribution Lists / Contacts

Read-only contact grid attached to one newsletter distribution list.

pageDistribution Lists / Detail

Read-only detail workspace for one distribution list and the contacts currently attached to it.

pageDistribution Lists / Form

Rename flow for an existing distribution list plus the implicit create-a-list branch triggered from the CSV upload card.