function MCAPI::listMergeVars in Mailchimp 6.2

Same name and namespace in other branches

1. 5.2 MCAPI.class.php \MCAPI::listMergeVars()
2. 5 MCAPI.class.php \MCAPI::listMergeVars()
3. 6 MCAPI.class.php \MCAPI::listMergeVars()
4. 7 MCAPI.class.php \MCAPI::listMergeVars()

Get the list of merge tags for a given list, including their name, tag, and required setting

Related

@example xml-rpc_listMergeVars.php

@returnf string name Name of the merge field @returnf bool req Denotes whether the field is required (true) or not (false) @returnf string field_type The "data type" of this merge var. One of: email, text, number, radio, dropdown, date, address, phone, url, imageurl @returnf bool public Whether or not this field is visible to list subscribers @returnf bool show Whether the list owner has this field displayed on their list dashboard @returnf string order The order the list owner has set this field to display in @returnf string default The default value the list owner has set for this field @returnf string size The width of the field to be used @returnf string tag The merge tag that's used for forms and listSubscribe() and listUpdateMember() @returnf array choices For radio and dropdown field types, an array of the options available

Parameters

string $id the list id to connect to. Get by calling lists():

Return value

array list of merge tags for the list

File

./MCAPI.class.php, line 1036

Class

MCAPI

Code

function listMergeVars($id) {
  $params = array();
  $params["id"] = $id;
  return $this
    ->callServer("listMergeVars", $params);
}