MailChimp
Mailchimp is a marketing automation platform that allows you to connect with your clients, customers, and other potentials. It helps you to conduct email campaigns by providing a seamless email marketing service. Mailchimp also helps you to manage mailing lists for conducting a successful email campaign.
Authorization
Basic Auth
Mailchimp uses Basic Authentication as described in the following section from their guide. You need to generate the credentials from the Mailchimp admin and provide these credentials in your request to Mailchimp. It is a default selection of authentication forms that are most commonly used for Mailchimp.
You can either use HTTP Basic Authentication or Bearer Authentication.
HTTP Basic Authentication:
curl --request GET \
--url 'https://<dc>.api.mailchimp.com/3.0/' \
--user 'anystring:TOKENBearer Authentication:
--url 'https://<dc>.api.mailchimp.com/3.0/' \
--header "Authorization: Bearer <TOKEN>"To authenticate the Basic Auth you need to follow the below steps:
Enter any string as the username.
Supply your API Key as the as the password.
Enter the user password - You need to enter any string as user and API Key as password.
User Id - Any value.
Password - The API Key
Header Token - Authorization
Authentication Prefix - Basic
Additional Tokens - None
For more information visit Mailchimp
OAuth 2.0
OAuth 2 authentication provides developers with a secure way to access Mailchimp Marketing API data on behalf of other users. Most commonly, OAuth 2 authentication is useful to set up integrations between third-party applications and Mailchimp.
When a user creates their Mailchimp app, they must be sure to enter Sapper's OAuth callback URL -Sapper - as a Callback URL.
You might use OAuth 2 authentication to set up integrations that help you:
Sync your application data with Mailchimp so Mailchimp can send marketing and transactional email
Keep your audiences up-to-date and synced with your CRM, where you maintain a list of contacts
To get the credentials you need in order to set up your OAuth 2 workflow, you’ll first need to register your application with Mailchimp:
Navigate to the App registration page in your Mailchimp account
Click Register
Fill out the “Register An App” form and click on “Create”
In order to fill out the registration form, you’ll need to know the Redirect URI for your application.
After successfully registering your application, you’ll see the client_id and client_secret at the bottom of the page.
To begin the process, you’ll redirect your user to this URL: https://login.mailchimp.com/oauth2/authorize?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI
When the user approves your application, they’ll be sent back to your application with a query string parameter named code you can use to request your access token via a POST request to this URL: https://login.mailchimp.com/oauth2/token
Finally, to retrieve the server prefix, you’ll send a GET request to the Metadata endpoint with an Authorization header set to OAuth USERS_OAUTH_TOKEN: https://login.mailchimp.com/oauth2/metadata
For more information visit Mailchimp
Input | Description | Examples |
|---|---|---|
Client Id | This is unique for each partner, and is provided by Mailchimp | xxxx |
Client Secret | This is unique for each partner, and is provided by Mailchimp | xxxx |
MailChimp Connections
MailChimp Basic Connection
Input | Key | Description | Example |
Select Application | application | Select Mailchimp application | Mailchimp |
Connection type | connection type | Select the type of connection. | Rest |
Rest Connection Type | Rest Connection Type | Select the Basic connection type | Basic |
Connection Name | name | Provide a name for the connection. | Mailchimp |
Connection Description | description | Provide a description for the connection. | NA |
Host Name | host | Provide a string value for the URL of user's Mailchimp account. | |
Username | username | Provide a valid username for the given Mailchimp account user want to connect. | exampleUser |
Password | password | Provide a password to authenticate all requests with. Cloud users need to generate an API token for this value. | exampleSecurePassword |
Header Field | header | Provide the path of the endpoint for authentication. | Authorization |
Header Prefix | header prefix | Select the header prefix - | Basic |
MailChimp OAuth 2.0 Connection
Input | Key | Description | Example |
Select Application | application | Select Mailchimp application | Mailchimp |
Connection Type | connection type | Select the type of connection. | REST |
REST Connection Type | rest connection type | Select the type of REST connection. | OAuth2.0 |
Connection Name | name | Provide a name for the connection. | Mailchimp connection |
Connection Description | description | Provide a description for the connection. |
|
Host Name | host | Provide a string value for the URL of user's Mailchimp account. |
|
Grant Type | grant type | Provide the grant type - authorization code, password, client credentials. | authorization code, password, client credentials. |
Actions
Get Campaign
Get Campaign | key: getCampaign
Get All Subscribers
Get All Subscribers | key: getallSubscribers
Input | Key | Description | Example |
|---|---|---|---|
Status | status | This section explains about the email marketing status. | subscribed, unsubscribed, non-subscribed, cleaned, and pending |
Add member to the List
Add member to the List | key: addmembertoList
Input | Key | Description | Example |
|---|---|---|---|
Email Address | emailAddress | Provide the email address of the member. | |
Status | Status | This section explains about the email marketing status. | subscribed, unsubscribed, non-subscribed, cleaned, and pending |
Merge Field | mergeField | In the merge fields you will be able to save custom information about contacts, which can be helpful for personalizing campaigns. | Dear «FirstName». |
Location | location | It is a geolocation approximates where you can locate your contacts. It will help you to target your campaigns for specific regions or time zones. | USA |
Marketing Permissions | marketingPermissions | This section is about taking permissions from the contacts for sending emails. This is a part of the terms and conditions. |
|
Tags | tags | Tags are the labels that you create to help organize your contacts. It is a customizable field and, you are allowed to create and assign it to the required contact. | Create, Add and Remove |
List Id | listID | The audience has a unique list ID that helps to integrate plugins, and widgets that helps to connect and transfer subscriber data. It can not be customized once generated. It is a system generated ID. It is an alpha numeric combination. | e31a1510a7 |