Mailchimp Component
Interact with email campaign lists and e-commerce resources.
Component key: mailchimp
Description
Mailchimp is a marketing automation platform and email marketing service. The Mailchimp component allows you to interact with your mailchimp email campaigns and your e-commerce site.
You can configure a Mailchimp webhook to send information to a Prismatic webhook URL under certain conditions ("Profile Updates", "Subscribes", "Campaign Sending", etc.).
For more information on configuring webhooks refer to the Mailchimp Docs
Connections
Mailchimp API Key
This component can be configured to use an API Key to authenticate the request. An API key can be obtained by following Mailchimp's quickstart guide
| Input | Default | Notes |
|---|---|---|
API Key string / Required apiKey | Provide a string value for the API Key. | |
Debug Request boolean debugRequest | When enabled, the component will log the request and response to the console. |
Mailchimp OAuth 2.0 Connection
| Input | Default | Notes | Example |
|---|---|---|---|
Authorize URL string / Required Hidden Field authorizeUrl | https://login.mailchimp.com/oauth2/authorize | The OAuth 2.0 Authorization URL for Mailchimp | |
Client ID string / Required clientId | 000000000000 | ||
Client secret password / Required clientSecret | 0123456789abcdef0123456789abcdef0123456789abcdef01 | ||
Debug Request boolean debugRequest | When enabled, the component will log the request and response to the console. | ||
Scopes string Hidden Field scopes | Mailchimp does not support granular scopes. | ||
Token URL string / Required Hidden Field tokenUrl | https://login.mailchimp.com/oauth2/token | The OAuth 2.0 Token URL for Mailchimp |
Actions
Add Customer
Add a new customer to a store | key: addCustomer
| Input | Default | Notes | Example |
|---|---|---|---|
Address 1 string address1 | Provide a string value that represents the 1st address field. | 4 Privet Drive | |
Address 2 string address2 | Provide a string value that represents the 2nd address field. | apt 4 | |
City string city | Provide a string value that represents the city. | Palo Alto | |
Company string company | Provide a string value that represents the company. | Example Company inc. | |
Connection connection / Required connection | |||
Country string country | Provide a string value that represents the country | United States | |
Country Code string countryCode | Provide a string value that represents the country code | USA | |
Customer Id string / Required customerId | Provide a string value that represents the customer Id. | 53ce5example278 | |
Email string / Required email | Provide a string value that represents the email address. | someone@example.com | |
First Name string firstName | Provide a string value that represents a first name. | John | |
Last Name string lastName | Provide a string value that represents a last name. | Doe | |
Opt In Status boolean / Required optInStatus | The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as Transactional members. | true | |
Postal Code string postalCode | Provide a string value that represents the postal code. | 90210 | |
Province string province | Provide a string value that represents the province. | British Colombia | |
Province Code string provinceCode | Provide a string value that represents the province code. | BC | |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
Add List
Create a new list in your Mailchimp account | key: addList
| Input | Default | Notes | Example |
|---|---|---|---|
Address 1 string / Required address1 | Provide a string value that represents the 1st address field. | 4 Privet Drive | |
Address 2 string address2 | Provide a string value that represents the 2nd address field. | apt 4 | |
City string / Required city | Provide a string value that represents the city. | Palo Alto | |
Company string company | Provide a string value that represents the company. | Example Company inc. | |
Connection connection / Required connection | |||
Country string / Required country | Provide a string value that represents the country | United States | |
Email Type Option boolean / Required emailTypeOption | false | Whether the list supports multiple formats for emails. When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. When set to false, subscribers will receive HTML emails, with a plain-text alternative backup. | |
From Email string / Required fromEmail | The 'from' name on the campaign (not an email address). | John.Doe@gmail.com | |
From Name string / Required fromName | The default 'from name' for campaigns sent to this list. | John Doe | |
Language string / Required language | The default language for this lists's forms. | English | |
Marketing Permissions boolean marketingPermissions | Whether or not the list has marketing permissions (eg. GDPR) enabled. | ||
Name string / Required name | Provide a string value that represents the name of the list. | Example Name | |
Permission reminder string / Required permissionReminder | Provide a string value that represents the permission reminder. | This is an example reminder! | |
Phone string phone | Provide a string value that represents phone number | 5556879055 | |
Postal Code string postalCode | Provide a string value that represents the postal code. | 90210 | |
State string state | Provide a string value that represents the state. | CA | |
Subject string / Required subject | Provide a string value that represents the subject of the email. | This is an example subject |
Add Member
Add a new member to a list | key: addMember
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Email string / Required email | Provide a string value that represents the email address. | someone@example.com | |
Email Type string emailType | Type of email this member asked to get ('html' or 'text'). | html | |
Interest string Key Value List interests | The key of this object's properties is the Id of the interest in question. | ||
Language string language | The default language for this lists's forms. | English | |
List Id string / Required listId | Provide a string value for the Id of the list. | 53ce5example278 | |
Merge Field string Key Value List mergeFields | A merge field (audience fields) where the key is the merge tag. For example, {"FNAME":"Freddie"} | ||
Status string / Required status | Subscriber's current status. Possible values: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional". | subscribed | |
Tags string Value List tags | The tags that are associated with a member. | ||
VIP boolean vip | Provide a boolean to determine VIP status. |
Archive Member
Archive a list member | key: archiveMember
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
List Id string / Required listId | Provide a string value for the Id of the list. | 53ce5example278 |
SubscriberHash string / Required subscriberHash | The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses. | example23370f6fe20d1b66b686e1dfb8bac5ba |
Delete Cart
Delete a specific cart | key: deleteCart
| Input | Notes | Example |
|---|---|---|
Cart Id string / Required cartId | Provide a string value that represents the cart Id. | 53ce5example278 |
Connection connection / Required connection | ||
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
Delete Cart Line Items
Get information about a cart's line items. | key: deleteCartLineItem
| Input | Notes | Example |
|---|---|---|
Cart Id string / Required cartId | Provide a string value that represents the cart Id. | 53ce5example278 |
Connection connection / Required connection | ||
Line Id string / Required lineId | Provide a string value that represents the line Id. | 53ce5example278 |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
Delete Customer
Delete a customer from a store | key: deleteCustomer
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Customer Id string / Required customerId | Provide a string value that represents the customer Id. | 53ce5example278 |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
Delete List
Delete a list from your Mailchimp account | key: deleteList
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
List Id string / Required listId | Provide a string value for the Id of the list. | 53ce5example278 |
Delete Member
Delete all personally identifiable information related to a list member, and remove them from a list. This will make it impossible to re-import the list member | key: deleteMember
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
List Id string / Required listId | Provide a string value for the Id of the list. | 53ce5example278 |
SubscriberHash string / Required subscriberHash | The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses. | example23370f6fe20d1b66b686e1dfb8bac5ba |
Delete Order
Delete an order | key: deleteOrder
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Order Id string / Required orderId | Provide a string value that represents the order id. | Provide a string value for the id of the order in the store. |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
Delete Order Line Item
Delete an order Line Item | key: deleteOrderLineItem
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Line Id string / Required lineId | Provide a string value that represents the line Id. | 53ce5example278 |
Order Id string / Required orderId | Provide a string value that represents the order id. | Provide a string value for the id of the order in the store. |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
Delete Product
Delete a product from a store | key: deleteProduct
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Product Id string / Required productId | Provide a string value that represents the product Id. | 53ce5example278 |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
Get Cart
Get information about a specific cart | key: getCart
| Input | Notes | Example |
|---|---|---|
Cart Id string / Required cartId | Provide a string value that represents the cart Id. | 53ce5example278 |
Connection connection / Required connection | ||
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
Get Cart Line Item
Get information about a cart's specific line item | key: getCartLineItem
| Input | Notes | Example |
|---|---|---|
Cart Id string / Required cartId | Provide a string value that represents the cart Id. | 53ce5example278 |
Connection connection / Required connection | ||
Line Id string / Required lineId | Provide a string value that represents the line Id. | 53ce5example278 |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
Get Customer
Get information about a store's specific customer | key: getCustomerInfo
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Customer Id string / Required customerId | Provide a string value that represents the customer Id. | 53ce5example278 |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
Get List
Get information about a specific list in your Mailchimp account. Results include list members who have signed up but haven't confirmed their subscription yet and unsubscribed or cleaned. | key: getList
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
List Id string / Required listId | Provide a string value for the Id of the list. | 53ce5example278 |
Get Lists Info
Get information about all lists in the account | key: getListsInfo
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Result Count string count | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | 20 |
Offset string offset | Provide an integer value for the page offset for the given object's results. | 3 |
Get Member
Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member | key: getMember
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
List Id string / Required listId | Provide a string value for the Id of the list. | 53ce5example278 |
SubscriberHash string / Required subscriberHash | The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses. | example23370f6fe20d1b66b686e1dfb8bac5ba |
Get Order
Get information about a specific order | key: getOrderInfo
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Order Id string / Required orderId | Provide a string value that represents the order id. | Provide a string value for the id of the order in the store. |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
Get Order Line Item
Get an order Line Item | key: getOrderLineItem
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Line Id string / Required lineId | Provide a string value that represents the line Id. | 53ce5example278 |
Order Id string / Required orderId | Provide a string value that represents the order id. | Provide a string value for the id of the order in the store. |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
Get Product
Get information about a specific product | key: getProductInfo
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Product Id string / Required productId | Provide a string value that represents the product Id. | 53ce5example278 |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
Get Store
Get information about a specific store | key: getStore
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
List Account Orders
Get information about an account's orders | key: listAccountOrders
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Result Count string count | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | 20 |
Offset string offset | Provide an integer value for the page offset for the given object's results. | 3 |
List Campaigns
Get all campaigns in an account | key: listCampaigns
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Result Count string count | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | 20 |
Offset string offset | Provide an integer value for the page offset for the given object's results. | 3 |
List Cart Line Items
Get information about a cart's line items. | key: listCartLineItem
| Input | Notes | Example |
|---|---|---|
Cart Id string / Required cartId | Provide a string value that represents the cart Id. | 53ce5example278 |
Connection connection / Required connection | ||
Result Count string count | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | 20 |
Offset string offset | Provide an integer value for the page offset for the given object's results. | 3 |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
List Carts
Get information about a store's carts | key: listCarts
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Result Count string count | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | 20 |
Offset string offset | Provide an integer value for the page offset for the given object's results. | 3 |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
List Customers
Get information about a store's customers | key: listCustomers
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Result Count string count | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | 20 |
Offset string offset | Provide an integer value for the page offset for the given object's results. | 3 |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
List Members
Get information about members in a specific Mailchimp list | key: listMembers
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Result Count string count | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | 20 |
List Id string / Required listId | Provide a string value for the Id of the list. | 53ce5example278 |
Offset string offset | Provide an integer value for the page offset for the given object's results. | 3 |
Example Payload for List Members
Example Payload for List Members
{
"data": {}
}
List Order Line Items
List Order Line items | key: listOrderLineItems
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Result Count string count | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | 20 |
Offset string offset | Provide an integer value for the page offset for the given object's results. | 3 |
Order Id string / Required orderId | Provide a string value that represents the order id. | Provide a string value for the id of the order in the store. |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
List Orders
List all the orders in a store | key: listOrders
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Result Count string count | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | 20 |
Offset string offset | Provide an integer value for the page offset for the given object's results. | 3 |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
List Products
List all products from a store | key: listProducts
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Result Count string count | Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | 20 |
Offset string offset | Provide an integer value for the page offset for the given object's results. | 3 |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
List Stores
Get information about all stores in the account | key: listStores
| Input | Notes |
|---|---|
Connection connection / Required connection |
Ping
Send a ping to determine the status of the Mailchimp servers | key: ping
| Input | Notes |
|---|---|
Connection connection / Required connection |
Raw Request
Send raw HTTP request to Mailchimp | key: rawRequest
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Data string data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | ||
Response Type string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | If true, retries on all erroneous responses regardless of type. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. | |
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
URL string / Required url | Input the path only (/reporting/facebook-ads), The base URL is already included (https://${dc}.api.mailchimp.com/3.0). For example, to connect to https://${dc}.api.mailchimp.com/3.0/reporting/facebook-ads, only /reporting/facebook-ads is entered in this field. | /reporting/facebook-ads | |
Use Exponential Backoff boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. |
Send Campaign
Send a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately. | key: sendCampaign
| Input | Notes | Example |
|---|---|---|
Campaign Id string / Required campaignId | Provide a string value that represents the campaign Id. | 53ce5example278 |
Connection connection / Required connection |
Update Customer
Update a specific customer's information | key: updateCustomer
| Input | Default | Notes | Example |
|---|---|---|---|
Address 1 string address1 | Provide a string value that represents the 1st address field. | 4 Privet Drive | |
Address 2 string address2 | Provide a string value that represents the 2nd address field. | apt 4 | |
City string city | Provide a string value that represents the city. | Palo Alto | |
Company string company | Provide a string value that represents the company. | Example Company inc. | |
Connection connection / Required connection | |||
Country string country | Provide a string value that represents the country | United States | |
Country Code string countryCode | Provide a string value that represents the country code | USA | |
Customer Id string / Required customerId | Provide a string value that represents the customer Id. | 53ce5example278 | |
First Name string firstName | Provide a string value that represents a first name. | John | |
Last Name string lastName | Provide a string value that represents a last name. | Doe | |
Opt In Status boolean / Required optInStatus | The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list will be added as Transactional members. | true | |
Postal Code string postalCode | Provide a string value that represents the postal code. | 90210 | |
Province string province | Provide a string value that represents the province. | British Colombia | |
Province Code string provinceCode | Provide a string value that represents the province code. | BC | |
Store Id string / Required storeId | Provide a string value that represents the store Id. | 53ce5example278 |
Update List
Update the information or metadata of a list | key: updateList
| Input | Default | Notes | Example |
|---|---|---|---|
Address 1 string / Required address1 | Provide a string value that represents the 1st address field. | 4 Privet Drive | |
Address 2 string address2 | Provide a string value that represents the 2nd address field. | apt 4 | |
City string / Required city | Provide a string value that represents the city. | Palo Alto | |
Company string company | Provide a string value that represents the company. | Example Company inc. | |
Connection connection / Required connection | |||
Country string / Required country | Provide a string value that represents the country | United States | |
Email Type Option boolean / Required emailTypeOption | false | Whether the list supports multiple formats for emails. When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. When set to false, subscribers will receive HTML emails, with a plain-text alternative backup. | |
From Email string / Required fromEmail | The 'from' name on the campaign (not an email address). | John.Doe@gmail.com | |
From Name string / Required fromName | The default 'from name' for campaigns sent to this list. | John Doe | |
Language string / Required language | The default language for this lists's forms. | English | |
List Id string / Required listId | Provide a string value for the Id of the list. | 53ce5example278 | |
Marketing Permissions boolean marketingPermissions | Whether or not the list has marketing permissions (eg. GDPR) enabled. | ||
Name string / Required name | Provide a string value that represents the name of the list. | Example Name | |
Permission reminder string / Required permissionReminder | Provide a string value that represents the permission reminder. | This is an example reminder! | |
Phone string phone | Provide a string value that represents phone number | 5556879055 | |
Postal Code string postalCode | Provide a string value that represents the postal code. | 90210 | |
State string state | Provide a string value that represents the state. | CA | |
Subject string / Required subject | Provide a string value that represents the subject of the email. | This is an example subject |
Update Member
Update a specific member in a given list | key: updateMember
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Email string email | Provide a string value that represents the email address. | someone@example.com | |
Email Type string emailType | Type of email this member asked to get ('html' or 'text'). | html | |
Interest string Key Value List interests | The key of this object's properties is the Id of the interest in question. | ||
Language string language | The default language for this lists's forms. | English | |
List Id string / Required listId | Provide a string value for the Id of the list. | 53ce5example278 | |
Marketing Permissions code marketingPermissionsArray | The marketing permissions for the subscriber. | ||
Merge Field string Key Value List mergeFields | A merge field (audience fields) where the key is the merge tag. For example, {"FNAME":"Freddie"} | ||
Skip Merge Fields boolean skipMerged | If Skip Merge Fields is true, member data will be accepted without merge field values, even if the merge field is usually required. This defaults to false. | ||
Status string status | Subscriber's current status. Possible values: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional". | subscribed | |
SubscriberHash string / Required subscriberHash | The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses. | example23370f6fe20d1b66b686e1dfb8bac5ba | |
VIP boolean vip | Provide a boolean to determine VIP status. |