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.

Mailchimp 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	Notes
Input API Key string / Required	Notes Provide a string value for the API Key.

Mailchimp OAuth 2.0 Connection

Input	Default	Notes	Example
Input Authorize URL string / Required Hidden Field	Default https://login.mailchimp.com/oauth2/authorize	Notes The OAuth 2.0 Authorization URL for Mailchimp	Example
Input Client ID string / Required	Default	Notes	Example 000000000000
Input Client secret password / Required	Default	Notes	Example 0123456789abcdef0123456789abcdef0123456789abcdef01
Input Scopes string Hidden Field	Default	Notes Mailchimp does not support granular scopes.	Example
Input Token URL string / Required Hidden Field	Default https://login.mailchimp.com/oauth2/token	Notes The OAuth 2.0 Token URL for Mailchimp	Example

Actions

Add Customer

Add a new customer to a store | key: addCustomer

Input	Default	Notes	Example
Input Address 1 string	Default	Notes Provide a string value that represents the 1st address field.	Example 4 Privet Drive
Input Address 2 string	Default	Notes Provide a string value that represents the 2nd address field.	Example apt 4
Input City string	Default	Notes Provide a string value that represents the city.	Example Palo Alto
Input Company string	Default	Notes Provide a string value that represents the company.	Example Example Company inc.
Input Connection connection / Required	Default	Notes	Example
Input Country string	Default	Notes Provide a string value that represents the country	Example United States
Input Country Code string	Default	Notes Provide a string value that represents the country code	Example USA
Input Customer Id string	Default	Notes Provide a string value that represents the customer Id.	Example 53ce5example278
Input Email string / Required	Default	Notes Provide a string value that represents the email address.	Example someone@example.com
Input First Name string	Default	Notes Provide a string value that represents a first name.	Example John
Input Last Name string	Default	Notes Provide a string value that represents a last name.	Example Doe
Input Opt In Status boolean / Required	Default false	Notes 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.	Example true
Input Postal Code string	Default	Notes Provide a string value that represents the postal code.	Example 90210
Input Province string	Default	Notes Provide a string value that represents the province.	Example British Colombia
Input Province Code string	Default	Notes Provide a string value that represents the province code.	Example BC
Input Store Id string	Default	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

Add List

Create a new list in your Mailchimp account | key: addList

Input	Default	Notes	Example
Input Address 1 string	Default	Notes Provide a string value that represents the 1st address field.	Example 4 Privet Drive
Input Address 2 string	Default	Notes Provide a string value that represents the 2nd address field.	Example apt 4
Input City string	Default	Notes Provide a string value that represents the city.	Example Palo Alto
Input Company string	Default	Notes Provide a string value that represents the company.	Example Example Company inc.
Input Connection connection / Required	Default	Notes	Example
Input Country string	Default	Notes Provide a string value that represents the country	Example United States
Input Email Type Option boolean / Required	Default false	Notes 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.	Example
Input From Email string / Required	Default	Notes The 'from' name on the campaign (not an email address).	Example John.Doe@gmail.com
Input From Name string / Required	Default	Notes The default 'from name' for campaigns sent to this list.	Example John Doe
Input Language string / Required	Default	Notes The default language for this lists's forms.	Example English
Input Marketing Permissions boolean / Required	Default false	Notes Whether or not the list has marketing permissions (eg. GDPR) enabled.	Example
Input Name string / Required	Default	Notes Provide a string value that represents the name of the list.	Example Example Name
Input Permission reminder string / Required	Default	Notes Provide a string value that represents the permission reminder.	Example This is an example reminder!
Input Phone string	Default	Notes Provide a string value that represents phone number	Example 5556879055
Input Postal Code string	Default	Notes Provide a string value that represents the postal code.	Example 90210
Input State string	Default	Notes Provide a string value that represents the state.	Example CA
Input Subject string / Required	Default	Notes Provide a string value that represents the subject of the email.	Example This is an example subject

---

Add Member

Add a new member to a list | key: addMember

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Email string / Required	Default	Notes Provide a string value that represents the email address.	Example someone@example.com
Input Email Type string	Default	Notes Type of email this member asked to get ('html' or 'text').	Example html
Input enabled boolean	Default false	Notes Provide a boolean value for the enabled field.	Example
Input Interests string Key Value List	Default	Notes The key of this object's properties is the Id of the interest in question.	Example
Input Language string / Required	Default	Notes The default language for this lists's forms.	Example English
Input List Id string / Required	Default	Notes Provide a string value for the Id of the list.	Example 53ce5example278
Input Marketing Permission Id string	Default	Notes Provide a string value for the marketing permission Id	Example exampleId
Input Merge Fields string Key Value List	Default	Notes A dictionary of merge fields (audience fields) where the keys are the merge tags. For example, {"FNAME":"Freddie"}	Example
Input Status string / Required	Default	Notes Subscriber's current status. Possible values: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional".	Example subscribed
Input Tags string Value List	Default	Notes The tags that are associated with a member.	Example
Input VIP boolean	Default false	Notes Provide a boolean to determine VIP status.	Example

---

Archive Member

Archive a list member | key: archiveMember

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input List Id string / Required	Notes Provide a string value for the Id of the list.	Example 53ce5example278
Input SubscriberHash string / Required	Notes The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.	Example example23370f6fe20d1b66b686e1dfb8bac5ba

---

Delete Cart

Delete a specific cart | key: deleteCart

Input	Notes	Example
Input Cart Id string / Required	Notes Provide a string value that represents the cart Id.	Example 53ce5example278
Input Connection connection / Required	Notes	Example
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

Delete Cart Line Items

Get information about a cart's line items. | key: deleteCartLineItem

Input	Notes	Example
Input Cart Id string / Required	Notes Provide a string value that represents the cart Id.	Example 53ce5example278
Input Connection connection / Required	Notes	Example
Input Line Id string / Required	Notes Provide a string value that represents the line Id.	Example 53ce5example278
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

Delete Customer

Delete a customer from a store | key: deleteCustomer

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Customer Id string	Notes Provide a string value that represents the customer Id.	Example 53ce5example278
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

Delete List

Delete a list from your Mailchimp account | key: deleteList

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input List Id string / Required	Notes Provide a string value for the Id of the list.	Example 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
Input Connection connection / Required	Notes	Example
Input List Id string / Required	Notes Provide a string value for the Id of the list.	Example 53ce5example278
Input SubscriberHash string / Required	Notes The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.	Example example23370f6fe20d1b66b686e1dfb8bac5ba

---

Delete Order

Delete an order | key: deleteOrder

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Order Id string	Notes Provide a string value that represents the order id.	Example Provide a string value for the id of the order in the store.
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

Delete Order Line Item

Delete an order Line Item | key: deleteOrderLineItem

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Line Id string / Required	Notes Provide a string value that represents the line Id.	Example 53ce5example278
Input Order Id string	Notes Provide a string value that represents the order id.	Example Provide a string value for the id of the order in the store.
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

Delete Product

Delete a product from a store | key: deleteProduct

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Product Id string / Required	Notes Provide a string value that represents the product Id.	Example 53ce5example278
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

Get Cart

Get information about a specific cart | key: getCart

Input	Notes	Example
Input Cart Id string / Required	Notes Provide a string value that represents the cart Id.	Example 53ce5example278
Input Connection connection / Required	Notes	Example
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

Get Cart Line Item

Get information about a cart's specific line item | key: getCartLineItem

Input	Notes	Example
Input Cart Id string / Required	Notes Provide a string value that represents the cart Id.	Example 53ce5example278
Input Connection connection / Required	Notes	Example
Input Line Id string / Required	Notes Provide a string value that represents the line Id.	Example 53ce5example278
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

Get Customer

Get information about a store's specific customer | key: getCustomer

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Customer Id string	Notes Provide a string value that represents the customer Id.	Example 53ce5example278
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

Get Customer

Get information about a store's specific customer | key: getCustomerInfo

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Customer Id string	Notes Provide a string value that represents the customer Id.	Example 53ce5example278
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 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
Input Connection connection / Required	Notes	Example
Input List Id string / Required	Notes Provide a string value for the Id of the list.	Example 53ce5example278

---

Get Lists Info

Get information about all lists in the account | key: getListsInfo

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Result Count string	Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.	Example 20
Input Offset string	Notes Provide an integer value for the page offset for the given object's results.	Example 3

---

Get Member

Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member | key: getMember

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input List Id string / Required	Notes Provide a string value for the Id of the list.	Example 53ce5example278
Input SubscriberHash string / Required	Notes The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.	Example example23370f6fe20d1b66b686e1dfb8bac5ba

---

Get Order

Get information about a specific order | key: getOrderInfo

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Order Id string	Notes Provide a string value that represents the order id.	Example Provide a string value for the id of the order in the store.
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

Get Order Line Item

Get an order Line Item | key: getOrderLineItem

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Line Id string / Required	Notes Provide a string value that represents the line Id.	Example 53ce5example278
Input Order Id string	Notes Provide a string value that represents the order id.	Example Provide a string value for the id of the order in the store.
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

Get Product

Get information about a specific product | key: getProductInfo

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Product Id string / Required	Notes Provide a string value that represents the product Id.	Example 53ce5example278
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

Get Store

Get information about a specific store | key: getStore

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

List Account Orders

Get information about an account's orders | key: listAccountOrders

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Result Count string	Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.	Example 20
Input Offset string	Notes Provide an integer value for the page offset for the given object's results.	Example 3

---

List Campaigns

Get all campaigns in an account | key: listCampaigns

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Result Count string	Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.	Example 20
Input Offset string	Notes Provide an integer value for the page offset for the given object's results.	Example 3

---

List Cart Line Items

Get information about a cart's line items. | key: listCartLineItem

Input	Notes	Example
Input Cart Id string / Required	Notes Provide a string value that represents the cart Id.	Example 53ce5example278
Input Connection connection / Required	Notes	Example
Input Result Count string	Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.	Example 20
Input Offset string	Notes Provide an integer value for the page offset for the given object's results.	Example 3
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

List Carts

Get information about a store's carts | key: listCarts

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Result Count string	Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.	Example 20
Input Offset string	Notes Provide an integer value for the page offset for the given object's results.	Example 3
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

List Customers

Get information about a store's customers | key: listCustomers

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Result Count string	Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.	Example 20
Input Offset string	Notes Provide an integer value for the page offset for the given object's results.	Example 3
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

List Members

Get information about members in a specific Mailchimp list | key: listMembers

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Result Count string	Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.	Example 20
Input List Id string / Required	Notes Provide a string value for the Id of the list.	Example 53ce5example278
Input Offset string	Notes Provide an integer value for the page offset for the given object's results.	Example 3

Output Example Payload

{  "data": {}}

---

List Order Line Items

List Order Line items | key: listOrderLineItems

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Result Count string	Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.	Example 20
Input Offset string	Notes Provide an integer value for the page offset for the given object's results.	Example 3
Input Order Id string	Notes Provide a string value that represents the order id.	Example Provide a string value for the id of the order in the store.
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

List Orders

List all the orders in a store | key: listOrders

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Result Count string	Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.	Example 20
Input Offset string	Notes Provide an integer value for the page offset for the given object's results.	Example 3
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

List Products

List all products from a store | key: listProducts

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Result Count string	Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.	Example 20
Input Offset string	Notes Provide an integer value for the page offset for the given object's results.	Example 3
Input Store Id string	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

List Stores

Get information about all stores in the account | key: listStores

Input	Notes
Input Connection connection / Required	Notes

---

Ping

Send a ping to determine the status of the Mailchimp servers | key: ping

Input	Notes
Input Connection connection / Required	Notes

---

Raw Request

Send Raw Request to Mailchimp /v3 API | key: rawRequest

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Data string	Default	Notes The HTTP body payload to send to the URL.	Example {"exampleKey": "Example Data"}
Input Debug Request boolean	Default false	Notes Enabling this flag will log out the current request.	Example
Input File Data string Key Value List	Default	Notes File Data to be sent as a multipart form upload.	Example [{key: "example.txt", value: "My File Contents"}]
Input Form Data string Key Value List	Default	Notes The Form Data to be sent as a multipart form upload.	Example [{"key": "Example Key", "value": new Buffer("Hello World")}]
Input Header string Key Value List	Default	Notes A list of headers to send with the request.	Example User-Agent: curl/7.64.1
Input Max Retry Count string	Default 0	Notes The maximum number of retries to attempt.	Example
Input Method string / Required	Default	Notes The HTTP method to use.	Example
Input Query Parameter string Key Value List	Default	Notes 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.	Example
Input Response Type string / Required	Default json	Notes The type of data you expect in the response. You can request json, text, or binary data.	Example
Input Retry On All Errors boolean	Default false	Notes If true, retries on all erroneous responses regardless of type.	Example
Input Retry Delay (ms) string	Default 0	Notes The delay in milliseconds between retries.	Example
Input Timeout string	Default	Notes The maximum time that a client will await a response to its request	Example 2000
Input URL string / Required	Default	Notes This is the URL to call.	Example /reporting/facebook-ads
Input Use Exponential Backoff boolean	Default false	Notes Specifies whether to use a pre-defined exponential backoff strategy for retries.	Example

---

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
Input Campaign Id string	Notes Provide a string value that represents the campaign Id.	Example 53ce5example278
Input Connection connection / Required	Notes	Example

---

Update Customer

Update a specific customer's information | key: updateCustomer

Input	Default	Notes	Example
Input Address 1 string	Default	Notes Provide a string value that represents the 1st address field.	Example 4 Privet Drive
Input Address 2 string	Default	Notes Provide a string value that represents the 2nd address field.	Example apt 4
Input City string	Default	Notes Provide a string value that represents the city.	Example Palo Alto
Input Company string	Default	Notes Provide a string value that represents the company.	Example Example Company inc.
Input Connection connection / Required	Default	Notes	Example
Input Country string	Default	Notes Provide a string value that represents the country	Example United States
Input Country Code string	Default	Notes Provide a string value that represents the country code	Example USA
Input Customer Id string	Default	Notes Provide a string value that represents the customer Id.	Example 53ce5example278
Input First Name string	Default	Notes Provide a string value that represents a first name.	Example John
Input Last Name string	Default	Notes Provide a string value that represents a last name.	Example Doe
Input Opt In Status boolean / Required	Default false	Notes 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.	Example true
Input Postal Code string	Default	Notes Provide a string value that represents the postal code.	Example 90210
Input Province string	Default	Notes Provide a string value that represents the province.	Example British Colombia
Input Province Code string	Default	Notes Provide a string value that represents the province code.	Example BC
Input Store Id string	Default	Notes Provide a string value that represents the store Id.	Example 53ce5example278

---

Update List

Update the information or metadata of a list | key: updateList

Input	Default	Notes	Example
Input Address 1 string	Default	Notes Provide a string value that represents the 1st address field.	Example 4 Privet Drive
Input Address 2 string	Default	Notes Provide a string value that represents the 2nd address field.	Example apt 4
Input City string	Default	Notes Provide a string value that represents the city.	Example Palo Alto
Input Company string	Default	Notes Provide a string value that represents the company.	Example Example Company inc.
Input Connection connection / Required	Default	Notes	Example
Input Country string	Default	Notes Provide a string value that represents the country	Example United States
Input Email Type Option boolean / Required	Default false	Notes 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.	Example
Input From Email string / Required	Default	Notes The 'from' name on the campaign (not an email address).	Example John.Doe@gmail.com
Input From Name string / Required	Default	Notes The default 'from name' for campaigns sent to this list.	Example John Doe
Input Language string / Required	Default	Notes The default language for this lists's forms.	Example English
Input List Id string / Required	Default	Notes Provide a string value for the Id of the list.	Example 53ce5example278
Input Marketing Permissions boolean / Required	Default false	Notes Whether or not the list has marketing permissions (eg. GDPR) enabled.	Example
Input Name string / Required	Default	Notes Provide a string value that represents the name of the list.	Example Example Name
Input Permission reminder string / Required	Default	Notes Provide a string value that represents the permission reminder.	Example This is an example reminder!
Input Phone string	Default	Notes Provide a string value that represents phone number	Example 5556879055
Input Postal Code string	Default	Notes Provide a string value that represents the postal code.	Example 90210
Input State string	Default	Notes Provide a string value that represents the state.	Example CA
Input Subject string / Required	Default	Notes Provide a string value that represents the subject of the email.	Example This is an example subject

---

Update Member

Update a specific member in a given list | key: updateMember

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Email string	Default	Notes Provide a string value that represents the email address.	Example someone@example.com
Input Email Type string	Default	Notes Type of email this member asked to get ('html' or 'text').	Example html
Input enabled boolean	Default false	Notes Provide a boolean value for the enabled field.	Example
Input Interests string Key Value List	Default	Notes The key of this object's properties is the Id of the interest in question.	Example
Input Language string	Default	Notes The default language for this lists's forms.	Example English
Input List Id string / Required	Default	Notes Provide a string value for the Id of the list.	Example 53ce5example278
Input Marketing Permission Id string	Default	Notes Provide a string value for the marketing permission Id	Example exampleId
Input Merge Fields string Key Value List	Default	Notes A dictionary of merge fields (audience fields) where the keys are the merge tags. For example, {"FNAME":"Freddie"}	Example
Input Status string	Default	Notes Subscriber's current status. Possible values: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional".	Example subscribed
Input SubscriberHash string / Required	Default	Notes The MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.	Example example23370f6fe20d1b66b686e1dfb8bac5ba
Input Tags string Value List	Default	Notes The tags that are associated with a member.	Example
Input VIP boolean	Default false	Notes Provide a boolean to determine VIP status.	Example

---