Sign in

v1

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

Update mailing list privacy options

This function modifies a Mailman mailing list's privacy options.

Important:

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

get/Email/set_list_privacy_options

Query parameters

advertised0 | 1 required
Example:1

Whether the Mailman directory page displays the list.

  • 1 - Display.
  • 0 - Does not display.
archive_private0 | 1 required
Example:1

Whether the mailing list archive is private.

  • 1 - Private.
  • 0 - Public.
liststring required
Example:mylist

The mailing list name.

subscribe_policy1 | 2 | 3 required
Example:1

The level of control that the mailing list administrator has over new subscribers.

  • 1 - Anyone can subscribe. The system sends a confirmation email.
  • 2 - The administrator must approve subscriptions. The system does not send a confirmation email.
  • 3 - The administrator must approve subscriptions. The system sends a confirmation email.

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": "set_list_privacy_options",
  "module": "Email",
  "result": {
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}