Skip to main content

Mailchimp Connector

Mailchimp Interact with email campaign lists and e-commerce resources.

Connections

Mailchimp API Key

Authenticate requests to Mailchimp using an API Key

InputCommentsDefault
API KeyProvide a string value for the API Key.
Debug RequestWhen enabled, the component will log the request and response to the console.false

Mailchimp OAuth 2.0 Connection

Authenticate requests to Mailchimp using OAuth 2.0

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
Client ID
Client secret
Debug RequestWhen enabled, the component will log the request and response to the console.false

Actions

Add Customer

Add a new customer to a store

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Customer IdProvide a string value that represents the customer Id.
EmailProvide a string value that represents the email address.
Opt In StatusThe 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.false
CompanyProvide a string value that represents the company.
First NameProvide a string value that represents a first name.
Last NameProvide a string value that represents a last name.
Address 1Provide a string value that represents the 1st address field.
Address 2Provide a string value that represents the 2nd address field.
CityProvide a string value that represents the city.
Country CodeProvide a string value that represents the country code
Province CodeProvide a string value that represents the province code.
Postal CodeProvide a string value that represents the postal code.
ProvinceProvide a string value that represents the province.
CountryProvide a string value that represents the country
Connection

Add List

Create a new list in your Mailchimp account

InputCommentsDefault
CompanyProvide a string value that represents the company.
Address 1Provide a string value that represents the 1st address field.
Address 2Provide a string value that represents the 2nd address field.
CityProvide a string value that represents the city.
StateProvide a string value that represents the state.
Postal CodeProvide a string value that represents the postal code.
PhoneProvide a string value that represents phone number
CountryProvide a string value that represents the country
NameProvide a string value that represents the name of the list.
From EmailThe 'from' name on the campaign (not an email address).
From NameThe default 'from name' for campaigns sent to this list.
SubjectProvide a string value that represents the subject of the email.
LanguageThe default language for this lists's forms.
Marketing PermissionsWhether or not the list has marketing permissions (eg. GDPR) enabled.false
Email Type OptionWhether 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.false
Permission reminderProvide a string value that represents the permission reminder.
Connection

Add Member

Add a new member to a list

InputCommentsDefault
List IdProvide a string value for the Id of the list.
EmailProvide a string value that represents the email address.
LanguageThe default language for this lists's forms.
StatusSubscriber's current status. Possible values: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional".
Email TypeType of email this member asked to get ('html' or 'text').
Merge FieldA merge field (audience fields) where the key is the merge tag. For example, {"FNAME":"Freddie"}
TagsThe tags that are associated with a member.
InterestThe key of this object's properties is the Id of the interest in question.
VIPProvide a boolean to determine VIP status.false
Connection

Archive Member

Archive a list member

InputCommentsDefault
List IdProvide a string value for the Id of the list.
SubscriberHashThe MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.
Connection

Delete Cart

Delete a specific cart

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Cart IdProvide a string value that represents the cart Id.
Connection

Delete Cart Line Items

Get information about a cart's line items.

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Cart IdProvide a string value that represents the cart Id.
Line IdProvide a string value that represents the line Id.
Connection

Delete Customer

Delete a customer from a store

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Customer IdProvide a string value that represents the customer Id.
Connection

Delete List

Delete a list from your Mailchimp account

InputCommentsDefault
List IdProvide a string value for the Id of the list.
Connection

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

InputCommentsDefault
List IdProvide a string value for the Id of the list.
SubscriberHashThe MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.
Connection

Delete Order

Delete an order

InputCommentsDefault
Order IdProvide a string value that represents the order id.
Store IdProvide a string value that represents the store Id.
Connection

Delete Order Line Item

Delete an order Line Item

InputCommentsDefault
Order IdProvide a string value that represents the order id.
Store IdProvide a string value that represents the store Id.
Line IdProvide a string value that represents the line Id.
Connection

Delete Product

Delete a product from a store

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Product IdProvide a string value that represents the product Id.
Connection

Get Cart

Get information about a specific cart

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Cart IdProvide a string value that represents the cart Id.
Connection

Get Cart Line Item

Get information about a cart's specific line item

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Cart IdProvide a string value that represents the cart Id.
Line IdProvide a string value that represents the line Id.
Connection

Get Customer

Get information about a store's specific customer

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Customer IdProvide a string value that represents the customer Id.
Connection

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.

InputCommentsDefault
List IdProvide a string value for the Id of the list.
Connection

Get Lists Info

Get information about all lists in the account

InputCommentsDefault
OffsetProvide an integer value for the page offset for the given object's results.
Result CountProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Connection

Get Member

Get information about a specific list member, including a currently subscribed, unsubscribed, or bounced member

InputCommentsDefault
List IdProvide a string value for the Id of the list.
SubscriberHashThe MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.
Connection

Get Order

Get information about a specific order

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Order IdProvide a string value that represents the order id.
Connection

Get Order Line Item

Get an order Line Item

InputCommentsDefault
Order IdProvide a string value that represents the order id.
Store IdProvide a string value that represents the store Id.
Line IdProvide a string value that represents the line Id.
Connection

Get Product

Get information about a specific product

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Product IdProvide a string value that represents the product Id.
Connection

Get Store

Get information about a specific store

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Connection

List Account Orders

Get information about an account's orders

InputCommentsDefault
Connection
Result CountProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
OffsetProvide an integer value for the page offset for the given object's results.

List Campaigns

Get all campaigns in an account

InputCommentsDefault
Result CountProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
OffsetProvide an integer value for the page offset for the given object's results.
Connection

List Cart Line Items

Get information about a cart's line items.

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Cart IdProvide a string value that represents the cart Id.
Result CountProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
OffsetProvide an integer value for the page offset for the given object's results.
Connection

List Carts

Get information about a store's carts

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
OffsetProvide an integer value for the page offset for the given object's results.
Result CountProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
Connection

List Customers

Get information about a store's customers

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Result CountProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
OffsetProvide an integer value for the page offset for the given object's results.
Connection

List Members

Get information about members in a specific Mailchimp list

InputCommentsDefault
List IdProvide a string value for the Id of the list.
Result CountProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
OffsetProvide an integer value for the page offset for the given object's results.
Connection

List Order Line Items

List Order Line items

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Order IdProvide a string value that represents the order id.
Result CountProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
OffsetProvide an integer value for the page offset for the given object's results.
Connection

List Orders

List all the orders in a store

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Result CountProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
OffsetProvide an integer value for the page offset for the given object's results.
Connection

List Products

List all products from a store

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Result CountProvide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000.
OffsetProvide an integer value for the page offset for the given object's results.
Connection

List Stores

Get information about all stores in the account

InputCommentsDefault
Connection

Ping

Send a ping to determine the status of the Mailchimp servers

InputCommentsDefault
Connection

Raw Request

Send raw HTTP request to Mailchimp

InputCommentsDefault
Connection
URLInput 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.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA 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.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Debug RequestEnabling this flag will log out the current request.false
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Send Campaign

Send a Mailchimp campaign. For RSS Campaigns, the campaign will send according to its schedule. All other campaigns will send immediately.

InputCommentsDefault
Campaign IdProvide a string value that represents the campaign Id.
Connection

Update Customer

Update a specific customer's information

InputCommentsDefault
Store IdProvide a string value that represents the store Id.
Customer IdProvide a string value that represents the customer Id.
Opt In StatusThe 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.false
CompanyProvide a string value that represents the company.
First NameProvide a string value that represents a first name.
Last NameProvide a string value that represents a last name.
Address 1Provide a string value that represents the 1st address field.
Address 2Provide a string value that represents the 2nd address field.
CityProvide a string value that represents the city.
ProvinceProvide a string value that represents the province.
Province CodeProvide a string value that represents the province code.
Postal CodeProvide a string value that represents the postal code.
CountryProvide a string value that represents the country
Country CodeProvide a string value that represents the country code
Connection

Update List

Update the information or metadata of a list

InputCommentsDefault
List IdProvide a string value for the Id of the list.
CompanyProvide a string value that represents the company.
Address 1Provide a string value that represents the 1st address field.
Address 2Provide a string value that represents the 2nd address field.
CityProvide a string value that represents the city.
StateProvide a string value that represents the state.
Postal CodeProvide a string value that represents the postal code.
PhoneProvide a string value that represents phone number
CountryProvide a string value that represents the country
NameProvide a string value that represents the name of the list.
From EmailThe 'from' name on the campaign (not an email address).
From NameThe default 'from name' for campaigns sent to this list.
SubjectProvide a string value that represents the subject of the email.
LanguageThe default language for this lists's forms.
Marketing PermissionsWhether or not the list has marketing permissions (eg. GDPR) enabled.false
Email Type OptionWhether 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.false
Permission reminderProvide a string value that represents the permission reminder.
Connection

Update Member

Update a specific member in a given list

InputCommentsDefault
Skip Merge FieldsIf 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.false
List IdProvide a string value for the Id of the list.
SubscriberHashThe MD5 hash of the lowercase version of the list member's email address. This endpoint also accepts email addresses.
EmailProvide a string value that represents the email address.
LanguageThe default language for this lists's forms.
StatusSubscriber's current status. Possible values: "subscribed", "unsubscribed", "cleaned", "pending", or "transactional".
Email TypeType of email this member asked to get ('html' or 'text').
Merge FieldA merge field (audience fields) where the key is the merge tag. For example, {"FNAME":"Freddie"}
InterestThe key of this object's properties is the Id of the interest in question.
VIPProvide a boolean to determine VIP status.false
Marketing PermissionsThe marketing permissions for the subscriber.
[
{
"marketing_permission_id": "exampleId",
"enabled": true
}
]
Connection