MAmailchimp
lists

Add or update list member

Add or update a list member.

put/3.0/lists/{list_id}/members/{subscriber_hash}

Request

Path parameters

list_idstring required

The unique ID for the list.

subscriber_hashstring required

The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts a list member's email address or contact_id.

Query parameters

skip_merge_validationboolean

If skip_merge_validation is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false.

Request body

email_addressstring required

Email address for a subscriber. This value is required only if the email address is not already present on the list.

email_typestring

Type of email this member asked to get ('html' or 'text').

interestsobject

The key of this object's properties is the ID of the interest in question.

ip_optstring

The IP address the subscriber used to confirm their opt-in status.

ip_signupstring

IP address the subscriber signed up from.

languagestring

If set/detected, the subscriber's language.

merge_fieldsobject

A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.

status'subscribed' | 'unsubscribed' | 'cleaned' | 'pending' | 'transactional'

Subscriber's current status.

status_if_new'subscribed' | 'unsubscribed' | 'cleaned' | 'pending' | 'transactional'

Subscriber's status. This value is required only if the email address is not already present on the list.

tagsstring[]

The tags that are associated with a member.

vipboolean

VIP status for subscriber.

Response

consents_to_one_to_one_messagingboolean

Indicates whether a contact consents to 1:1 messaging.

contact_idstring

As Mailchimp evolves beyond email, you may eventually have contacts without email addresses. While the id is the MD5 hash of their email address, this contact_id is agnostic of contact’s inclusion of an email address.

email_addressstring

Email address for a subscriber.

email_clientstring

The list member's email client.

email_typeunknown
idstring

The MD5 hash of the lowercase version of the list member's email address.

interestsobject

The key of this object's properties is the ID of the interest in question.

ip_optstring

The IP address the subscriber used to confirm their opt-in status.

ip_signupstring

IP address the subscriber signed up from.

languagestring

If set/detected, the subscriber's language.

last_changedstring date-time

The date and time the member's info was last changed in ISO 8601 format.

list_idstring

The list id.

member_ratinginteger

Star rating for this member, between 1 and 5.

merge_fieldsobject nullable

A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.

sms_phone_numberstring

A US phone number for SMS contact.

sms_subscription_last_updatedstring

The datetime when the SMS subscription was last updated

sms_subscription_status'subscribed' | 'unsubscribed' | 'nonsubscribed' | 'pending'

The status of an SMS subscription.

sourcestring

The source from which the subscriber was added to this list.

status'subscribed' | 'unsubscribed' | 'cleaned' | 'pending' | 'transactional' | 'archived'

Subscriber's current status.

tags_countinteger

The number of tags applied to this member.

timestamp_optstring date-time

The date and time the subscriber confirmed their opt-in status in ISO 8601 format.

timestamp_signupstring date-time

The date and time the subscriber signed up for the list in ISO 8601 format.

unique_email_idstring

An identifier for the address across all of Mailchimp.

unsubscribe_reasonstring

A subscriber's reason for unsubscribing.

vipboolean

VIP status for subscriber.

web_idinteger

The ID used in the Mailchimp web application. View this member in your Mailchimp account at https://{dc}.admin.mailchimp.com/lists/members/view?id={web_id}.

Example response

{
  "stats": {
    "ecommerce_data": {
      "currency_code": "USD"
    }
  }
}

Changes

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