Class Interests

MailChimp\MailChimp

Extended by

MailChimp\Lists\Lists

Extended by

MailChimp\Lists\Interests

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

Methods summary

`public object`	# `getInterestCategories( string $list_id, array $query = [] )` Get information about a list’s interest categories. Get information about a list’s interest categories. 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["type"] string Restrict results a type of interest group Parameters `$list_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getInterestCategory( string $list_id, string $interest_category_id, array $query = [] )` Get information about a specific interest category. Get information about a specific interest category. 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` `$interest_category_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `createInterestCategory( string $list_id, array $title, $type, $display_order = null )` Create a new interest category Create a new interest category array["data"] ["title"] string The text description of this category. ["display_order"] int The order that the categories are displayed in the list. Lower numbers display first. ["type"] string Determines how this category’s interests are displayed on signup forms. Possible Values: checkboxes,dropdown,radio,hidden Parameters `$list_id` `$title` $data `$type` `$display_order` Returns object
`public object`	# `updateInterestCategory( string $list_id, string $interest_category_id, array $data = [] )` Update a specific interest category. Update a specific interest category. array["data"] ["title"] string The text description of this category. ["display_order"] int The order that the categories are displayed in the list. Lower numbers display first. ["type"] string Determines how this category’s interests are displayed on signup forms. Possible Values: checkboxes,dropdown,radio,hidden Parameters `$list_id` `$interest_category_id` `$data` Returns object
`public`	# `deleteInterestCategory( string $list_id, string $interest_category_id )` Delete a specific interest category. Delete a specific interest category. Parameters `$list_id` `$interest_category_id`
`public object`	# `getInterests( string $list_id, array $interest_category_id, array $query = [] )` Get a list of this category’s interests. Get a list of this category’s interests. 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` `$interest_category_id` $query (See Above) OPTIONAL associative array of query parameters. `$query` Returns object
`public object`	# `getInterest( string $list_id, string $interest_category_id, string $interest_id, array $query = [] )` Get interests or ‘group names’ for a specific category. Get interests or ‘group names’ for a specific category. 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` `$interest_category_id` `$interest_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `createInterest( string $list_id, string $interest_category_id, array $name, $display_order = null )` Create a new interest or ‘group name’ for a specific category. Create a new interest or ‘group name’ for a specific category. array["data"] ["name"] string The name of the interest. Parameters `$list_id` `$interest_category_id` `$name` $data (See Above) OPTIONAL associative array of query parameters. `$display_order` Returns object
`public object`	# `updateInterest( string $list_id, string $interest_category_id, string $interest_id, array $data = [] )` Update interests or ‘group names’ for a specific category. Update interests or ‘group names’ for a specific category. array["data"] ["name"] string The name of the interest. Parameters `$list_id` `$interest_category_id` `$interest_id` `$data` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `deleteInterest( string $list_id, string $interest_category_id, string $interest_id )` Delete interests or group names in a specific category. Delete interests or group names in a specific category. Parameters `$list_id` `$interest_category_id` `$interest_id` Returns object

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