update_merge_field
Update a merge field's name, default value, required flag, or dropdown choices. Only provided fields are modified; existing choices are replaced entirely.
Instructions
Update a merge field's name, default value, required flag, or dropdown/radio choices.
Only provided fields are updated; omitted fields remain unchanged. Choices are replaced entirely (old choices are lost). Do not use to change field type or tag (immutable after creation); use delete_merge_field then create_merge_field instead.
Authenticated via API key. Max 10 concurrent requests. Respects read-only and dry-run modes. Returns 404 error if merge_id is invalid or does not exist.
Args: list_id: Audience/list ID (10-char alphanumeric, e.g. 'abc123def4'). Obtain from list_audiences. merge_id: Merge field ID (numeric string, e.g. '5'). Obtain from list_merge_fields. name: New display name for the field. required: Whether the field is required when subscribing. default_value: New default value for new subscribers. choices: Comma-separated choices for dropdown/radio types (e.g. 'Small,Medium,Large'). Replaces all existing choices. Ignored for other field types.
Returns: JSON with merge_id, tag, name, type, required.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| list_id | Yes | ||
| merge_id | Yes | ||
| name | No | ||
| required | No | ||
| default_value | No | ||
| choices | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |