Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Email
Mailing Lists

Create mailing list

This function creates a Mailman mailing list.

Important:

When you disable the Receive Mail role, the system disables this function.

get/Email/add_list

Query parameters

domainstring domain required
Example:example.com

The domain.

liststring required
Example:newlist

The mailing list name.

passwordstring required
Example:12345luggage

The mailing list password.

private0 | 1

Whether the mailing list is private.

  • 1 — Private.
  • 0 — Public.
rebuildonly0 | 1

Whether to rebuild the mailing list.

  • 1 — Rebuild the mailing list.
  • 0 — Do not rebuild the mailing list.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "add_list",
  "module": "Email",
  "result": {
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}