| docs

Appearance

Mailing Lists ​

Mailing Lists

URL: /client/mailing-lists

Create and manage mailing lists for group email communication.

Manage Mailing Lists ​

Organize and control all mailing lists from a single interface.

  • Create Mailing List button - Add a new mailing list
  • Search bar - Find lists by name or domain
  • Filter button - Filter by moderation status (Yes/No/-), archiving status (Yes/No/-), or reset filters
  • Toggle columns button - Show or hide the Created column
  • Empty state - “No Mailing Lists” displays when no lists exist
  • Pagination - Navigate through multiple pages of mailing lists

Each mailing list can be configured with moderation and archiving settings to control how messages are handled and stored.

Creating a Mailing List ​

  • List Name (text, required) - The name of your mailing list (the part before the @ symbol). The name can contain only letters, digits, underscores (_), and hyphens (-); dots and spaces are not allowed.
  • Domain (dropdown, required) - Select which domain this mailing list will use
  • Enable Moderation (toggle) - Turn on moderation to review messages before they are delivered to list members
  • Enable Archiving (toggle) - Turn on archiving to store copies of all messages sent to the list
  • Custom Settings (table) - Optional advanced settings displayed in a key-value table format

Form buttons: Create, Create & create another, Cancel

Deleting a Mailing List ​

Delete in a list's row removes the list. A list that still has active subscribers is not deleted: unsubscribe them on the Subscribers page first. Since panel 1.9.1, deleting a list also deletes its archive of messages.

Over the API ​

Since panel 1.9.4, the mailing list REST API under /api/mailing-lists offers the list operations of this page. It is rate limited like the rest of the client API, and it follows your hosting plan: the lists and their moderation need the Mailing Lists feature, the subscribers need the Subscribers feature. See API Keys.

Method and pathWhat it does
GET /api/mailing-listsList the mailing lists of the account.
GET /api/mailing-lists/{id}Read one list.
POST /api/mailing-lists/createCreate a list on one of the account's domains.
PUT or PATCH /api/mailing-lists/{id}Change what the Edit form changes: moderation, archiving, and the custom settings. Send at least one field.
DELETE /api/mailing-lists/{id}Delete a list and its archived posts. As on this page, a list that still has active subscribers is not deleted: unsubscribe them first.
POST /api/mailing-lists/moderationTurn moderation of a list on or off.
POST /api/mailing-lists/moderatorsAdd moderators to a list.
POST /api/mailing-lists/subscribe
POST /api/mailing-lists/unsubscribe		Subscribe or unsubscribe an address.
GET /api/mailing-lists/subscribersList the active subscribers of a list.

Every refusal is a JSON answer with HTTP 422. A field the endpoint does not take is named in error, and a value that fails validation is listed under errors, by field. A list of another account answers 404, the same as one that does not exist.

Since panel 1.9.4, Save on a list's Edit form also keeps its custom settings.