API Documentation
Back to top  

Interest

Extends \MailChimp\Core\Model

Manage interests for a specific Mailchimp list. Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application.

package

Default

Methods

__construct

__construct(array $data = NULL)
inherited

Arguments

$data

array

all

all() : mixed

Get a list of this category's interests.

Response

mixed

api

api()
inherited

clear

clear()
inherited

config

config()
inherited

create

create() : \MailChimp\Models\Lists\Interest

Create a new interest or 'group name' for a specific category.

Response

\MailChimp\Models\Lists\Interest

delete

delete() : mixed

Delete interests or group names in a specific category.

Response

mixed

edit

edit() : \MailChimp\Models\Lists\Interest

Update interests or 'group names' for a specific category.

Response

\MailChimp\Models\Lists\Interest

getAction

getAction( $name)
inherited

Arguments

$name

Returns an ActionField object specified by `$action` and `$name`

getActionField(string $action, string $name) : \MailChimp\Core\ActionField
inherited

Arguments

$action

string

Action Name

$name

string

Field Name

Response

\MailChimp\Core\ActionField

Returns an array of action fields for an action

getActionFields(string $action) : array<mixed,\MailChimp\Core\ActionField>
inherited

Arguments

$action

string

Response

array<mixed,\MailChimp\Core\ActionField>

Returns Field Information

getField(string $name) : \MailChimp\Core\Field
inherited

Arguments

$name

string

Response

\MailChimp\Core\Field

Gets all allowed fields of a Data

getFields() : array
inherited

Response

array

Return API Path

getPath(\MailChimp\Core\string $child = NULL, array $params = NULL) : string
inherited

Arguments

$child

\MailChimp\Core\string

$params

array

Response

string

Return true if field exists or false otherwise

hasField(string $name) : boolean
inherited

Arguments

$name

string

Field name

Response

boolean

initialize

initialize()
inherited

jsonSerialize

jsonSerialize()
inherited

merge

merge( $data)
inherited

Arguments

$data

own

own( $class,  $args)
inherited

Arguments

$class

$args

parseActionPath

parseActionPath( &$params)
inherited

Arguments

$params

read

read() : \MailChimp\Models\Lists\Interest

Get interests or 'group names' for a specific category.

Response

\MailChimp\Models\Lists\Interest

reference

reference( &$field,  $name)
inherited

Arguments

$field

$name

setApi

setApi(\MailChimp\Interfaces\MailChimpInterface &$api)
inherited

Arguments

$api

\MailChimp\Interfaces\MailChimpInterface

setConfig

setConfig(\MailChimp\Interfaces\ConfigInterface &$config)
inherited

Arguments

$config

\MailChimp\Interfaces\ConfigInterface

Properties

API Endpoint

path : string
inherited
var

Type(s)

string

Path Parameters

params : array
inherited
var

Type(s)

array

Action Fields Configurations

action : array
inherited
var

Type(s)

array

Info for all action fields

_action : array
inherited
var

Type(s)

array

Data holder for predefined fields

data : object
inherited
var

Type(s)

object

Info for unreferenced action fields

_fields : array
inherited
var

Type(s)

array

API Query builder

builder : \MailChimp\Core\Builder
inherited
var

Type(s)

\MailChimp\Core\Builder

Fields for the model

fields : array
inherited
var

Type(s)

array

Reference map for fields

_reference : array
inherited
var

Type(s)

array

_api

_api :
inherited

Type(s)

_config

_config :
inherited

Type(s)

id

id : string

The ID for the interest.

Type(s)

string

list_id

list_id : string

The ID for the list that this interest belongs to.

Type(s)

string

category_id

category_id : string

The id for the interest category.

Type(s)

string

name

name : string

The name of the interest. This can be shown publicly on a subscription form.

Type(s)

string

subscriber_count

subscriber_count : string

The number of subscribers associated with this interest.

Type(s)

string

display_order

display_order : integer

The display order for interests.

Type(s)

integer

_links

_links : array<mixed,\MailChimp\Data\Link>

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

Type(s)

array<mixed,\MailChimp\Data\Link>