Add member to segment

POST

https://api.mailchimp.com/3.0/lists/:list_id/segments/:segment_id/members

POST

/3.0/lists/:list_id/segments/:segment_id/members

curl -X POST https://api.mailchimp.com/3.0/lists/list_id/segments/segment_id/members \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "email_address": "string"
}'

200Successful

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "email_address": "string",
  "email_client": "string",
  "email_type": "string",
  "full_name": "string",
  "id": "string",
  "interests": {},
  "ip_opt": "string",
  "ip_signup": "string",
  "language": "string",
  "last_changed": "2024-01-15T09:30:00Z",
  "last_note": {
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": "string",
    "note": "string",
    "note_id": 1
  },
  "list_id": "string",
  "location": {
    "country_code": "string",
    "dstoff": 1,
    "gmtoff": 1,
    "latitude": 1.1,
    "longitude": 1.1,
    "timezone": "string"
  },
  "member_rating": 1,
  "merge_fields": {},
  "stats": {
    "avg_click_rate": 1.1,
    "avg_open_rate": 1.1
  },
  "status": "subscribed",
  "timestamp_opt": "2024-01-15T09:30:00Z",
  "timestamp_signup": "2024-01-15T09:30:00Z",
  "unique_email_id": "string",
  "vip": true
}

Add a member to a static segment.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

list_idstringRequired

The unique ID for the list.

segment_idstringRequired

The unique id for the segment.

Request

This endpoint expects an object.

email_addressstringRequiredformat: "email"

Email address for a subscriber.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

email_addressstringOptionalRead-only

Email address for a subscriber.

email_clientstringOptionalRead-only

The list member's email client.

email_typestringOptional

Type of email this member asked to get ('html' or 'text').

full_namestringOptionalRead-only

The contact's full name.

idstringOptionalRead-only

The MD5 hash of the lowercase version of the list member's email address.

interestsmap from strings to booleansOptional

The key of this object's properties is the ID of the interest in question.

ip_optstringOptionalRead-only

The IP address the subscriber used to confirm their opt-in status.

ip_signupstringOptionalRead-only

IP address the subscriber signed up from.

languagestringOptional

If set/detected, the subscriber's language.

last_changeddatetimeOptionalRead-only

The date and time the member's info was last changed in ISO 8601 format.

last_noteobjectOptionalRead-only

The most recent Note added about this member.

list_idstringOptionalRead-only

The list id.

locationobjectOptional

Subscriber location information.

member_ratingintegerOptionalRead-only

Star rating for this member, between 1 and 5.

merge_fieldsmap from strings to objects or strings or doubles or nullOptional

A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.

statsobjectOptionalRead-only

Open and click rates for this subscriber.

statusenumOptional

Subscriber's current status.

Allowed values:

timestamp_optdatetimeOptionalRead-only

The date and time the subscriber confirmed their opt-in status in ISO 8601 format.

timestamp_signupdatetimeOptionalRead-only

The date and time the subscriber signed up for the list in ISO 8601 format.

unique_email_idstringOptionalRead-only

An identifier for the address across all of Mailchimp.

vipbooleanOptional

VIP status for subscriber.