Update merge field

PATCH

https://api.mailchimp.com/3.0/lists/:list_id/merge-fields/:merge_id

PATCH

/3.0/lists/:list_id/merge-fields/:merge_id

curl -X PATCH https://api.mailchimp.com/3.0/lists/list_id/merge-fields/merge_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Updated

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "default_value": "string",
  "display_order": 1,
  "help_text": "string",
  "list_id": "string",
  "merge_field_limit": 30,
  "merge_id": 1,
  "name": "string",
  "options": {
    "choices": [
      "First Choice",
      "Second Choice",
      "Third Choice"
    ],
    "date_format": "string",
    "default_country": 1,
    "phone_format": "string",
    "size": 1
  },
  "public": true,
  "required": true,
  "tag": "string",
  "total_items": 28,
  "type": "text"
}

Update a specific merge field.

Authentication

AuthorizationBearer

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

AuthorizationBearer

Authorization using OAuth

Path parameters

list_idstringRequired

The unique ID for the list.

merge_idstringRequired

The id for the merge field.

Request

A merge field for an audience.

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.

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

Whether the merge field is required to import a contact.

tagstringOptional

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

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

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

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.