---
title: Mailchimp node
slug: mailchimp-node
docTags: 
createdAt: 2021-12-03T09:34:27.000Z
---

This node will allow you to synchronize HyperPortal data with [Mailchimp](https://mailchimp.com/) contacts.

The node currently has the following settings:

### Credentials

Here you can enter your credentials for Mailchimp (For example - API key). To add new credentials click on the field, then on 'Add: Credentials'

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/eYdk2OVHlBvzDb6VCjLfh_image.png)

To edit existing credentials click on the pencil icon. 

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/PzSJAhpIBIoXrjo2qZ2OD_image.png)

All credentials are stored in CMS -> Credentials

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/ORlcOinyXq-bdtqZR6jNm_image.png)

**Please don\`t add or edit credentials in CMS, they won\`t work that way. You can only add or edit credentials in Workflow node settings.**

### Parameters

**Authentication**

There are currently two types of authentication - API Key, OAuth2.

**Resource**

Mailchimp node can currently interact with the following resources - Campaign, list group, member, and member tag. Each resource has certain operations.

### Member operations

***Delete*** - Deletes the item from Mailchimp. For example - the node will delete the contact from the 'Hyper test' email list.

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/UnIRKigosup1IfA7FnEgY_image.png)

It will delete the record that has the same email as the selected contact in the workflow process. 

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/COEXMX-QORG8rLxFY9FUh_image.png)

***Get*** - this operation will get all information about the Mailchimp item.

Example - this node will get information of the Mailchimp contact with the same email as in the selected HyperPortal contact.



![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/M35JbfhE2NsZvfmJTsbzV_image.png)

The data from Mailchimp will be shown in JSON format. To view the output of the node you need to go to the process overview.

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/-8EXt87ZIfZoIoITH9QDe_image.png)

Then double-click on the needed node.

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/CBRPz4PNAmEyNtVwlzAoc_image.png)

The output of the Mailchimp node will generally look like this - 

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/b1_HtJ8Hxl7LUI3hbSU1n_image.png)

You can reference Mailchimp\`s output data by entering the name of the field in this way - $json.field\_name where 'field\_name' is the name of the field. 

Let\`s look at the example. We have a create entity node. This node will create a contact in HyperPortal using data from the Mailchimp node.



![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/NzdzDvsTa3HISEP7TMN8w_image.png)

As you can see it refers to Mailchimp fields by their names. Let\`s look at the mapping of the 'Last name' field.

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/z17L4IqkB0ZJLkmhsBcQe_image.png)

First, we start with '$json' then we should enter the name of the section('merge\_fields') where the last name is. In the end, we should enter the name of the needed field - 'LNAME'. So to refer to the last name we should have this expression - '$json.merge\_fields.LNAME'

'Get' operation has the following options - 

- Fields - here you can specify what Mailchimp fields to return
- Exclude Fields - here you can specify what fields to ignore

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/86_q5WVnxTiN7255s7UKH_image.png)



***Get all ***- This operation can get multiple items from Mailchimp. You can set a max limit of the items 

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/eRI4kcDJtB7JCalKlwt9T_image.png)

Or you can return all items by enabling the respective option. 

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/1_TlZ_-XitqxCIo1m70pG_image.png)

'Get all' operation has the following options

- Before Last Changed - Restrict results to subscribers whose information changed before the set timeframe.
- Before Timestamp Opt - Restrict results to subscribers who opted-in before the set timeframe
- Email Type - Filters users by the type of the email they choose (HTML or text)
- Status - Restrict results to subscribers who have certain status. (Subscribed, Unsubscribed, Cleaned, Pending, Transactional)
- Since Last Changed - Restrict results to subscribers whose information changed after the set timeframe.


***Update*** - this operation will update an item in Mailchimp. Example - this node will update a  Mailchimp contact with the same email as in the selected HyperPortal contact.



![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/CXtTOIOUAHdy9iR1MQ4Bm_image.png)

In the update fields section, you can choose what fields will be updated, and what information will be used to update those fields. For example - we can update the first name of the Mailchimp contact by entering the ID of the corresponding field.  

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/sYmSzPngwGC8_zdGkyMdA_image.png)

### Campaign operations

Delete, get, and get all operations are the same as in the 'Members' resource. 

**Replicate **- creates a copy of the campaign. To choose a needed campaign you should enter its ID. 

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/tziXkxZiDyI1QBYIxkbyn_image.png)

***Resend - ***this operation will resend a campaign, it applies only to campaigns that were previously executed.

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/TOOfHivhDQjDVcZCqkaAm_image.png)

**Send - **will send a new email campaign

![](https://api.archbee.com/api/optimize/5goaGPkGyPYxtK7K75CEC/LG5s6n0AAAP3pbSIA84OR_image.png)