Introduction

Enzo Server
  Installation
  Quick Start
  Core Features
    Async Calls
    ConnectionStrings
    Edge Cache
    HTTP Access
    Scheduling
    Views
  Advanced Capabilities
    Change Data Capture
  Administration
    Configuration Settings
    Logins & ACL
    Auditing
    Current Executions
    Linked Server
    SSL

  User Guides
     Sharding
     Sharding Overview

     SharePoint

   Adapters
    All Adapters
    Azure Bus
    Azure IoT Hub
    Azure Key Vault
    Azure Storage
    Bing Search
    Couchbase
    CSV
    DB (RDBMS)
    Dropbox
    Files
    Flight Aware
    FTP
    GoogleDrive
    GoogleSearch
    GoogleSheet
    Geonames
    HttpEndpoint (REST)
    Insteon
    Loggly
    MailChimp
    Messaging (SMS/SMTP)
    MongoDB
    Motus
    MSAD
    MSMQ
    Pipeline
    Pressero
    RabbitMQ
    SalesForce
    Shard
    SharePoint
    Slack
    SQL Server
    SQLX
    Sudoku
    Threading
    Twilio
    Twitter
    VellemanDMX
    Whiparound
    WMI
    Xls (Excel)
    ZIP


  SDK
    Overview
    Installation
    DevHost
    Create A Simple Adapter
    Handler Columns

    Advanced SDK Concepts
      Handler Decorators
      Dynamic Columns
      Table & Table Enumerators
      Virtual Tables

/adapters/mailchimp




MailChimp


Access the MailChimp API including Audiences, Members, Campaigns, Webhooks, Notes and Tags.

Some of the handlers require a paid subscription to MailChimp.


Configuration Settings



Name Description Default
Boolean _isDefault Make this the default configuration. Defaults to true if configName is already the default.
String APIKey The API Key is used for authentication of MailChimp api

Handlers



AddNote
notes
Create member notes details 

Arguments

Name Description Default
listId R The listId
email R The email address of the member
note R The note to add

SQL Call

exec MailChimp.AddNote  'listId','email','This is test note'
insert into MailChimp.notes(note)values('this is test notes') WHERE listId='listid' and email='email'


Http Call

/bsc/mailchimp/addnote

Output Columns

Int32 id
DateTime createdAt
String createdBy
DateTime updatedAt
String note
String listId
String email
AddTags
tags
Add member tags details 

Arguments

Name Description Default
listId R The listId
email R The subscriber email
tags R The list of tags to add (comma-separated list)
isSyncing The isSyncing is used for automation based on the tags False

SQL Call

exec MailChimp.AddTags 'listId','email','test name','tag1,tag2', 0
insert into MailChimp.tags (tags,isSyncing) values ('tag1,tag2', 0) WHERE listId='listid' and email='email'


Http Call

/bsc/mailchimp/addtags

Output Columns

This call does not return data.

AddWebhook
webhooks
Create a webhook details 

Arguments

Name Description Default
listId R The listId to which the webhook is attached
url R The URL of the webhook
subscribe Fires the webhook when a member subcribes True
unsubscribe Fires the webhook when a member unsubcribes True
profile Fires the webhook when member profile changes True
cleaned Fires the webhook when a member is cleaned True
upemail Fires the webhook when the email is modified True
campaign Fires the webhook when a campaign is started False
sourceUser Fires when a user changes data True
sourceAdmin Fires when the administrator changes data True
sourceAPI Fires when an API changes data False

SQL Call

exec MailChimp.AddWebhook 'listId','url','subscribe','unsubscribe','profile','cleaned','campaign','sourceUser','sourceAdmin','sourceApi'
insert into MailChimp.webhooks(url,subscribe,unsubscribe,profile,cleaned,campaign,sourceUser,sourceAdmin,sourceApi)values(url,subscribe,unsubscribe,profile,cleaned,campaign,sourceUser,sourceAdmin,sourceApi) WHERE listId='listid'


Http Call

/bsc/mailchimp/addwebhook

Output Columns

String id
String url
Boolean subscribe
Boolean unsubscribe
Boolean profile
Boolean cleaned
Boolean upemail
Boolean campaign
Boolean sourceUser
Boolean sourceAdmin
Boolean sourceAPI
ArchiveMember
members
Archive member details 

Arguments

Name Description Default
listId R The list Id
email R The email address of the member

SQL Call

exec MailChimp.ArchiveMember 'listId', 'email'
delete from MailChimp.members where listId='listid' and email=''


Http Call

/bsc/mailchimp/archivemember

Output Columns

This call does not return data.

CreateAudience
audiences
Create a new audience/list details 

Arguments

Name Description Default
name R The name of the list/audience
permissionReminder R The permission reminder of the list/audience
language The language need to specify during list/audience creation us
company R The company name
address1 Company address line 1
address2 Company address line 2
city Company city
state Company state
zip Company zip code
country Company country
phone Company phone number
fromName The email From Name
fromEmail The From Email to use when sending emails
subject The subject
emailTypeOption The email type option is used to support multiple format of emails False

SQL Call

exec MailChimp.CreateAudience 'test', 'You are receiving this email because you visited out booth in Orlando', 'my corporation'
insert into MailChimp.audience () values ()


Http Call

/bsc/mailchimp/createaudience

Output Columns

String id
String name
String company
String address1
String address2
String city
String state
String zip
String country
String phone
String permissionReminder
CreateCampaign
campaigns
Create a new campaign details 

Arguments

Name Description Default
type R The type of campaign (regular,plaintext,absplit,rss,variate)
listId The list id used for the campaign
subjectLine The subject line for the campaign
previewText Preview text for the campaign
title The title of the campaign
fromName The From Name of the campaign
replyTo The replyTo is used to reply on this email
templateId The template Id to use
toName The To Name of the campaign

SQL Call

exec MailChimp.CreateCampaign @type='Regular',@listId='',@subjectLine='',@previewText='',@title='',@fromName='',@replyTo='',@toName=''
insert into MailChimp.campaign (type,listId,subjectLine,previewText,title,fromName,replyTo,useConversation,toName) values('Regular','','subject test','preview test','Test title','From name','reply to',false,'to name')


Http Call

/bsc/mailchimp/createcampaign

Output Columns

String campaignId
String type
String createTime
String archiveUrl
String longArchiveUrl
String status
String emailsSent
String sendTime
String contentType
CreateMember
members
Create new member details 

Arguments

Name Description Default
listId R The list Id to create member
emailAddress R The email address of the member
status The status of the member (subscribed/unsubscribed/cleaned/pending/transactional) subscribed
mergeFields The merge fields used to merge member data (ex: { 'FNAME': 'james' } } )
emailType The email type (html/text) text

SQL Call

exec MailChimp.CreateMember 'listId',@emailAddress='test@gmail.com',@status='pending'
insert into MailChimp.members(listId,emailAddress,status)values('listid','test@gmail.com','pending')


Http Call

/bsc/mailchimp/createmember

Output Columns

String id
String email_address
String email_type
String status
String unsubscribe_reason
String merge_fields
String stats
DeleteAudience
audiences
Delete an audience details 

Arguments

Name Description Default
id R The audience id to delete

SQL Call

exec MailChimp.DeleteAudience @id='b19b250ce1'
delete from MailChimp.audience where id='b19b250ce1'


Http Call

/bsc/mailchimp/deleteaudience

Output Columns

This call does not return data.

DeleteCampaign
campaigns
Delete a campaign details 

Arguments

Name Description Default
id R The campaign id to delete that campaign

SQL Call

exec MailChimp.DeleteCampaign @id='b19b250ce1'
delete from MailChimp.campaign where id='b19b250ce1'


Http Call

/bsc/mailchimp/deletecampaign

Output Columns

This call does not return data.

DeleteMember
Delete member details 

Arguments

Name Description Default
listId R The list Id
email R The email address of the member

SQL Call

exec MailChimp.DeleteMember 'listId','email'


Http Call

/bsc/mailchimp/deletemember

Output Columns

This call does not return data.

DeleteNote
notes
Delete a member note details 

Arguments

Name Description Default
listId R The listId
email R The subscriber email
noteId R The noteId to delete

SQL Call

exec MailChimp.DeleteNote  'listId','email','noteId'
Delete from MailChimp.notes WHERE listId='listid' and email='email' and noteId='noteid'


Http Call

/bsc/mailchimp/deletenote

Output Columns

This call does not return data.

DeleteWebhook
webhooks
Delete a webhook details 

Arguments

Name Description Default
listId R The listId
webhookId R The webhook id to delete

SQL Call

exec MailChimp.DeleteWebhook 'listId','webhookid'
delete from MailChimp.webhooks WHERE listId='listid' and webhookId='webhookid'


Http Call

/bsc/mailchimp/deletewebhook

Output Columns

This call does not return data.

ListAudience
audiences
Gets the list of existing audiences/lists details 

Arguments

Name Description Default
email Filter on lists that contain a specific email address
topn Top N parameter for EXEC operations

SQL Call

exec MailChimp.ListAudience
select * from MailChimp.audiences


Http Call

/bsc/mailchimp/listaudience

Output Columns

String id
String name
String company
String address1
String address2
String city
String state
String zip
String country
String phone
Int32 member_count
Int32 total_contacts
Int32 unsubscribe_count
Int32 cleaned_count
Int32 member_count_since_send
Int32 unsubscribe_count_since_send
Int32 cleaned_count_since_send
Int32 campaign_count
DateTime campaign_last_sent
Double open_rate
Double click_rate
String email
ListCampaign
campaigns
Returns the list of existing campaigns details 

Arguments

Name Description Default
topn Top N parameter for EXEC operations

SQL Call

exec MailChimp.ListCampaign
select * from MailChimp.campaigns


Http Call

/bsc/mailchimp/listcampaign

Output Columns

String id
String type
DateTime createTime
DateTime sendTime
Int32 emailsSent
String listId
String listName
Int32 recipientCount
String subjectLine
String fromName
String replyTo
String archiveUrl
String longArchiveUrl
String status
String contentType
String title
ListNotes
notes
List of member notes details 

Arguments

Name Description Default
listId R The listId
email R The email address of the member

SQL Call

exec MailChimp.ListNotes 'listId','email'
select * from MailChimp.notes WHERE listId='listid' and email='email'


Http Call

/bsc/mailchimp/listnotes

Output Columns

Int32 id
DateTime createdAt
String createdBy
DateTime updatedAt
String note
String listId
String email
ListTags
tags
List of member tags details 

Arguments

Name Description Default
listId R The listId
email R The subscriber email

SQL Call

exec MailChimp.ListTags 'listId','email'
select * from MailChimp.tags WHERE listId='listid' and email='email'


Http Call

/bsc/mailchimp/listtags

Output Columns

String id
String name
DateTime dateAdded
String listId
String email
ListWebhook
webhooks
List existing webhooks details 

Arguments

Name Description Default
listId R The listId

SQL Call

exec MailChimp.ListWebhook 'listId'
select * from MailChimp.webhooks WHERE listId='listid'


Http Call

/bsc/mailchimp/listwebhook

Output Columns

String id
String listId
String url
Boolean subscribe
Boolean unsubscribe
Boolean profile
Boolean cleaned
Boolean upemail
Boolean campaign
Boolean sourceUser
Boolean sourceAdmin
Boolean sourceAPI
PauseRSSCampaign
Pause an RSS campaign details 

Arguments

Name Description Default
id R The campaign id to pase for RSS

SQL Call

exec MailChimp.PauseRSSCampaign @id='b19b250ce1'


Http Call

/bsc/mailchimp/pausersscampaign

Output Columns

This call does not return data.

RemoveTags
tags
Delete member tags details 

Arguments

Name Description Default
listId R The listId
email R The subscriber email
tags R The list of tags to remove (comma-separated list)

SQL Call

exec MailChimp.RemoveTags 'listId','email', 'tag1,tag2'
delete from MailChimp.tags WHERE listId='listid' and email='email' and tags='tag1,tag2'


Http Call

/bsc/mailchimp/removetags

Output Columns

This call does not return data.

ReplicateCampaign
Replicate a campaign details 

Arguments

Name Description Default
id R The campaign id to replicate

SQL Call

exec MailChimp.ReplicateCampaign @id='b19b250ce1'


Http Call

/bsc/mailchimp/replicatecampaign

Output Columns

This call does not return data.

ResendCampaign
Resend a campaign details 

Arguments

Name Description Default
id R The campaign id to resend

SQL Call

exec MailChimp.ResendCampaign @id='b19b250ce1'


Http Call

/bsc/mailchimp/resendcampaign

Output Columns

This call does not return data.

ResumeRSSCampaign
Resume an RSS campaign details 

Arguments

Name Description Default
id R The campaign id to resume for RSS

SQL Call

exec MailChimp.ResumeRSSCampaign @id='b19b250ce1'


Http Call

/bsc/mailchimp/resumersscampaign

Output Columns

This call does not return data.

ScheduleCampaign
Schedule a campaign details 

Arguments

Name Description Default
id R The campaign id to schedule
scheduleTime R The scheduleTime as a UTC date/time
timewarp The timewrap is used to send compaign to local time False
batchDelay The batchDelay is used to delay, in minutes, between batches
batchCount The batchCount is used to the number of batches for the campaign send

SQL Call

exec MailChimp.ScheduleCampaign @id='b19b250ce1', scheduleTime=''


Http Call

/bsc/mailchimp/schedulecampaign

Output Columns

This call does not return data.

SearchMembers
members
Search members across all lists or within a list details 

Arguments

Name Description Default
query The text to search members (required if listId not provided)
listId The list to search (optional)

SQL Call

exec MailChimp.SearchMembers 'dave'
select * from MailChimp.members WHERE query='dave'


Http Call

/bsc/mailchimp/searchmembers

Output Columns

String id
String email
String status
String fName
String lName
String address
String phone
String birthday
String ip
Int32 memberRating
DateTime lastChanged
String source
String tags
String listId
String query
SendCampaign
Send a campaign as soon as possible details 

Arguments

Name Description Default
id R The campaign id to send

SQL Call

exec MailChimp.SendCampaign @id='b19b250ce1'


Http Call

/bsc/mailchimp/sendcampaign

Output Columns

This call does not return data.

SendTestEmail
Send a test email details 

Arguments

Name Description Default
id R The campaign id used to send test email
testEmails R The test email to send specify with comma seperated
sendType The send type is used for html and plan text PlainText

SQL Call

exec MailChimp.SendTestEmail @id='b19b250ce1',@testEmails='test1@gmail.com,test2@gmail.com',@sendType='PlainText'


Http Call

/bsc/mailchimp/sendtestemail

Output Columns

This call does not return data.

UnscheduleCampaign
Unschedule a campaign details 

Arguments

Name Description Default
id R The campaign id used to unschedule

SQL Call

exec MailChimp.UnscheduleCampaign @id='b19b250ce1'


Http Call

/bsc/mailchimp/unschedulecampaign

Output Columns

This call does not return data.

UpdateAudience
audiences
Update an existing audience details 

Arguments

Name Description Default
id R The audience id/audience
name The name of the list/audience
language The language is required to set for this list/audience
permissionReminder The permission reminder of the list/audience
company The company is required for create list/audience
address1 Company address line 1
address2 Company address line 2
city Company city
state Company state
zip Company zip code
country Company country
phone Company phone number
fromName The email From Name
fromEmail The From Email to use when sending emails
subject The subject
emailTypeOption The email type option is used to support multiple format of emails False

SQL Call

exec MailChimp.UpdateAudience @id='b19b250ce1', @name='Test',@permissionReminder='test',@company='Test Ltd',@fromName='test',@fromEmail='test@test.com',@subject='test',@language='English'
upadte MailChimp.audience set name='Test',permissionReminder='test',company='Test Ltd',fromName='test',fromEmail='test@test.com',subject='test',language='English' where id='b19b250ce1'


Http Call

/bsc/mailchimp/updateaudience

Output Columns

This call does not return data.

UpdateCampaign
campaigns
Update a campaign details 

Arguments

Name Description Default
campaignId R The Campaign Id to update
listId The list id used for the campaign
subjectLine The subject line for the campaign
previewText Preview text for the campaign
title The title of the campaign
fromName The From Name of the campaign
replyTo the replyTo is used to reply on this email
templateId The template Id to use
toName The To Name of the campaign

SQL Call

exec MailChimp.UpdateCampaign @campaignId='', @listId='',@subjectLine='',@previewText='',@title='',@fromName='',@replyTo='',@toName=''
Update MailChimp.campaign set listId='',subjectLine='',previewText='',title='',fromName='',replyTo='',useConversation=false,toName='' where campaignId=''


Http Call

/bsc/mailchimp/updatecampaign

Output Columns

This call does not return data.

UpdateMember
members
Update existing member details 

Arguments

Name Description Default
listId R The list Id where the member is found
email R The email address of the member
status R The status of the member (subscribed/unsubscribed/cleaned/pending/transactional)
mergeFields The merge fields used to merge member data
emailType R The email type (html/text)

SQL Call

exec MailChimp.UpdateMember 'listId',@email='test@gmail.com',@status='pending'
update MailChimp.members set email='test@gmail.com',status='pending' where listId='listid'


Http Call

/bsc/mailchimp/updatemember

Output Columns

String id
String email
String email_type
String status
String unsubscribe_reason
String merge_fields
String stats
UpdateNote
notes
Update member notes details 

Arguments

Name Description Default
listId R The listId
email R The subscriber email
noteId R The noteId to update
note R The note

SQL Call

exec MailChimp.UpdateNote  'listId','email','This is test note'
Update MailChimp.notes set note='this is test notes' WHERE listId='listid' and email='email' and noteId='noteid'


Http Call

/bsc/mailchimp/updatenote

Output Columns

Int32 id
DateTime createdAt
String createdBy
DateTime updatedAt
String note
String listId
String email
UpdateWebhook
webhooks
Update a webhook details 

Arguments

Name Description Default
listId R The listId is used to get ListWebhook
webhookId R The webhook id to update
url R The URL of the webhook
subscribe R Fires the webhook when a member subcribes
unsubscribe R Fires the webhook when a member unsubcribes
profile R Fires the webhook when member profile changes
cleaned R Fires the webhook when a member is cleaned
upemail R Fires the webhook when the email is modified
campaign R Fires the webhook when a campaign is started
sourceUser R Fires when a user changes data
sourceAdmin R Fires when the administrator changes data
sourceAPI R Fires when an API changes data

SQL Call

exec MailChimp.UpdatetWebhook 'listId','webhookId','url','subscribe','unsubscribe','profile','cleaned','campaign','sourceUser','sourceAdmin','sourceApi'
update MailChimp.webhooks set url='url',subscribe='subscribe',unsubscribe='unsubscribe',profile='profile',cleaned='cleaned',campaign='campaign',sourceUser='sourceUser',sourceAdmin='sourceAdmin',sourceApi='sourceApi' WHERE listId='listid' and webhookId='webhookId'


Http Call

/bsc/mailchimp/updatewebhook

Output Columns

String id
String url
Boolean subscribe
Boolean unsubscribe
Boolean profile
Boolean cleaned
Boolean upemail
Boolean campaign
Boolean sourceUser
Boolean sourceAdmin
Boolean sourceAPI