Add a member

Add a member to a mailing list.

Adds a recipient to the list. The member’s vars are merged into the template on every list send.

POST /v3/lists/{address}/members

Body parameters

ParameterTypeRequiredDescription
addressstringRequiredThe member’s email address.
namestringOptionalDisplay name, available as {{name}} in sends.
varsobjectOptionalPer-member merge variables, e.g. {"plan": "pro"}.

Responses

StatusDescription
201Created. The new list member.
400Validation error.
401Missing or invalid API key.
404No mailing list at this address.

Code examples

cURL
curl -X POST https://api.wemail.io/v3/lists/{address}/members \
  -H "Authorization: Bearer afn_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "address": "alice@example.com", "name": "Alice", "vars": { "plan": "pro", "region": "eu" } }'
Node.js
const res = await fetch("https://api.wemail.io/v3/lists/{address}/members", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.WEMAIL_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ "address": "alice@example.com", "name": "Alice", "vars": { "plan": "pro", "region": "eu" } }),
});
const data = await res.json();
Python
import os, requests

r = requests.post(
    "https://api.wemail.io/v3/lists/{address}/members",
    headers={"Authorization": f"Bearer {os.environ['WEMAIL_API_KEY']}"},
    json={ "address": "alice@example.com", "name": "Alice", "vars": { "plan": "pro", "region": "eu" } },
)
data = r.json()