MAmailchimp
lists

List merge fields

Get a list of all merge fields for an audience.

get/3.0/lists/{list_id}/merge-fields

Request

Path parameters

list_idstring required

The unique ID for the list.

Query parameters

fieldsstring[]

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldsstring[]

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

countinteger

The number of records to return. Default value is 10. Maximum value is 1000

offsetinteger

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

typestring

The merge field type.

requiredboolean

Whether it's a required merge field.

Response

list_idstring

The list id.

merge_field_limitinteger

The maximum number of merge fields this audience can hold. The limit is determined by the account's plan. Subtract total_items from this value to derive the remaining capacity.

total_itemsinteger

The total number of items matching the query regardless of pagination.

Example response

{
  "merge_field_limit": 30,
  "merge_fields": [
    {
      "merge_field_limit": 30,
      "options": {
        "choices": [
          "First Choice",
          "Second Choice",
          "Third Choice"
        ]
      },
      "total_items": 28
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.