List unsubscribed members

GET

https://api.mailchimp.com/3.0/reports/:campaign_id/unsubscribed

GET

/3.0/reports/:campaign_id/unsubscribed

curl https://api.mailchimp.com/3.0/reports/campaign_id/unsubscribed \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "campaign_id": "string",
  "total_items": 1,
  "unsubscribes": [
    {
      "_links": [
        {
          "href": "string",
          "method": "GET",
          "rel": "string",
          "schema": "string",
          "targetSchema": "string"
        }
      ],
      "campaign_id": "string",
      "email_address": "string",
      "email_id": "string",
      "list_id": "string",
      "list_is_active": true,
      "merge_fields": {},
      "reason": "string",
      "timestamp": "2024-01-15T09:30:00Z",
      "vip": true
    }
  ]
}

Get information about members who have unsubscribed from a specific campaign.

Authentication

AuthorizationBearer

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

AuthorizationBearer

Authorization using OAuth

Path parameters

campaign_idstringRequired

The unique id for the campaign.

Query parameters

fieldslist of stringsOptional

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldslist of stringsOptional

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

countintegerOptional<=1000Defaults to 10

The number of records to return. Default value is 10. Maximum value is 1000

offsetintegerOptionalDefaults to 0

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

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

campaign_idstringOptionalRead-only

The campaign id.

total_itemsintegerOptionalRead-only

The total number of items matching the query regardless of pagination.

unsubscribeslist of objectsOptional

An array of objects, each representing a member who unsubscribed from a campaign.