Creating or editing an endpoint for MailChimp

Endpoints provide the configuration information that the Studio and the Integration Appliance use to connect to MailChimp platform. MailChimp connector supports both Basic authentication and OAuth2.0 authentication mechanism so as to authorize users to perform operations.

Selecting or editing a MailChimp endpoint

  1. In the Create Endpoint or Edit Endpoint pane, configure the MailChimp endpoint as described in the following table.
    Note: Changing the configuration properties of an endpoint affects all orchestrations that use that endpoint in the project. The edits are global, not local.
  2. Click Test Connection to confirm that the connection details are valid and you are able to connect to MailChimp successfully.
  3. Click OK.
Note:
  • If radio button Log into server with Basic Authentication is clicked, User Name and API key are required.
  • If radio button Log into server with OAuth2.0 Authentication is clicked, OAuth2.0 Access Token is required.
Table 1. Connection properties
Field Name Description
API Version MailChimp API Version
User Name Authentication user name for accessing MailChimp instance.
API Key Authentication API Key for accessing MailChimp instance
OAuth 2.0 Access Token Access Token for accessing MailChimp instance.

Following parameters are required in endpoint test connection screen to make connection via Proxy:

Field Name Description
Host name Host Name of Proxy Network
Port Port Number of Proxy Network
User Name User Name for accessing service via proxy network
Password Password for accessing service via proxy network
Note: In the Map Input section of each activity, relevant fields of endpoint panel are available to override at runtime. User can provide data to various groups of parameters like Proxy Details, Connection Details to override. Authentication type used will be as per the selection made by user on endpoint panel. Only parameters needed for selected type can be overridden. Providing only partial parameter values in a selected group is not allowed. For example, if Basic authentication is selected in endpoint panel, API Key and username must be overridden, else access Token is overridden.

Objects Supported by the MailChimp Connector

Following objects are supported by the MailChimp Connector:

Table 2. CRUD Operations supported by the MailChimp objects
MailChimp Objects Create Retrieve All Retrieve Update Delete Search
Campaign Yes Yes Yes Yes Yes Yes
Feedback Yes Yes Yes Yes Yes
Campaign Content Yes Yes
Campaign Send Checklist Yes
Conversation Yes Yes Yes
Message Yes Yes Yes Yes
File Yes Yes Yes Yes Yes Yes
Folder Yes Yes Yes Yes Yes Yes
List Yes Yes Yes Yes Yes Yes
List Abuse Report Yes Yes
Template Default Content Yes
List Activity Yes
Client Yes
Growth History Yes Yes
Interests Category Yes Yes Yes Yes Yes Yes
Interest Yes Yes Yes Yes
Member Yes Yes Yes Yes Yes Yes
Member activity Yes
Member goal Yes
Member Note Yes Yes Yes Yes Yes Yes
Template Yes Yes Yes Yes
Authorized App Yes Yes
Segment Yes Yes Yes Yes
Aim Segment Yes Yes
Automation Segment Yes Yes
Campaign Poll Segment Yes Yes
Conversation Segment Yes Yes
Date Segment Yes Yes
Email Client Segment Yes Yes
Language Segment Yes Yes
Mandrill Segment Yes Yes
Member Rating Segment Yes Yes
Signup Source Segment Yes Yes
Survey Monkey Segment Yes Yes
VIP Segment Yes Yes
Ecomm Category Segment Yes Yes
Ecomm Number Segment Yes Yes
Ecomm Purchased Segment Yes Yes
Ecomm Spent Segment Yes Yes
Ecomm Store Segment Yes Yes
Goal Activity Segment Yes Yes
Goal Timestamp Segment Yes Yes
Fuzzy Segment Yes Yes
Static Segment Yes Yes
IPGeoCountry State Segment Yes Yes
IPGeo ln Segment Yes Yes
IPGeolnZip Segment Yes Yes
IPGeolnUnknown Segment Yes Yes
IPGeoZip Segment Yes Yes
SocialAge Segment Yes Yes
SocialGender Segment Yes Yes
SocialInfluence Segment Yes Yes
SocialNetworkMember Segment Yes Yes
SocialNetworkFollow Segment Yes Yes
Campaign Folder Yes Yes Yes Yes Yes
Template Folder Yes Yes Yes Yes Yes
Table 3. Batch Operations supported by the MailChimp objects
MailChimp Objects Create Retrieve Update Upsert Get Batch Result
Campaign Yes Yes Yes Yes
Feedback Yes Yes Yes Yes
Campaign Content Yes Yes Yes
Campaign Send Checklist Yes Yes
Conversation Yes Yes
Message Yes Yes Yes
File Yes Yes Yes Yes
Folder Yes Yes Yes Yes
List Yes Yes Yes Yes
List Abuse Report Yes Yes
Template Default Content Yes Yes
List Activity Yes
Client Yes
Growth History Yes Yes
Interest Category Yes Yes Yes Yes
Interest Yes Yes Yes
Member Yes Yes Yes Yes Yes
Member activity Yes
Member goal Yes
Member Note Yes Yes Yes Yes
Template Yes Yes
Authorized App Yes Yes
Segment Yes Yes
Aim Segment Yes Yes Yes
Automation Segment Yes Yes Yes
Campaign Poll Segment Yes Yes Yes
Conversation Segment Yes Yes Yes
Date Segment Yes Yes Yes
Email Client Segment Yes Yes Yes
Language Segment Yes Yes Yes
Mandrill Segment Yes Yes Yes
Member Rating Segment Yes Yes Yes
Signup Source Segment Yes Yes Yes
Survey Monkey Segment Yes Yes Yes
VIP Segment Yes Yes Yes
Ecomm Category Segment Yes Yes Yes
Ecomm Number Segment Yes Yes Yes
Ecomm Purchased Segment Yes Yes Yes
Ecomm Spent Segment Yes Yes Yes
Ecomm Store Segment Yes Yes Yes
Goal Activity Segment Yes Yes Yes
Goal Timestamp Segment Yes Yes Yes
Fuzzy Segment Yes Yes Yes
Static Segment Yes Yes Yes
IPGeoCountry State Segment Yes Yes Yes
IPGeoIn Segment Yes Yes Yes
IPGeolnZip Segment Yes Yes Yes
IPGeolnUnknown Segment Yes Yes Yes
IPGeoZip Segment Yes Yes Yes
SocialAge Segment Yes Yes Yes
SocialGender Segment Yes Yes Yes
SocialInfluence Segment Yes Yes Yes
SocialNetworkMember Segment Yes Yes Yes
SocialNetworkFollow Segment Yes Yes Yes
Campaign Folder Yes Yes Yes Yes
Template Folder Yes Yes Yes Yes

Atomic Operations:

  • Retrieve Reports:
    • Click Report
    • Members Click Report
    • Email Activities Report
    • Recipient Report
    • Unsubscribed Members Report
  • Retrieve All Reports:
    • Campaign Feedback Report
    • Click Report
    • Members Click Report
    • Domain Performance Report
    • Social Activity Report
    • Email Activities Report
    • Location Report
    • Recipient Report
    • Campaign Sub Report
    • Unsubscribed Member Report
  • Cancel Campaign
  • Upsert Members
  • Send Campaign
  • Get Batch Status

Custom objects support

MailChimp does not support custom objects.

Custom fields support

MailChimp merge fields are treated as custom fields, which can be created by end user only using MailChimp UI. These fields are associated only with MailChimp ‘Member’ object. Also the merge fields are associated with a specific List. Different MailChimp lists can have different merge fields. Custom fields are dynamically discovered on selection of a List.

In the Configure Panel, on selection of ‘Member’ object List Name Browse button will be enabled in order to select the list_id associated with merge fields. On selection of List Name, the merge fields will be populated in Map Inputs/Map Outputs Panel dynamically. List Name Browse Panel shows 50 Lists by default. ‘Next’ and ‘Previous’ button is used to fetch the lists as per ‘count’ text field.

User has a provision to override the value of ‘list_Id’ in the Map Input. If two different lists have the same set of merge fields, then specifying either of the list_id would suffice. However if the list_id overridden has different merge fields then only the common fields would retain values and others would be ignored. In case there are some mandatory merge fields defined for overridden list_id and these merge fields are not available for selected list_id in configure panel, then execution will error out. Users must note this and provide appropriate ‘list_Id’ based on the merge fields it populated. Also note that if list_id is provided in Map Input, it has more preference than the one selected in configure panel.

The connector activities of ‘Member’ Object which support merge field for Map Input is provided below:

  • Create Objects
  • Update Objects
  • Batch Create Objects
  • Batch Update Objects
  • Batch Upsert Objects
  • Upsert Members

The connector activities of ‘Member’ object which dynamically populates the merge field at Map Output are provided below:

  • Search
  • Retrieve All
  • Retrieve
  • Get Batch Results

Merge fields are associated with list_id.




Feedback | Notices


Timestamp icon Last updated: Tuesday, 27 September 2016


http://pic.dhe.ibm.com/infocenter/wci/v7r0m0/topic/com.ibm.wci.doc/MailChimp_creating_an_endpoint_activity.html