reports

Get unsubscribed member

Get information about a specific list member who unsubscribed from a campaign.

get/3.0/reports/{campaign_id}/unsubscribed/{subscriber_hash}

Request

Base URL
https://api.mailchimp.com
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://login.mailchimp.com/oauth2/authorize
  Token URLhttps://login.mailchimp.com/oauth2/token
TypeScript
https://skmtc.dev/mailchimp/apis/mailchimp-api/docs/3.0/reports/:campaign_id/unsubscribed/:subscriber_hash/get.ts
A function with typed inputs. Its response is checked against the schema.

campaign_idstring required

The unique id for the campaign.

subscriber_hashstring required

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

fieldsstring[]

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

exclude_fieldsstring[]

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

campaign_idstring

The campaign id.

email_addressstring

Email address for a subscriber.

email_idstring

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

list_idstring

The list id.

list_is_activeboolean

The status of the list used, namely if it's deleted or disabled.

merge_fieldsobject nullable

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

reasonstring

If available, the reason listed by the member for unsubscribing.

timestampstring date-time

The date and time the member opted-out in ISO 8601 format.

vipboolean

VIP status for subscriber.

No recorded changes to this operation across all 1 revision of this API.