Class Lists

MailChimp\MailChimp

Extended by

MailChimp\Lists\Lists

Direct known subclasses

MailChimp\Lists\Interests, MailChimp\Lists\Members, MailChimp\Lists\MergeFields, MailChimp\Lists\Segments, MailChimp\Lists\SignupForms, MailChimp\Lists\Webhooks

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

Methods summary

`public object`	# `getLists( array $query = [] )` Get a list of lists for the account Get a list of lists for the account 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. array["before_date_created"] string Restrict response to lists created before the set date. ISO 8601 time format: 2015-10-21T15:41:36+00:00. array["since_date_created"] string Restrict results to lists created after the set date. ISO 8601 time format: 2015-10-21T15:41:36+00:00. array["before_campaign_last_sent"] string Restrict results to lists created before the last campaign send date. ISO 8601 time format: 2015-10-21T15:41:36+00:00. array["since_campaign_last_sent"] string Restrict results to lists created after the last campaign send date. ISO 8601 time format: 2015-10-21T15:41:36+00:00. email string Restrict results to lists that include a specific subscriber’s email address.` Parameters `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getList( string $list_id, array $query = [] )` Get a single list Get a single list 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` for the list instance `$query` (See Above) OPTIONAL associative array of query parameters. Returns object list instance
`public object`	# `createList( string $name, string $permission_reminder, boolean $email_type_option, array $campaign_defaults = [], array $contact = [], array $optional_settings = null )` Create a list Create a list ["name"] string required ["permission_reminder"] string required ["email_type_option"] boolean required array["contact"] array required ["company"] string required ["address1"] string required ["address2"] string ["city"] string required ["state"] string required ["zip"] string required ["country"] string required ["phone"] string array["campaign_defaults"] array required ["from_name"] string required ["from_email"] string required ["subject"] string required ["language"] string required array["optional_settings"] ["use_archive_bar"] boolean ["notify_on_subscribe"] string The email address to send subscribe notifications to. ["notify_on_unsubscribe"] string The email address to send unsubscribe notifications to. ["visibility"] string Whether this list is public or private. Possible Values: pub,prv Parameters `$name` `$permission_reminder` `$email_type_option` `$campaign_defaults` `$contact` `$optional_settings` $optional_setttings (See Above) Returns object created list information
`public object`	# `updateList( string $list_id, array $data = [] )` Update an existing list Update an existing list Parameters `$list_id` list id for list to edit `$data` fields to update (See structure from createList) Returns object updated list
`public`	# `batchMembers( $list_id, array $batch = [], $updateExisting = false )`
`public object`	# `getAbuseReports( string $list_id, array $query = [] )` Get all abuse reports for a specific list. Get all abuse reports for 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") array["count"] int number of records to return array["offset"] int number of records from a collection to skip. Parameters `$list_id` list id for list to edit `$query` fields to update (See structure from createList) Returns object
`public object`	# `getAbuseReport( string $list_id, string $report_id, array $query = [] )` Get details about a specific abuse report. Get details about a specific abuse report. 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` list id for list to edit `$report_id` $reportId `$query` fields to update (See structure from createList) Returns object
`public object`	# `getActivity( string $list_id, array $query = [] )` Get recent daily, aggregated activity stats for your list. Get recent daily, aggregated activity stats for your list. For example, view unsubscribes, signups, total emails sent, opens, clicks, and more, for up to 180 days. 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` list id for list to edit `$query` fields to update (See structure from createList) Returns object
`public object`	# `getClients( string $list_id, array $query = [] )` Get a list of the top email clients based on user-agent strings. Get a list of the top email clients based on user-agent strings. 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` list id for list to edit `$query` fields to update (See structure from createList) Returns object
`public object`	# `getGrowthHistory( string $list_id, array $query = [] )` Get a month-by-month summary of a specific list’s growth activity. Get a month-by-month summary of a specific list’s growth activity. 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` list id for list to edit `$query` fields to update (See structure from createList) Returns object
`public object`	# `getGrowthHistoryMonth( string $list_id, string $month, array $query = [] )` Get a summary of a specific list’s growth activity for a specific month and year. Get a summary of a specific list’s growth activity for a specific month and year. 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` list id for list to edit `$month` format: yyyy-mm `$query` fields to update (See structure from createList) Returns object
`public`	# `deleteList( string $list_id )` Delete a list Delete a list Parameters `$list_id` id
`public`	# `interests( )` Instantiate lists interests subresources Instantiate lists interests subresources
`public`	# `members( )` Instantiate lists Members subresources Instantiate lists Members subresources
`public`	# `mergeFields( )` Instantiate lists MergeFields subresources Instantiate lists MergeFields subresources
`public`	# `segments( )` Instantiate lists Segments subresources Instantiate lists Segments subresources
`public`	# `signupForms( )` Instantiate lists signupForms subresources Instantiate lists signupForms subresources
`public`	# `webhooks( )` Instantiate lists webhooks subresources Instantiate lists webhooks subresources

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()