Skip to content
/
Update a mailing list

Update a mailing list

Request

Update mailing list properties, such as address, description or name

Security
basicAuth
Path
list_addressstringrequired

The mailing list's address

Bodymultipart/form-data
addressstring

The new mailing list address.

descriptionstring
namestring
access_levelstring

One of: readonly, members, everyone. Defaults to readonly.

reply_referencestring

Set where replies should go. Can be list or sender. Defaults to list.

list-idstring
curl -i -X PUT \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v3/lists/{list_address}' \
  -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 \
  -F list_id=123

Responses

OK

Bodyapplication/json
messagestring

Success message

listobject(The mailing list response)
Response
{
  "message": "Mailing list has been updated",
  "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
  }
}