Skip to content
/
Update a mailing list mem...

Update a mailing list member

Request

Updates a mailing list member with the given properties. Existing properties not included in the request will not be changed.

Security
basicAuth
Path
list_addressstringrequired

The mailing list's address

member_addressstringrequired

The member's address

Bodymultipart/form-data
addressstring

A valid email address specification.

namestring

An optional member name.

varsobject

JSON-encoded dictionary string with arbitrary parameters.

subscribedboolean

Set the member to subscribed or not. Defaults to True.

curl -i -X PUT \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v3/lists/{list_address}/members/{member_address}' \
  -H 'Content-Type: multipart/form-data' \
  -F address=alice@example.com \
  -F name=Alice \
  -F 'vars={"gender":"female","age":27}' \
  -F subscribed=true

Responses

OK

Bodyapplication/json
memberobject(ListMemberResponse)
messagestring

Success message

Response
{
  "member": {
    "address": "alice@example.com",
    "name": "Alice",
    "vars": { … },
    "subscribed": true
  },
  "message": "Mailing list member has been updated"
}