Batch add or remove members

POST

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

POST

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

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

200Successful

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "error_count": 42,
  "errors": [
    {
      "email_addresses": [
        "string"
      ],
      "error": "string"
    }
  ],
  "members_added": [
    {
      "_links": [
        {
          "href": "string",
          "method": "GET",
          "rel": "string",
          "schema": "string",
          "targetSchema": "string"
        }
      ],
      "contact_id": "string",
      "email_address": "string",
      "email_client": "string",
      "email_type": "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",
      "tags": [
        {
          "id": 1,
          "name": "string"
        }
      ],
      "tags_count": 1,
      "timestamp_opt": "2024-01-15T09:30:00Z",
      "timestamp_signup": "2024-01-15T09:30:00Z",
      "unique_email_id": "string",
      "vip": true
    }
  ],
  "members_removed": [
    {
      "_links": [
        {
          "href": "string",
          "method": "GET",
          "rel": "string",
          "schema": "string",
          "targetSchema": "string"
        }
      ],
      "contact_id": "string",
      "email_address": "string",
      "email_client": "string",
      "email_type": "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",
      "tags": [
        {
          "id": 1,
          "name": "string"
        }
      ],
      "tags_count": 1,
      "timestamp_opt": "2024-01-15T09:30:00Z",
      "timestamp_signup": "2024-01-15T09:30:00Z",
      "unique_email_id": "string",
      "vip": true
    }
  ],
  "total_added": 42,
  "total_removed": 42
}

Batch add/remove list members to 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

Members to add/remove to/from a static segment

members_to_addlist of stringsOptional

An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent.

members_to_removelist of stringsOptional

An array of emails to be used for a static segment. Any emails provided that are not present on the list will be ignored. A maximum of 500 members can be sent.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

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

error_countintegerOptional

The total number of items matching the query, irrespective of pagination.

errorslist of objectsOptional

An array of objects, each representing an array of email addresses that could not be added to the segment or removed and an error message providing more details.

members_addedlist of objectsOptional

An array of objects, each representing a new member that was added to the static segment.

members_removedlist of objectsOptional

An array of objects, each representing an existing list member that got deleted from the static segment.

total_addedintegerOptional

The total number of items matching the query, irrespective of pagination.

total_removedintegerOptional

The total number of items matching the query, irrespective of pagination.