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
    ActiveCampaign
    Azure Bus
    Azure IoT Hub
    Azure Key Vault
    Azure Storage
    Bing Search
    ConstantContact
    CouchbaseDB
    CSV
    DB (RDBMS)
    Dropbox
    Files
    Flight Aware
    FreshBooks
    FTP
    Geonames
    GoogleDrive
    GoogleSearch
    GoogleSheet
    GreenMile
    GpsInsight
    HttpEndpoint (REST)
    Intacct
    Insteon
    Loggly
    MailChimp
    Messaging (SMS/SMTP)
    MongoDB
    Motus
    MSAD
    MSMQ
    OneDrive
    OneDrive365 (Business)
    Pipeline
    Pressero
    RabbitMQ
    SalesForce
    Shard
    SharePoint
    Slack
    SQL Server
    SQLX
    Sudoku
    Teams
    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



ActiveCampaign Adapter








Access the ActiveCampaign API through SQL commands.


This adapter may required a paid subscription with ActiveCampaign.



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 used for authentication
String BaseUrl The base url used for accessing the API

Handlers



AssignTag
Assign tag to contact details 

Arguments

Name Description Default
contactId R
tagId R

SQL Call

exec ActiveCampaign.AssignTag


Http Call

/bsc/activecampaign/assigntag

Output Columns

This call does not return data.

CreateAddress
addresses
Create a new address details 

Arguments

Name Description Default
companyname R
address R
countryCode R
city
state
zip

SQL Call

exec ActiveCampaign.CreateAddress 'companyname', 'address','US','city','state','zip'
insert into ActiveCampaign.addresses (companyname,address,countryCode,city,state,zip) values ('abc ltd','1 test','US','city','state','zip')


Http Call

/bsc/activecampaign/createaddress

Output Columns

This call does not return data.

CreateContact
contacts
Create a contact details 

Arguments

Name Description Default
email R
firstName
lastName
phone

SQL Call

exec ActiveCampaign.CreateContact
insert into from ActiveCampaign.contacts(email,firstName,lastName,phone) values('test@gmail.com','test user','last user','9869339094')


Http Call

/bsc/activecampaign/createcontact

Output Columns

This call does not return data.

CreateList
list
Create a new list details 

Arguments

Name Description Default
name R
stringId R
senderUrl R
senderReminder R

SQL Call

exec ActiveCampaign.CreateList 'abc ltd', 'abc-ltd','test.coom','test reminder'
insert into ActiveCampaign.list (name,stringId,senderurl,senderReminder) values ('abc ltd','abc-ltd','test.com','test reminder')


Http Call

/bsc/activecampaign/createlist

Output Columns

This call does not return data.

CreateMessage
messages
Create a message details 

Arguments

Name Description Default
fromname R
fromemail R
reply2 R
subject
preHeaderText

SQL Call

exec ActiveCampaign.CreateMessage 'fromname', 'fromemail','reply2','subject','preHeaderText'
insert into ActiveCampaign.messages (fromname,fromemail,reply2,subject,preHeaderText) values ('abc ltd','abc.gmail.com','def.gmail.com','test','test')


Http Call

/bsc/activecampaign/createmessage

Output Columns

This call does not return data.

Createtag
tags
Create a tag details 

Arguments

Name Description Default
tag
tagType
description

SQL Call

exec ActiveCampaign.Createtag 'test tag','contact','test tag description'
insert into from ActiveCampaign.tags(tag,tagType,description) values('test tagg','contact','to create test tag')


Http Call

/bsc/activecampaign/createtag

Output Columns

This call does not return data.

DeleteAddress
addresses
Delete an address details 

Arguments

Name Description Default
id R

SQL Call

exec ActiveCampaign.DeleteAddress '1'
delete from ActiveCampaign.addresses where id='1'


Http Call

/bsc/activecampaign/deleteaddress

Output Columns

This call does not return data.

DeleteAssignTag
Delete assign tag details 

Arguments

Name Description Default
id R

SQL Call

exec ActiveCampaign.DeleteAssignTag '1'


Http Call

/bsc/activecampaign/deleteassigntag

Output Columns

This call does not return data.

DeleteContact
contacts
Delete an account details 

Arguments

Name Description Default
id R

SQL Call

exec ActiveCampaign.DeleteContact '1'
delete from ActiveCampaign.contacts where id='1'


Http Call

/bsc/activecampaign/deletecontact

Output Columns

This call does not return data.

DeleteList
list
Delete a list details 

Arguments

Name Description Default
id R

SQL Call

exec ActiveCampaign.DeleteList '1'
delete from ActiveCampaign.list where id=1


Http Call

/bsc/activecampaign/deletelist

Output Columns

This call does not return data.

DeleteMessage
messages
Delete message details 

Arguments

Name Description Default
id R

SQL Call

exec ActiveCampaign.DeleteMessage '1'
delete from ActiveCampaign.messages where id='1'


Http Call

/bsc/activecampaign/deletemessage

Output Columns

This call does not return data.

DeleteTag
tags
Delete a tag details 

Arguments

Name Description Default
id R

SQL Call

exec ActiveCampaign.DeleteTag '1'
delete from ActiveCampaign.tags where id='1'


Http Call

/bsc/activecampaign/deletetag

Output Columns

This call does not return data.

ListAccounts
accounts
List all accounts details 

Arguments

Name Description Default
topn

SQL Call

exec ActiveCampaign.ListAccounts
select * from ActiveCampaign.accounts


Http Call

/bsc/activecampaign/listaccounts

Output Columns

Int32 id
String name
String accountUrl
DateTime createdTimestamp
DateTime updatedTimestamp
ListAllAddresses
addresses
List all addresses details 

Arguments

Name Description Default
topn

SQL Call

exec ActiveCampaign.ListAllAddresses
select * from ActiveCampaign.addresses where id=1


Http Call

/bsc/activecampaign/listalladdresses

Output Columns

Int32 id
String companyname
String address
String city
String state
String country
String zip
ListAllCampaigns
campaigns
List all Campaigns details 

Arguments

Name Description Default
topn

SQL Call

exec ActiveCampaign.ListAllCampaigns
select * from ActiveCampaign.campaigns where id=1


Http Call

/bsc/activecampaign/listallcampaigns

Output Columns

Int32 id
String type
Int32 userid
String name
DateTime cdate
DateTime mdate
ListAllContacts
contacts
List all contacts details 

Arguments

Name Description Default
topn

SQL Call

exec ActiveCampaign.ListAllContacts
select * from ActiveCampaign.contacts


Http Call

/bsc/activecampaign/listallcontacts

Output Columns

Int32 id
String firstName
String lastName
String email
String phone
DateTime cdate
DateTime adate
DateTime udate
DateTime edate
ListAllMessages
messages
List all messages details 

Arguments

Name Description Default
topn

SQL Call

exec ActiveCampaign.ListAllMessages
select * from ActiveCampaign.messages where id=1


Http Call

/bsc/activecampaign/listallmessages

Output Columns

Int32 id
String fromname
String fromemail
String reply2
String subject
DateTime cdate
DateTime mdate
String preHeaderText
String text
String html
ListAllTags
tags
List all tags details 

Arguments

Name Description Default
topn

SQL Call

exec ActiveCampaign.ListAllTags
select * from ActiveCampaign.tags


Http Call

/bsc/activecampaign/listalltags

Output Columns

Int32 id
String tagType
String tag
String description
DateTime cdate
ListAllTagsOnContact
List all tags on contact details 

Arguments

Name Description Default
topn

SQL Call

exec ActiveCampaign.ListAllTagsOnContact


Http Call

/bsc/activecampaign/listalltagsoncontact

Output Columns

Int32 id
String contactId
String tagId
DateTime cdate
RetriveAllList
list
Retrive all list details 

Arguments

Name Description Default
topn

SQL Call

exec ActiveCampaign.RetriveAllList
select * from ActiveCampaign.list where id=1


Http Call

/bsc/activecampaign/retrivealllist

Output Columns

Int32 id
String stringid
String name
DateTime cdate
String toName
String senderName
String senderUrl
String senderReminder
RetriveLinks
Retrive links by campaign details 
UpdateAddress
addresses
update an address details 

Arguments

Name Description Default
id R
companyname R
address R
countryCode R
city
state
zip

SQL Call

exec ActiveCampaign.UpdateAddress '1','test ltd', 'test address','US','city','state','zip'
Update ActiveCampaign.addresses set companyname='test1 ltd',address='test address',countryCode='US',city='cityname',state='statename',zip='zip code' where id='1'


Http Call

/bsc/activecampaign/updateaddress

Output Columns

This call does not return data.

UpdateContact
contacts
Update contact details 

Arguments

Name Description Default
id R
email R
firstName
lastName
phone

SQL Call

exec ActiveCampaign.UpdateContact
update from ActiveCampaign.contacts set email='test@gmail.com',firstName='test user',lastName='last user',phone='9869339094'


Http Call

/bsc/activecampaign/updatecontact

Output Columns

This call does not return data.

UpdateMessage
messages
Update message details 

Arguments

Name Description Default
id R
fromname R
fromemail R
reply2 R
subject
preHeaderText

SQL Call

exec ActiveCampaign.UpdateMessage '1', 'abc ltd', 'abc.gmail.com','def.gmail.com','test message','testing'
udpate ActiveCampaign.messages set fromname='abc ltd',fromemail='abc.gmail.com',reply2='def.gmail.com',subject='test message',preHeaderText='testing' where id='1'


Http Call

/bsc/activecampaign/updatemessage

Output Columns

This call does not return data.

UpdateTag
tags
Update tag details 

Arguments

Name Description Default
id R
tag
tagType
description

SQL Call

exec ActiveCampaign.UpdateTag
update from ActiveCampaign.tags set email='test@gmail.com',firstName='test user',lastName='last user',phone='9869339094'


Http Call

/bsc/activecampaign/updatetag

Output Columns

This call does not return data.