API Documentation
Back to top  

MergeField

Extends \MailChimp\Core\Model

Manage merge fields (formerly merge vars) for a specific list.

package

Default

Methods

__construct

__construct(array $data = NULL)
inherited

Arguments

$data

array

all

all() : \MailChimp\Response\MergeFieldListResponse

Get a list of all merge fields (formerly merge vars) for a list.

Response

\MailChimp\Response\MergeFieldListResponse

api

api()
inherited

clear

clear()
inherited

config

config()
inherited

create

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

Add a new merge field for a specific list.

Response

\MailChimp\Models\Lists\MergeField

delete

delete() : mixed

Delete a specific merge field in a list.

Response

mixed

edit

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

Update a specific merge field in a list.

Response

\MailChimp\Models\Lists\MergeField

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\MergeField

Get information about a specific merge field in a list.

Response

\MailChimp\Models\Lists\MergeField

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)

merge_id

merge_id : integer

An unchanging id for the merge field.

Type(s)

integer

tag

tag : string

The tag used in Mailchimp campaigns and for the /members endpoint.

Type(s)

string

name

name : string

The name of the merge field.

Type(s)

string

type

type : string

The type for the merge field.

Type(s)

string

required

required : boolean

The boolean value if the merge field is required.

Type(s)

boolean

default_value

default_value : string

The default value for the merge field if null.

Type(s)

string

public

public : boolean

Whether the merge field is displayed on the signup form.

Type(s)

boolean

display_order

display_order : integer

The order that the merge field displays on the list signup form.

Type(s)

integer

options

options : \MailChimp\Data\MergeFieldOptions

Extra options for some merge field types.

Type(s)

\MailChimp\Data\MergeFieldOptions

help_text

help_text : string

Extra text to help the subscriber fill out the form.

Type(s)

string

list_id

list_id : string

A string that identifies this merge field collections’ list.

Type(s)

string

_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>