Create one-time password for a mailing list

This function generates a one-time password (OTP) for a mailing list.

Note:

The generated password expires after one use.

Important:

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

SecurityBasicAuth

Request

query Parameters

list

required

string

The mailing list.

Example: list=mylist

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Email/generate_mailman_otp

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Email \
  generate_mailman_otp \
  list='mylist'

Response samples

application/json

{"apiversion": 3,
"func": "generate_mailman_otp",
"module": "Email",
"result": {"data": "LfFYLPRT_UoS4EDi9lGKuOFK8FaWQsozzPYn8WjM3",
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}