Skip to navigation

Get merge field

Get information about a specific merge field.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

OR
AuthorizationBearer
Authorization using OAuth

Path parameters

list_idstringRequired
The unique ID for the list.
merge_idstringRequired
The id for the merge field.

Query parameters

exclude_fieldslist of stringsOptional

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

fieldslist of stringsOptional

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

Response

This endpoint returns an object.
default_valuestringOptional

The default value for the merge field if null.

display_orderintegerOptional
The order that the merge field displays on the list signup form.
help_textstringOptional
Extra text to help the subscriber fill out the form.
list_idstringOptionalRead-only
The ID that identifies this merge field's audience'.
merge_field_limitintegerOptionalRead-only

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

merge_idintegerOptionalRead-only
An unchanging id for the merge field.
namestringOptional

The name of the merge field (audience field).

optionsobjectOptional
Extra options for some merge field types.
publicbooleanOptional
Whether the merge field is displayed on the signup form.
requiredbooleanOptional
The boolean value if the merge field is required.
tagstringOptional

The merge tag used for Mailchimp campaigns and adding contact information.

total_itemsintegerOptionalRead-only
The total number of merge fields on the audience after this field was created. Returned on POST responses only.
typeenumOptionalRead-only

The type for the merge field.