Skip to content

Create a mailing list

Request

Adds a mailing list to the account.

Security
basicAuth
Bodymultipart/form-data
addressstringrequired

A valid email address for the mailing list, e.g. developers@mailgun.net, or Developers devs@mg.net

namestring

Mailing list name, e.g. Developers

descriptionstring

A description

access_levelstring

List access level, one of: readonly, members, everyone. Defaults to readonly

reply_preferencestring

Set where replies should go: list or sender. Defaults to list

curl -i -X POST \
  -u '<username>:<password>' \
  https://api.mailgun.net/v3/lists \
  -H 'Content-Type: multipart/form-data' \
  -F address=developers@mailgun.net \
  -F name=Developers \
  -F 'description=Describe the mailing list' \
  -F access_level=readonly \
  -F reply_preference=list

Responses

Mailing list creation success

Bodyapplication/json
listobject(The mailing list response)
Response
{
  "list": {
    "address": "developers@mailgun.net",
    "name": "Developers",
    "description": "Describe the mailing list",
    "access_level": "readonly",
    "reply_preference": "list",
    "created_at": "Tue, 09 Aug 2011 20:50:27 -0000",
    "members_count": 2
  },
  "message": "Mailing list has been created"
}