Mailchimp

Mailchimp is a marketing automation and email marketing platform.

Categories: Marketing Automation

Type: mailchimp/v1

Connections

Version: 1

OAuth2 Authorization Code

Properties

Name	Label	Type	Description	Required
clientId	Client Id	STRING		true
clientSecret	Client Secret	STRING		true

Actions

Add Member to List

Name: addMemberToList

Adds a new member to the list.

Properties

Name	Label	Type	Description	Required
listId	List ID	STRING	The unique ID for the list.	true
skip_merge_validation	Skip Merge Validation	BOOLEAN Options true, false	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.	false
email_address	Email Address	STRING	Email address for a subscriber.	true
status	Status	STRING Options subscribed, unsubscribed, cleaned, pending, transactional	Subscriber’s current status.	true
email_type	Email Type	STRING Options html, text	Type of email this member asked to get (‘html’ or ‘text’).	false
merge_fields	Merge Fields	OBJECT Properties {}	A dictionary of merge fields where the keys are the merge tags.	false
interests	Interests	OBJECT Properties {}	The key of this object’s properties is the ID of the interest in question.	false
language	Language	STRING	If set/detected, the subscriber’s language.	false
vip	Vip	BOOLEAN Options true, false	VIP status for subscriber.	false
location	Location	OBJECT Properties {NUMBER(latitude), NUMBER(longitude)}	Subscriber location information.	false
marketing_permissions	Marketing Permissions	ARRAY Items [{STRING(marketing_permission_id), BOOLEAN(enabled)}]	The marketing permissions for the subscriber.	false
ip_signup	Ip Signup	STRING	IP address the subscriber signed up from.	false
timestamp_signup	Timestamp Signup	STRING	The date and time the subscriber signed up for the list in ISO 8601 format.	false
ip_opt	Ip Opt	STRING	The IP address the subscriber used to confirm their opt-in status.	false
timestamp_opt	Timestamp Opt	STRING	The date and time the subscriber confirmed their opt-in status in ISO 8601 format.	false
tags	Tags	ARRAY Items [STRING]	The tags that are associated with a member.	false

Example JSON Structure

{
  "label" : "Add Member to List",
  "name" : "addMemberToList",
  "parameters" : {
    "listId" : "",
    "skip_merge_validation" : false,
    "email_address" : "",
    "status" : "",
    "email_type" : "",
    "merge_fields" : { },
    "interests" : { },
    "language" : "",
    "vip" : false,
    "location" : {
      "latitude" : 0.0,
      "longitude" : 0.0
    },
    "marketing_permissions" : [ {
      "marketing_permission_id" : "",
      "enabled" : false
    } ],
    "ip_signup" : "",
    "timestamp_signup" : "",
    "ip_opt" : "",
    "timestamp_opt" : "",
    "tags" : [ "" ]
  },
  "type" : "mailchimp/v1/addMemberToList"
}

Output

Sample Output:

{last_note={created_by=string, note_id=0, created_at=2019-08-24T14:15:22, note=string}, email_address=string, status=subscribed, unsubscribe_reason=string, timestamp_opt=2019-08-24T14:15:22, ip_opt=string, location={longitude=0, region=string, latitude=0, dstoff=0, timezone=string, country_code=string, gmtoff=0}, ip_signup=string, tags=[{id=0, name=string}], marketing_permissions=[{text=string, marketing_permission_id=string, enabled=true}], email_type=string, language=string, interests={property1=true, property2=true}, timestamp_signup=2019-08-24T14:15:22, id=string, _links=[{method=GET, targetSchema=string, schema=string, href=string, rel=string}], web_id=0, member_rating=0, vip=true, last_changed=2019-08-24T14:15:22, source=string, consents_to_one_to_one_messaging=true, email_client=string, unique_email_id=string, tags_count=0, list_id=string, full_name=string, merge_fields={property1=, property2=}, stats={avg_click_rate=0, avg_open_rate=0, ecommerce_data={total_revenue=0, number_of_orders=0, currency_code=USD}}, contact_id=string}

Type: OBJECT

Properties

Name	Type	Description
id	STRING	The MD5 hash of the lowercase version of the list member’s email address.
email_address	STRING	Email address for a subscriber.
unique_email_id	STRING	An identifier for the address across all of Mailchimp.
contact_id	STRING	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.
full_name	STRING	The contact’s full name.
web_id	STRING	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}.
email_type	STRING	Type of email this member asked to get (‘html’ or ‘text’).
status	STRING Options subscribed, unsubscribed, cleaned, pending, transactional	Subscriber’s current status.
unsubscribe_reason	STRING	A subscriber’s reason for unsubscribing.
consents_to_one_to_one_messaging	BOOLEAN Options true, false	Indicates whether a contact consents to 1:1 messaging.
merge_fields	OBJECT Properties {}	A dictionary of merge fields where the keys are the merge tags. See the Merge Fields documentation for more about the structure.
interests	OBJECT Properties {}	The key of this object’s properties is the ID of the interest in question.
stats	OBJECT Properties {NUMBER(avg_open_rate), NUMBER(avg_click_rate), {NUMBER(total_revenue), NUMBER(number_of_orders), STRING(currency_code)}(ecommerce_data)}	Open and click rates for this subscriber.
ip_signup	STRING	IP address the subscriber signed up from.
timestamp_signup	STRING	The date and time the subscriber signed up for the list in ISO 8601 format.
ip_opt	STRING	The IP address the subscriber used to confirm their opt-in status.
timestamp_opt	STRING	The date and time the subscriber confirmed their opt-in status in ISO 8601 format.
member_rating	INTEGER	Star rating for this member, between 1 and 5.
last_changed	STRING	The date and time the member’s info was last changed in ISO 8601 format.
language	STRING	If set/detected, the subscriber’s language.
vip	BOOLEAN Options true, false	VIP status for subscriber.
email_client	STRING	The list member’s email client.
location	OBJECT Properties {NUMBER(latitude), NUMBER(longitude), INTEGER(gmtoff), INTEGER(dstoff), STRING(country_code), STRING(timezone), STRING(region)}	Subscriber location information.
marketing_permissions	ARRAY Items [{STRING(marketing_permission_id), STRING(text), BOOLEAN(enabled)}]	The marketing permissions for the subscriber.
last_note	OBJECT Properties {INTEGER(note_id), STRING(created_at), STRING(created_by), STRING(note)}	The most recent Note added about this member.
source	STRING	The source from which the subscriber was added to this list.
tags_count	INTEGER	The number of tags applied to this member.
tags	OBJECT Properties {INTEGER(id), STRING(name)}	Returns up to 50 tags applied to this member.
list_id	STRING	The list id.
_links	ARRAY Items [{STRING(rel), STRING(href), STRING(method), STRING(targetSchema), STRING(schema)}]	The list of link types and descriptions for the API schema documents.

Output Example

{
  "id" : "",
  "email_address" : "",
  "unique_email_id" : "",
  "contact_id" : "",
  "full_name" : "",
  "web_id" : "",
  "email_type" : "",
  "status" : "",
  "unsubscribe_reason" : "",
  "consents_to_one_to_one_messaging" : false,
  "merge_fields" : { },
  "interests" : { },
  "stats" : {
    "avg_open_rate" : 0.0,
    "avg_click_rate" : 0.0,
    "ecommerce_data" : {
      "total_revenue" : 0.0,
      "number_of_orders" : 0.0,
      "currency_code" : ""
    }
  },
  "ip_signup" : "",
  "timestamp_signup" : "",
  "ip_opt" : "",
  "timestamp_opt" : "",
  "member_rating" : 1,
  "last_changed" : "",
  "language" : "",
  "vip" : false,
  "email_client" : "",
  "location" : {
    "latitude" : 0.0,
    "longitude" : 0.0,
    "gmtoff" : 1,
    "dstoff" : 1,
    "country_code" : "",
    "timezone" : "",
    "region" : ""
  },
  "marketing_permissions" : [ {
    "marketing_permission_id" : "",
    "text" : "",
    "enabled" : false
  } ],
  "last_note" : {
    "note_id" : 1,
    "created_at" : "",
    "created_by" : "",
    "note" : ""
  },
  "source" : "",
  "tags_count" : 1,
  "tags" : {
    "id" : 1,
    "name" : ""
  },
  "list_id" : "",
  "_links" : [ {
    "rel" : "",
    "href" : "",
    "method" : "",
    "targetSchema" : "",
    "schema" : ""
  } ]
}

Triggers

Name: subscribe

Triggers when an Audience subscriber is added to the list.

Type: DYNAMIC_WEBHOOK

Properties

Name	Label	Type	Description	Required
listId	List Id	STRING	The list id of intended audience to which you would like to add the contact.	true

Output

Type: OBJECT

Properties

Name	Type	Description
data	OBJECT Properties {STRING(email), STRING(email_type), STRING(id), STRING(ip_opt), STRING(ip_signup), STRING(list_id), {STRING(EMAIL), STRING(FNAME), STRING(INTERESTS), STRING(LNAME)}(merges)}
fired_at	DATE_TIME
type	STRING

JSON Example

{
  "label" : "Subscribe",
  "name" : "subscribe",
  "parameters" : {
    "listId" : ""
  },
  "type" : "mailchimp/v1/subscribe"
}