Class Members

MailChimp\MailChimp

Extended by

MailChimp\Lists\Lists

Extended by

MailChimp\Lists\Members

Namespace: MailChimp\Lists
Located at Lists/Members.php

Methods summary

`public object`	# `getListMembers( string $list_id, array $query = [] )` Get a list of list members Get a list of list members Parameters `$list_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getListMember( string $list_id, string $email_address, array $query = [] )` Get a single list members Get a single list members Parameters `$list_id` `$email_address` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getMemberActiity( string $list_id, string $email_address, array $query = [] )` Get the last 50 events of a member’s activity on a specific list, including opens, clicks, and unsubscribes. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Get the last 50 events of a member’s activity on a specific list, including opens, clicks, and unsubscribes. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$list_id` `$email_address` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getMemberGoals( string $list_id, string $email_address, array $query = [] )` Get the last 50 Goal events for a member on a specific list Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Get the last 50 Goal events for a member on a specific list Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$list_id` `$email_address` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getMemberNotes( string $list_id, string $email_address, array $query = [] )` Get recent notes for a specific list member Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") array["count"] int number of records to return array["offset"] int number of records from a collection to skip. Get recent notes for a specific list member Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") array["count"] int number of records to return array["offset"] int number of records from a collection to skip. Parameters `$list_id` `$email_address` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getMemberNote( string $list_id, string $email_address, array $note_id, array $query = [] )` Get a specific note for a specific list member. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Get a specific note for a specific list member. Available query fields: array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$list_id` `$email_address` `$note_id` $query (See Above) OPTIONAL associative array of query parameters. `$query` Returns object
`public object`	# `addListMember( string $list_id, string $email_address, string $status, array $optional_settings = null )` Add List Member "email_address" string required "status" string required Possible Values: subscribed,unsubscribed,cleaned,pending array["optional_settings"] Add List Member "email_address" string required "status" string required Possible Values: subscribed,unsubscribed,cleaned,pending array["optional_settings"] Parameters `$list_id` `$email_address` `$status` `$optional_settings` Returns object
`public object`	# `upsertListMember( string $list_id, string $email_address, array $data = [] )` Add or Update List Member array["data"] ["status"] string required Possible Values: subscribed,unsubscribed,cleaned,pending Add or Update List Member array["data"] ["status"] string required Possible Values: subscribed,unsubscribed,cleaned,pending Parameters `$list_id` `$email_address` `$data` data Returns object
`public object`	# `updateListMember( string $list_id, array $email_address, array $data = [] )` Update List Member array["data"] ["email_address"] string required ["status"] string required Possible Values: subscribed,unsubscribed,cleaned,pending Update List Member array["data"] ["email_address"] string required ["status"] string required Possible Values: subscribed,unsubscribed,cleaned,pending Parameters `$list_id` `$email_address` data `$data` Returns object
`public object`	# `addMemberNote( string $list_id, string $email_address, array $data = [] )` Add a new note for a specific subscriber array["data"] ["note"] string The content of the note. Add a new note for a specific subscriber array["data"] ["note"] string The content of the note. Parameters `$list_id` `$email_address` `$data` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `updateMemberNote( string $list_id, string $email_address, integer $note_id, array $data = [] )` Update a specific note for a specific list member. array["data"] ["note"] string The content of the note. Update a specific note for a specific list member. array["data"] ["note"] string The content of the note. Parameters `$list_id` `$email_address` `$note_id` $noteId `$data` (See Above) OPTIONAL associative array of query parameters. Returns object
`public`	# `deleteMemberNote( string $list_id, string $email_address, integer $note_id )` Delete a specific note for a specific list member. Delete a specific note for a specific list member. Parameters `$list_id` `$email_address` `$note_id` $noteId
`public`	# `deleteListMember( string $list_id, string $email_address )` Delete a subscriber Delete a subscriber Parameters `$list_id` `$email_address` address

Methods inherited from MailChimp\Lists\Lists

batchMembers(), createList(), deleteList(), getAbuseReport(), getAbuseReports(), getActivity(), getClients(), getGrowthHistory(), getGrowthHistoryMonth(), getList(), getLists(), interests(), members(), mergeFields(), segments(), signupForms(), updateList(), webhooks()

Methods inherited from MailChimp\MailChimp

__construct(), authorizedApps(), automations(), batchOps(), campaignFolders(), campaigns(), conversations(), createLog(), ecommerce(), execute(), fileManager(), fileManagerFolders(), getAccountInfo(), getMemberHash(), lists(), logData(), optionalFields(), reports(), searchMembers(), templateFolders(), templates()