Adding a Connection to ActiveCampaign

To add a connection to ActiveCampaign:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the ActiveCampaign icon is not available, click the Add More icon to download and install the ActiveCampaign connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to ActiveCampaign

ActiveCampaign supports authenticating with the API Key. To connect to ActiveCampaign, in your account navigate to the Developer page and set the following:

• URL: Navigate to the My Settings page to set this property. For example: https://<yourAccountName>.api-us1.com
• APIKey: Navigate to the Settings page to set this property. Each user in your ActiveCampaign account has their own unique API key.

Make sure to distinguish between My Settings and Settings when setting these properties.

Overview

The Sync App models ActiveCampaign resources like Contacts, Accounts as relational tables, allowing you to write SQL to query ActiveCampaign data.

Live connectivity to these objects means any changes to your ActiveCampaign account are immediately reflected when using the Sync App.

Views

Views are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.

Dynamic Views

Along with the default static views, the Sync App also allows querying on dynamic views.

These are views that are created based on the "lists" (also called "audiences") in your ActiveCampaign account.
For example, suppose you have these 3 lists in your account: Master Contact List, New Audience, VIP List.

The Sync App lists 3 views based on them: List_MasterList, List_New Audience, List_VIP List.
The views return data about each contact that is a member of that specific list.

Tables

Tables describes the available tables. Tables are statically defined to model resources like Accounts, Deals, DealGroups, DealStages, Tasks, etc.

The Sync App also supports querying tables like AccountCustomFieldData, DealCustomFieldData, ContactCustomFieldData which represent custom field data information.

Additionally, the Sync App supports updating, inserting custom fields data from the main resource (available for the Accounts, Contacts, Deals tables) where custom fields are dynamically appended as main resource columns. See the specific table section for more information.

The Sync App models the data in ActiveCampaign as a list of tables in a relational database that can be queried using standard SQL statements.

ActiveCampaign Connector for CData Sync Tables

Name	Description
AccountContacts	Usage information for the operation AccountContacts.rsd.
AccountCustomFieldData	Create, modify, delete and query the available deal custom field data in ActiveCampaign.
Accounts	View many or all contacts by including their ID's or various filters.
ContactCustomFieldData	Create, modify, delete and query the available contact custom field data in ActiveCampaign.
Contacts	View many or all contacts by including their ID's or various filters.
DealCustomFieldData	Create, modify, delete and query the available deal custom field data in ActiveCampaign.
DealGroups	Lists all existing accounts.
Deals	Usage information for the operation Deals.rsd.
DealStages	Usage information for the operation DealStages.rsd.
Tasks	Lists all existing accounts.

Usage information for the operation AccountContacts.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM AccountContacts WHERE Id = 10003

SELECT * FROM AccountContacts WHERE AccountId = 1 AND ContactId = 100

Insert

Inserting an account-contact association requires specifying a value for the AccountId and ContactId columns.

INSERT INTO AccountContacts (AccountId, ContactId) VALUES (2, 300)

INSERT INTO AccountContacts (AccountId, ContactId, Jobtitle) VALUES (2, 300, 'nurse')

Update

The driver supports updating account-contact information.

UPDATE AccountContacts SET ContactId = 3, JobTitle = 'updatedJobTitle' WHERE Id = 1

UPDATE AccountContacts SET JobTitle = 'updatedJobTitle' WHERE AccountId = 1

Delete

Remove all account-contacts association or an association by specifying the Id of the association.

DELETE FROM AccountContacts WHERE Id = 10003

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the account-contact association.
AccountId	String	False	The account Id.
ContactId	String	False	The contact Id.
CreatedTimestamp	Datetime	True	Datetime value which indicates when the assosiaction was created.
JobTitle	String	False	Job Title of the contact at the account.
AccountLink	String	True	Account link.
ContactLink	String	True	Contact link.
UpdatedTimestamp	Datetime	True	Datetime value which indicates when the assosiaction was last updated.

Create, modify, delete and query the available deal custom field data in ActiveCampaign.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM AccountCustomFieldData WHERE Id = 10003

SELECT * FROM AccountCustomFieldData WHERE AccountId = 1

Insert

Inserting an account custom field data requires specifying a value for the AccountId, CustomFieldId, FieldValue columns.

Additionally, the Sync App supports inserting account custom fields data from the Accounts table. See Accounts for more information.

INSERT INTO AccountCustomFieldData (FieldValue, CustomFieldId, AccountId) VALUES ('custom field value', 1, 5)

Update

The Sync App supports updating account custom field data information. Updating an account custom field data requires specifying a value for the Id and CustomFieldId columns.

Additionally, it is possible to update account custom fields data from the Accounts table.

UPDATE AccountCustomFieldData SET FieldValue = 'Custom Field Value' WHERE Id = 13 AND CustomFieldId = 1

Delete

The Sync App supports removing accounts' custom field data.

DELETE FROM AccountcustomFieldData WHERE Id = 10

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the account custom field data.
AccountCustomFieldMetumId	Integer	True	The custom field metum Id.
AccountId	Integer	False	The ID of the account the field value relates to.
CreatedTimestamp	Datetime	True	Datetime value that indicates when the custom field value was set.
CustomFieldId	Integer	False	The ID of the custom field metum the field value relates to.
CustomFieldName	String	True	The name of the custom field metum the field value relates to.
FieldValue	String	False	Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5).
AccountLink	String	True	Account link.
AccountCustomFieldMetumLink	String	True	AccountCustomFieldMetum link.
UpdatedTimestamp	Datetime	True	Datetime value which indicates when the custom field data was last updated.
FieldCurrency	String	False	Value of the custom field currency type for a specific contact. This field is required when inserting currency custom fields.

View many or all contacts by including their ID's or various filters.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Accounts WHERE Id = 10003

SELECT * FROM Accounts WHERE Name = 'testAccount'

As a note, due to server-side performance issues, even when the property IncludeCustomFields is set to TRUE, the custom fields will appear only in the table schema with null values. To retrieve the values of the custom fields, please refer to the AccountCustomFieldData table.

Insert

Inserting an account requires specifying the account name.

INSERT INTO Accounts (Name) VALUES ('testAccount2')

INSERT INTO Accounts (Name, AccountUrl) VALUES ('account', 'http://accountUrl.com/')

Additionally, the Sync App supports inserting account and account custom fields data from the Accounts table. All custom field columns start with CF_.

INSERT INTO Accounts (Name, CF_Description, CF_Hidden, CF_Number) VALUES ('testAccount3', 'custom field value', 'custom field value', 123)

Update

The Sync App supports updating account information.

Additionally, it is possible to update account custom fields data from the Accounts table.

UPDATE Accounts SET Name = 'updatedName', AccountUrl = 'http://updatedAccountUrl.com/' WHERE Id = 1

UPDATE Accounts SET Name = 'updatedName', CF_Description = 'custom field value', CF_Hidden = 'custom field value' WHERE Id = 1

Delete

Remove all accounts or an account by specifying the Id of the account.

DELETE FROM Accounts WHERE Id = 10003

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id column of the Accounts table.
AccountUrl	String	False	Account's website.
ContactCount	Integer	True	The ContactCount column of the Accounts table.
CreatedTimestamp	Datetime	True	The CreatedTimestamp column of the Accounts table.
DealCount	Integer	True	The DealCount column of the Accounts table.
AccountContactsLink	String	True	The AccountContactsLink column of the Accounts table.
AccountCustomFieldDataLink	String	True	The AccountCustomFieldDataLink column of the Accounts table.
ContactEmailsLink	String	True	The ContactEmailsLink column of the Accounts table.
EmailActivitiesLink	String	True	The EmailActivitiesLink column of the Accounts table.
NotesLink	String	True	The NotesLink column of the Accounts table.
Name	String	False	Account's name.
UpdatedTimestamp	Datetime	True	The UpdatedTimestamp column of the Accounts table.

Create, modify, delete and query the available contact custom field data in ActiveCampaign.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM ContactCustomFieldData WHERE Id = 10003

SELECT * FROM ContactCustomFieldData WHERE FieldValue = 'custom field value'

Insert

Inserting a contact custom field data requires specifying a value for the ContactId, FieldId, FieldValue columns.

Additionally, the Sync App supports inserting contact custom fields data from the Contacts table. See Contacts for more information.

INSERT INTO ContactCustomFieldData (FieldValue, FieldId, ContactId) VALUES ('custom field value', 1, 5)

Update

The Sync App supports updating contact custom field data information. Updating contact custom field data requires specifying a value for the Id, ContactId and FieldId columns.

Additionally, it is possible to update contact custom fields data from the Contacts table.

UPDATE ContactCustomFieldData SET FieldValue = 'custom field value' WHERE Id = 8 AND ContactId = 3 AND FieldId = 2"

Delete

The Sync App supports removing contact custom field data.

DELETE FROM ContactCustomFieldData WHERE Id = 10

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The Id column of the ContactCustomFieldData table.
CDate	Datetime	False	The CDate column of the ContactCustomFieldData table.
ContactId	String	False	The ContactId column of the ContactCustomFieldData table.
CustomFieldName	String	True	The name of the custom field metum the field value relates to.
FieldId	String	False	ID of the field the value belongs to.
FieldLink	String	False	The FieldLink column of the ContactCustomFieldData table.
OwnerLink	String	False	The OwnerLink column of the ContactCustomFieldData table.
Owner	String	False	The Owner column of the ContactCustomFieldData table.
Udate	Datetime	False	The Udate column of the ContactCustomFieldData table.
FieldValue	String	False	Value of the custom field for a specific contact.

View many or all contacts by including their ID's or various filters.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Contacts WHERE Id = 10

SELECT * FROM Contacts WHERE Udate >= '2019-06-30T10:44:34-05:00'

SELECT * FROM Contacts WHERE Udate <= '2021-06-30T10:44:34-05:00'

SELECT * FROM Contacts WHERE Cdate >= '2019-06-30T10:44:34-05:00' AND Cdate <= '2021-06-30T10:44:34-05:00'

As a note, due to server-side performance issues, even when the property IncludeCustomFields is set to TRUE, the custom fields will appear only in the table schema with null values. To retrieve the values of the custom fields, please refer to the ContactCustomFieldData table.

Insert

Inserting a contact requires specifying the contact email.

INSERT INTO Contacts (Email) VALUES ('[email protected]')

INSERT INTO Contacts (Email, FirstName, LastName, Phone) VALUES ('[email protected]', 'test', 'test', 'contactphonenumber')

Additionally, the Sync App supports inserting contact and contact custom fields data from the Contacts table. All custom field columns start with CF_.

INSERT INTO Contacts (Name, CF_Description, CF_Hidden, CF_Number) VALUES ('testcontact3', 'custom field value', 'custom field value', 123)

Update

The Sync App supports updating contact information.

Additionally, it is possible to update contact custom fields data from the Contacts table.

UPDATE Contacts SET FirstName = 'updatedName' WHERE Id = 1

UPDATE Contacts SET CF_CustomField1 = 'custom field value', CF_CustomField2 = 'custom field value' WHERE Id = 1

Bulk Import Contacts

The Sync App supports uploading large numbers of contacts into your account. This operation includes:

• Creating new contacts
• Updating existing contacts
• Subscribing and unsubscribing from lists

Contacts are imported in batches of up to 250 items. The importer is not recommended to be used for a small number of contacts. You can import contacts as below:

INSERT INTO Contacts#TEMP (Email) VALUES ('[email protected]')

INSERT INTO Contacts#TEMP (Email) VALUES ('[email protected]')

UPSERT INTO Contacts (Email) SELECT Email FROM Contacts#TEMP

Additionally, the Sync App supports BULK INSERT for the Contacts table. Please note this operation will cause a cost in performance as the Sync App validates if the submitted contacts exist before importing them.

INSERT INTO Contacts#TEMP (Email) VALUES ('[email protected]')

INSERT INTO Contacts#TEMP (Email) VALUES ('[email protected]')

INSERT INTO Contacts (Email) SELECT Email FROM Contacts#TEMP

To subscribe and unsubscribe contacts from a specific list set a value for the SubscribeTo and/or UnsubcribeFrom columns which accept a comma-separated list of list ids. For example:

INSERT INTO Contacts#TEMP (Email, SubscribeTo, UnsubcribeFrom) VALUES ('[email protected]', '1,2', '6,12')

INSERT INTO Contacts#TEMP (Email, SubscribeTo, UnsubcribeFrom) VALUES ('[email protected]', '3,7', '6,1')

UPSERT INTO Contacts (Email, SubscribeTo, UnsubcribeFrom) SELECT Email, SubscribeTo, UnsubcribeFrom FROM Contacts#TEMP

Contacts must meet all the following criteria in order to be created or updated with this API:

• The imported contacts may not exceed your account limit
• The contact must have an email address
• The contact's email address must not be on an exclusion list
• The contact's email must not be on a list of bounced email addresses
• The contact must not have unsubscribed to a list that the import would add them to

If contacts do not meet all of these requirements, they will be skipped by the importer.

Delete

Remove all contacts or a contact by specifying the Id of the contact.

DELETE FROM Contacts WHERE Id = 10003

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id column of the Contacts table.
Adate	Datetime	True	The Adate column of the Contacts table.
Anonymized	String	True	The Anonymized column of the Contacts table.
BouncedDate	String	True	The BouncedDate column of the Contacts table.
BouncedHard	String	True	The BouncedHard column of the Contacts table.
BouncedSoft	String	True	The BouncedSoft column of the Contacts table.
Cdate	Datetime	True	The Cdate column of the Contacts table.
CreatedBy	String	True	The CreatedBy column of the Contacts table.
CreatedTimestamp	Datetime	True	The CreatedTimestamp column of the Contacts table.
CreatedUtcTimestamp	Datetime	True	The CreatedUtcTimestamp column of the Contacts table.
Deleted	String	True	The Deleted column of the Contacts table.
DeletedAt	String	True	The DeletedAt column of the Contacts table.
Edate	Datetime	True	The Edate column of the Contacts table.
Email	String	False	The Email column of the Contacts table.
EmailDomain	String	True	The EmailDomain column of the Contacts table.
EmailEmpty	Boolean	True	The EmailEmpty column of the Contacts table.
EmailLocal	String	True	The EmailLocal column of the Contacts table.
FirstName	String	False	The FirstName column of the Contacts table.
Gravatar	String	True	The Gravatar column of the Contacts table.
Hash	String	True	The Hash column of the Contacts table.
Ip	String	True	The Ip column of the Contacts table.
LastName	String	False	The LastName column of the Contacts table.
AccountContactsLink	String	True	The AccountContactsLink column of the Contacts table.
AutomationEntryCountsLink	String	True	The AutomationEntryCountsLink column of the Contacts table.
BounceLogsLink	String	True	The BounceLogsLink column of the Contacts table.
ContactAutomationsLink	String	True	The ContactAutomationsLink column of the Contacts table.
ContactDataLink	String	True	The ContactDataLink column of the Contacts table.
ContactDealsLink	String	True	The ContactDealsLink column of the Contacts table.
ContactGoalsLink	String	True	The ContactGoalsLink column of the Contacts table.
ContactListsLink	String	True	The ContactListsLink column of the Contacts table.
ContactLogsLink	String	True	The ContactLogsLink column of the Contacts table.
ContactTagsLink	String	True	The ContactTagsLink column of the Contacts table.
DealsLink	String	True	The DealsLink column of the Contacts table.
FieldValuesLink	String	True	The FieldValuesLink column of the Contacts table.
GeoIpsLink	String	True	The GeoIpsLink column of the Contacts table.
NotesLink	String	True	The NotesLink column of the Contacts table.
OrganizationLink	String	True	The OrganizationLink column of the Contacts table.
PlusAppendLink	String	True	The PlusAppendLink column of the Contacts table.
ScoreValuesLink	String	True	The ScoreValuesLink column of the Contacts table.
TrackingLogsLink	String	True	The TrackingLogsLink column of the Contacts table.
Organization	String	True	The Organization column of the Contacts table.
Orgname	String	True	The Orgname column of the Contacts table.
Phone	String	False	The Phone column of the Contacts table.
RatingTStamp	String	True	The RatingTStamp column of the Contacts table.
SegmentioId	String	True	The SegmentioId column of the Contacts table.
Sentcnt	String	True	The Sentcnt column of the Contacts table.
SocialdataLastcheck	String	True	The SocialdataLastcheck column of the Contacts table.
Ua	String	True	The Ua column of the Contacts table.
Udate	Datetime	True	The Udate column of the Contacts table.
UpdatedTimestamp	String	True	The UpdatedTimestamp column of the Contacts table.
Updated_by	String	True	The Updated_by column of the Contacts table.
SubscribeTo	String	False	Comma-separated list of list Ids to subscribe a contact to.
UnsubscribeFrom	String	False	Comma-separated list of list Ids to unsubscribe a contact from.

Create, modify, delete and query the available deal custom field data in ActiveCampaign.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM DealCustomFieldData WHERE Id = 10003

SELECT * FROM DealCustomFieldData WHERE DealId = 1

Insert

Inserting a deal custom field data requires specifying a value for the DealId, CustomFieldId, and FieldValue columns.

Additionally, the Sync App supports inserting deal custom fields data from the Deals table. See Deals for more information.

INSERT INTO DealCustomFieldData (FieldValue, CustomFieldId, DealId) VALUES ('custom field value', 1, 5)

Update

The Sync App supports updating deal custom field data information. Updating deal custom field data requires specifying a value for the Id, DealId and CustomFieldId columns.

Additionally, it is possible to update deal custom fields data from the Deals table.

UPDATE DealCustomFieldData SET FieldValue = 'custom field value' WHERE Id = 8 AND DealId = 3 AND CustomFieldId = 2

Delete

The Sync App supports removing deal custom field data.

DELETE FROM DealCustomFieldData WHERE Id = 10

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	The Id column of the DealCustomFieldData table.
CreatedTimestamp	Datetime	False	The CreatedTimestamp column of the DealCustomFieldData table.
CustomFieldName	String	True	The name of the custom field metum the field value relates to.
CustomFieldId	Integer	False	The CustomFieldId column of the DealCustomFieldData table.
DealCustomFieldMetumId	Integer	False	The DealCustomFieldMetumId column of the DealCustomFieldData table.
DealId	Integer	False	The DealId column of the DealCustomFieldData table.
FieldValue	String	False	The FieldValue column of the DealCustomFieldData table.
DealLink	String	False	The DealLink column of the DealCustomFieldData table.
DealCustomFieldMetumLink	String	False	The DealCustomFieldMetumLink column of the DealCustomFieldData table.
UpdatedTimestamp	Datetime	False	The UpdatedTimestamp column of the DealCustomFieldData.
FieldCurrency	String	False	Value of the custom field currency type for a specific deal. This field is required when inserting currency custom fields.
FieldType	String	False	Value of the custom field currency type for a specific deal. This field is required when inserting currency custom fields.

Lists all existing accounts.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM DealGroups WHERE Id = 10003

SELECT * FROM DealGroups WHERE Title = 'title'

Insert

Inserting a pipeline/dealgroup requires specifying a value for the Currency, Title columns.

INSERT INTO DealGroups (Currency, Title) VALUES (2, 300)

INSERT INTO DealGroups (Currency, Title, AutoAssign, AllUsers, AllGroups) VALUES ('USD', 'title', 1, 0, 1)

Update

The Sync App supports updating pipeline/dealgroup information.

UPDATE DealGroups SET AllUsers = 0, AllGroups = 1, Currency = 'EUR' WHERE Id = 1

Delete

Remove all pipelines or a pipeline by specifying the Id of the dealgroup.

DELETE FROM DealGroups WHERE Id = 10003

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The pipeline Id.
AllGroups	String	False	The AllGroups column of the DealGroups table. Indicates whether all user groups have permission to manage this pipeline. Can be either 1 or 0. If 1, all user groups can manage this pipeline. If 0, only user groups in dealGroup.groups parameter can manage this pipeline.
AllUsers	String	False	The AllUsers column of the DealGroups table. Indicates whether new deals get auto-assigned to all users. Can be either 1 or 0. If 1, new deals are auto-assigned to all users unless auto-assign is disabled. If 0, new deals are auto-assigned to only the users in dealGroup.users parameter.
AutoAssign	String	False	The AutoAssign column of the DealGroups table. Deal auto-assign option. Can be one of 0, 1, and 2. If 0, auto-assign is disabled. If 1, Round Robin method is used to auto-assign new deals. If 2, deals are distributed based on deal values.
Cdate	Datetime	True	The Cdate column of the DealGroups table.
Currency	String	False	The Currency column of the DealGroups table.
DealGroupGroupsLink	String	True	The DealGroupGroupsLink column of the DealGroups table.
DealGroupUsersLink	String	True	The DealGroupUsersLink column of the DealGroups table.
StagesLink	String	True	The StagesLink column of the DealGroups table.
Stages	String	True	The Stages column of the DealGroups table.
Title	String	False	Pipeline's title.
Udate	Datetime	True	The Udate column of the DealGroups table.

Usage information for the operation Deals.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Deals WHERE Id = 10

SELECT * FROM Deals WHERE GroupId = 1

SELECT * FROM Deals WHERE OwnerId = 1

SELECT * FROM Deals WHERE Stage = 1 AND Title = 'title'

As a note, due to server-side performance issues, even when the property IncludeCustomFields is set to TRUE, the custom fields will appear only in the table schema with null values. To retrieve the values of the custom fields, please refer to the DealCustomFieldData table.

Insert

Inserting a deal requires specifying a value for the GroupId, Stage, OwnerId, Title, Value, Currency columns and a value for AccountId or ContactId column.

INSERT INTO Deals (AccountId, GroupId, Stage, OwnerId, Title, Value, Currency) VALUES (1, 1, 1, 1, 'title', 100, 'USD')

INSERT INTO Deals (Email, FirstName, LastName, Phone) VALUES ('[email protected]', 'test', 'test', 'dealphonenumber')

Additionally, the Sync App supports inserting deal and deal custom fields data from the Deals table. All custom field columns start with CF_.

INSERT INTO Deals (AccountId, GroupId, Stage, OwnerId, Title, Value, Currency, CF_CustomField1, CF_CustomField2, CF_CustomField3) VALUES (1, 1, 1, 1, 'title', 100, 'USD', 'value', 'value', 'value')

Update

The Sync App supports updating deal information.

Additionally, it is possible to update deal custom fields data from the Deals table.

UPDATE Deals SET Title = 'updatedTitle' WHERE Id = 1

UPDATE Deals SET CF_CustomField1 = 'custom field value', CF_CustomField2 = 'custom field value' WHERE Id = 1

Delete

Remove all deals or a deal by specifying the Id of the deal.

DELETE FROM Deals

DELETE FROM Deals WHERE Id = 10003

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id column of the Deals table.
AccountId	String	False	The AccountId column of the Deals table.
ActivityCount	String	True	The ActivityCount column of the Deals table.
Cdate	Datetime	True	The Cdate column of the Deals table.
ContactId	String	False	Deal's primary contact's Id.
Currency	String	False	Deal's currency in 3-digit ISO format, lowercased.
CustomerAccount	String	True	The CustomerAccount column of the Deals table.
Description	String	False	The Description column of the Deals table.
Edate	String	True	The Edate column of the Deals table.
Group	String	False	Deal's pipeline Id. Required if deal.stage is not provided. If deal.group is not provided, the stage's pipeline will be assigned to the deal automatically.
Hash	String	True	The Hash column of the Deals table.
IsDisabled	String	True	The IsDisabled column of the Deals table.
AccountLink	String	True	The AccountLink column of the Deals table.
ContactLink	String	True	The ContactLink column of the Deals table.
ContactDealsLink	String	True	The ContactDealsLink column of the Deals table.
CustomerAccountLink	String	True	The CustomerAccountLink column of the Deals table.
DealActivitiesLink	String	True	The DealActivitiesLink column of the Deals table.
DealCustomFieldDataLink	String	True	The DealCustomFieldDataLink column of the Deals table.
GroupLink	String	True	The GroupLink column of the Deals table.
NextTaskLink	String	True	The NextTaskLink column of the Deals table.
NotesLink	String	True	The NotesLink column of the Deals table.
OrganizationLink	String	True	The OrganizationLink column of the Deals table.
OwnerLink	String	True	The OwnerLink column of the Deals table.
ScoreValuesLink	String	True	The ScoreValuesLink column of the Deals table.
StageLink	String	True	The StageLink column of the Deals table.
TasksLink	String	True	The TasksLink column of the Deals table.
Mdate	Datetime	True	The Mdate column of the Deals table.
NextTask	String	True	The NextTask column of the Deals table.
NextDate	Datetime	True	The NextDate column of the Deals table.
NextDealId	String	True	The NextDealId column of the Deals table.
NextTaskId	String	True	The NextTaskId column of the Deals table.
Organization	String	True	The Organization column of the Deals table.
Owner	String	False	Deal's owner Id. Required if pipeline's auto-assign option is disabled.
Percent	String	False	The Percent column of the Deals table.
Stage	String	False	Deal's stage Id. Required if deal.group is not provided. If deal.stage is not provided, the deal will be assigned with the first stage in the pipeline provided in deal.group.
Status	String	False	The Status column of the Deals table.
Title	String	False	The Title column of the Deals table.
Value	String	False	Deal's value in cents.
WinProbability	Integer	True	The WinProbability column of the Deals table.
WinProbabilityMdate	Datetime	True	The WinProbabilityMdate column of the Deals table.

Usage information for the operation DealStages.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM DealStages WHERE Id = 10003

SELECT * FROM DealStages WHERE Title = 'title' AND GroupId = 1

Insert

Inserting a stage requires specifying a value for the GroupId, Title columns.

INSERT INTO DealStages (GroupId, Title) VALUES (2, 'title')

INSERT INTO DealStages (Title, GroupId, OrderId, CardRegion3, Color, Width) VALUES ('TestStage', 1, 2, 'hide-avatar', '434343', '280')

Update

The Sync App supports updating stage/dealstage information.

UPDATE DealStages SET Title = 'updatedTitle' WHERE Id = 1

Delete

Remove all stages or a stage by specifying the Id of the stage.

DELETE FROM DealStages WHERE Id = 10003

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id column of the DealStages table.
CardRegion1	String	False	The CardRegion1 column of the DealStages table. Indicates what to show in upper-left corner of Deal Cards.
CardRegion2	String	False	The CardRegion2 column of the DealStages table. Indicates what to show in upper-right corner of Deal Cards.
CardRegion3	String	False	The CardRegion3 column of the DealStages table. Indicates whether to show the avatar in Deal Cards. Can be one of show-avatar and hide-avatar. If set to show-avatar, deal cards will show the avatars. If set to hide-avatar, deal cards will hide the avatars.
CardRegion4	String	False	The CardRegion4 column of the DealStages table. Indicates what to show next to the avatar in Deal Cards.
CardRegion5	String	False	The CardRegion5 column of the DealStages table. Indicates what to show in lower-right corner of Deal Cards.
Cdate	Datetime	True	The Cdate column of the DealStages table.
Color	String	False	Deal Stage's color. 6-character HEX color code without the hashtag. e.g. 434343 to assign the hex color value #434343.
DealOrder	String	False	Option and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either.
GroupId	String	False	The GroupId column of the DealStages table.
GroupLink	String	True	The GroupLink column of the DealStages table.
OrderId	String	False	The OrderId column of the DealStages table.
Title	String	False	The Title column of the DealStages table.
Udate	Datetime	True	The Udate column of the DealStages table.
Width	String	False	Deal stage's width in pixels, without px unit.

Lists all existing accounts.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Tasks WHERE Id = 10003

SELECT * FROM Tasks WHERE DealTaskType = 1 

SELECT * FROM Tasks WHERE DueDate >= '2019-06-30T10:44:34-05:00'

SELECT * FROM Tasks WHERE DueDate <= '2021-06-30T10:44:34-05:00'

SELECT * FROM Tasks WHERE OutcomeId = 1 AND RelId = 1 AND Status = 1

Insert

Inserting a stage requires specifying a value for the DealTaskType, DueDate, Relid columns.

INSERT INTO Tasks (DealTaskType, DueDate, Relid) VALUES (2, '2021-06-30T10:44:34-05:00', 7)

Update

The Sync App supports updating stage/dealstage information.

UPDATE Tasks SET Title = 'updatedTitle' WHERE Id = 1

Delete

Remove all stages or a stage by specifying the Id of the stage.

DELETE FROM Tasks WHERE Id = 10003

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id column of the Tasks table.
Assignee	String	False	The Assignee column of the Tasks table.
Automation	String	True	The Automation column of the Tasks table.
Cdate	Datetime	True	The Cdate column of the Tasks table.
DealTaskType	String	False	The type of the task based on the available Task Types in the account.
DoneAutomation	String	False	The DoneAutomation column of the Tasks table.
DueDate	Datetime	False	Due date of the task.
Edate	Datetime	True	The Edate column of the Tasks table.
ActivitiesLink	String	True	The ActivitiesLink column of the Tasks table.
AssigneeLink	String	True	The AssigneeLink column of the Tasks table.
AutomationLink	String	True	The AutomationLink column of the Tasks table.
DealTasktypeLink	String	True	The DealTasktypeLink column of the Tasks table.
DoneAutomationLink	String	True	The DoneAutomationLink column of the Tasks table.
NotesLink	String	True	The NotesLink column of the Tasks table.
OwnerLink	String	True	The OwnerLink column of the Tasks table.
TaskNotificationsLink	String	True	The TaskNotificationsLink column of the Tasks table.
UserLink	String	True	The UserLink column of the Tasks table.
Note	String	False	The content describing the task.
OutcomeId	Integer	False	The OutcomeId column of the Tasks table.
OutcomeInfo	String	False	The OutcomeInfo column of the Tasks table.
OwnerId	String	True	The OwnerId column of the Tasks table.
OwnerType	String	False	The name of the relating object. Valid values are contact or deal.
Relid	String	False	The Id of the relational object for this task.
Reltype	String	True	The Reltype column of the Tasks table.
Status	Integer	False	The Status column of the Tasks table. 1 is complete and 0 is incomplete..
Title	String	False	The Title column of the Tasks table.
Udate	Datetime	True	The Udate column of the Tasks table.
User	String	True	The User column of the Tasks table.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

ActiveCampaign Connector for CData Sync Views

Name	Description
Addresses	Usage information for the operation Addresses.rsd.
Automations	Usage information for the operation Automations.rsd.
Campaigns	Query the campaigns information in ActiveCampaign.
ContactAutomations	View many or all contacts by including their ID's or various filters.
ContactLists	Retrieve ContactList for each contact Group or for the specific Contact group.
ContactTags	Retrieve tags added for each contact or for the specific Contact Id
DealActivities	Retrieve Deal Activities for each Deal or for the specific Deal Id.
Lists	Usage information for the operation Lists.rsd.
Scores	View many or all contacts by including their ID's or various filters.
Tags	View many or all tags by including their ID's or various filters.
TrackingLogs	Retrieve trackingLogs for the specific contact or all contacts
Users	Usage information for the operation Users.rsd.

Usage information for the operation Addresses.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM AccountContacts WHERE Id = 10003

Columns

Name	Type	Description
Id	String	The Id column of the Addresses table.
Address1	String	The Address1 column of the Addresses table.
Address2	String	The Address2 column of the Addresses table.
Allgroup	String	The Allgroup column of the Addresses table.
City	String	The City column of the Addresses table.
CompanyName	String	The CompanyName column of the Addresses table.
Country	String	The Country column of the Addresses table.
District	String	The District column of the Addresses table.
isDefault	String	The isDefault column of the Addresses table.
AddressGroupLink	String	The AddressGroupLink column of the Addresses table.
AddressListLink	String	The AddressListLink column of the Addresses table.
FormsLink	String	The FormsLink column of the Addresses table.
State	String	The State column of the Addresses table.
Zip	String	The Zip column of the Addresses table.

Usage information for the operation Automations.rsd.

Columns

Name	Type	Description
Id	String	The Id column of the Automations table.
Cdate	Datetime	The Cdate column of the Automations table.
DefaultScreenshot	String	The DefaultScreenshot column of the Automations table.
Entered	String	The Entered column of the Automations table.
Exited	String	The Exited column of the Automations table.
Hidden	String	The Hidden column of the Automations table.
BlocksLink	String	The BlocksLink column of the Automations table.
CampaignsLink	String	The CampaignsLink column of the Automations table.
ContactAutomationsLink	String	The ContactAutomationsLink column of the Automations table.
ContactGoalsLink	String	The ContactGoalsLink column of the Automations table.
GoalsLink	String	The GoalsLink column of the Automations table.
SiteMessagesLink	String	The SiteMessagesLink column of the Automations table.
SmsLink	String	The SmsLink column of the Automations table.
Mdate	Datetime	The Mdate column of the Automations table.
Name	String	The Name column of the Automations table.
Screenshot	String	The Screenshot column of the Automations table.
Status	String	The Status column of the Automations table.
UserId	String	The UserId column of the Automations table.

Query the campaigns information in ActiveCampaign.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM Campaigns WHERE Id = 10003

Columns

Name	Type	Description
Id [KEY]	String	The Id column of the Campaigns table.
ActiveRssInterval	String	The ActiveRssInterval column of the Campaigns table.
ActiveRssItems	String	The ActiveRssItems column of the Campaigns table.
ActiveRssUrl	String	The ActiveRssUrl column of the Campaigns table.
AddressId	String	The AddressId column of the Campaigns table.
AnalyticsCampaignName	String	The AnalyticsCampaignName column of the Campaigns table.
Automation	String	The Automation column of the Campaigns table.
BaseMessageId	String	The BaseMessageId column of the Campaigns table.
BaseTemplateId	String	The BaseTemplateId column of the Campaigns table.
BounceId	String	The BounceId column of the Campaigns table.
CanSkipApproval	String	The can_skip_approval column of the Campaigns table.
Cdate	Datetime	The Cdate column of the Campaigns table.
CreatedBy	String	The Created By column of the Campaigns table.
CreatedTimestamp	Datetime	The Created Timestamp column of the Campaigns table.
DeleteStamp	String	The DeleteStamp column of the Campaigns table.
EmbedImages	String	The EmbedImages column of the Campaigns table.
Facebook	String	The Facebook column of the Campaigns table.
FormId	String	The FormId column of the Campaigns table.
Forwards	String	The Forwards column of the Campaigns table.
HardBounces	String	The HardBounces column of the Campaigns table.
HasPredictiveContent	Bit	The HasPredictiveContent column of the Campaigns table.
HtmlUnsub	String	The HtmlUnsub column of the Campaigns table.
HtmlUnsubdata	String	The HtmlUnsubdata column of the Campaigns table.
Ip	String	The Ip column of the Campaigns table.
Ip4	String	The Ip4 column of the Campaigns table.
LastStep	String	The LastStep column of the Campaigns table.
Ldate	String	The Ldate column of the Campaigns table.
LinkClicks	String	The LinkClicks column of the Campaigns table.
AutomationLink	String	The AutomationLink column of the Campaigns table.
CampaignAggregateRevenuesLink	String	The AggregateRevenues column of the Campaigns table.
CampaignListsLink	String	The CampaignListsLink column of the Campaigns table.
CampaignMessageLink	String	The CampaignMessageLink column of the Campaigns table.
CampaignMessagesLink	String	The CampaignMessagesLink column of the Campaigns table.
LinksLink	String	The LinksLink column of the Campaigns table.
LinksSegment	String	The Segment column of the Campaigns table.
UserLink	String	The UserLink column of the Campaigns table.
MailCleanup	String	The MailCleanup column of the Campaigns table.
MailSend	String	The MailSend column of the Campaigns table.
MailTransfer	String	The MailTransfer column of the Campaigns table.
MailerLogFile	String	The MailerLogFile column of the Campaigns table.
ManageText	String	The ManageText column of the Campaigns table.
Mdate	Datetime	The Mdate column of the Campaigns table.
Name	String	The Name column of the Campaigns table.
Opens	String	The Opens column of the Campaigns table.
Public	String	The Public column of the Campaigns table.
RealCid	String	The RealCid column of the Campaigns table.
Recurring	String	The Recurring column of the Campaigns table.
ReminderField	String	The ReminderField column of the Campaigns table.
ReminderFormat	String	The ReminderFormat column of the Campaigns table.
ReminderLastCronRun	String	The ReminderLastCronRun column of the Campaigns table.
ReminderOffset	String	The ReminderOffset column of the Campaigns table.
ReminderOffsetSign	String	The ReminderOffsetSign column of the Campaigns table.
ReminderOffsetType	String	The ReminderOffsetType column of the Campaigns table.
ReminderType	String	The ReminderType column of the Campaigns table.
Replies	String	The Replies column of the Campaigns table.
ReplySys	String	The ReplySys column of the Campaigns table.
ResponderExisting	String	The ResponderExisting column of the Campaigns table.
ResponderOffset	String	The ResponderOffset column of the Campaigns table.
ResponderType	String	The ResponderType column of the Campaigns table.
Schedule	String	The Schedule column of the Campaigns table.
ScheduledDate	String	The ScheduledDate column of the Campaigns table.
Screenshot	String	The Screenshot column of the Campaigns table.
Sdate	String	The Sdate column of the Campaigns table.
SegmentId	String	The SegmentId column of the Campaigns table.
SegmentName	String	The SegmentName column of the Campaigns table.
SendAmt	String	The SendAmt column of the Campaigns table.
SendId	String	The SendId column of the Campaigns table.
SeriesId	String	The SeriesId column of the Campaigns table.
Series Send Lock Time	String	The SeriesSendLockTime column of the Campaigns table.
SocialShares	String	The SocialShares column of the Campaigns table.
SoftBounces	String	The SoftBounces column of the Campaigns table.
Source	String	The Source column of the Campaigns table.
SplitContent	String	The SplitContent column of the Campaigns table.
SplitOffset	String	The SplitOffset column of the Campaigns table.
SplitOffsetType	String	The SplitOffsetType column of the Campaigns table.
SplitType	String	The SplitType column of the Campaigns table.
SplitWinnerAwaiting	String	The SplitWinnerAwaiting column of the Campaigns table.
SplitWinnerMessageId	String	The SplitWinnerMessageId column of the Campaigns table.
Status	String	The Status column of the Campaigns table.
SubscriberClicks	String	The SubscriberClicks column of the Campaigns table.
Survey	String	The Survey column of the Campaigns table.
TextUnsub	String	The TextUnsub column of the Campaigns table.
TextUnsubData	String	The TextUnsubData column of the Campaigns table.
ThreadId	String	The ThreadId column of the Campaigns table.
TotalAmt	String	The TotalAmt column of the Campaigns table.
TrackLinks	String	The TrackLinks column of the Campaigns table.
TrackLinksAnalytics	String	The TrackLinksAnalytics column of the Campaigns table.
TrackReads	String	The TrackReads column of the Campaigns table.
TrackReadsAnalytics	String	The TrackReadsAnalytics column of the Campaigns table.
Tweet	String	The Tweet column of the Campaigns table.
Type	String	The Type column of the Campaigns table.
UniqueForwards	String	The UniqueForwards column of the Campaigns table.
UniqueLinkClicks	String	The UniqueLinkClicks column of the Campaigns table.
UniqueOpens	String	The UniqueOpens column of the Campaigns table.
UniqueReplies	String	The UniqueReplies column of the Campaigns table.
UnsubReasons	String	The UnsubReasons column of the Campaigns table.
Unsubscribes	String	The Unsubscribes column of the Campaigns table.
Updated By	String	The UpdatedBy column of the Campaigns table.
Updated Timestamp	String	The UpdatedTimestamp column of the Campaigns table.
Updates	String	The Updates column of the Campaigns table.
User	String	The User column of the Campaigns table.
UserId	String	The UserId column of the Campaigns table.
WaitPreview	String	The WaitPreview column of the Campaigns table.
WillRecur	String	The WillRecur column of the Campaigns table.

View many or all contacts by including their ID's or various filters.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM ContactAutomations WHERE Id = 10003

Columns

Name	Type	Description
Id	String	The Id column of the ContactAutomations table.
Adddate	Datetime	The Adddate column of the ContactAutomations table.
Automation	String	The Automation column of the ContactAutomations table.
Batchid	Unknown	The Batchid column of the ContactAutomations table.
CompleteValue	Integer	The CompleteValue column of the ContactAutomations table.
Completed	Integer	The Completed column of the ContactAutomations table.
CompletedElements	String	The CompletedElements column of the ContactAutomations table.
ContactId	String	The ContactId column of the ContactAutomations table.
Lastblock	String	The Lastblock column of the ContactAutomations table.
Lastdate	Datetime	The Lastdate column of the ContactAutomations table.
LastLogId	String	The LastLogId column of the ContactAutomations table.
AutomationLink	String	The AutomationLink column of the ContactAutomations table.
ContactLink	String	The ContactLink column of the ContactAutomations table.
ContactGoalsLink	String	The ContactGoalsLink column of the ContactAutomations table.
Remdate	Datetime	The Remdate column of the ContactAutomations table.
SeriesId	String	The SeriesId column of the ContactAutomations table.
StartId	String	The StartId column of the ContactAutomations table.
Status	String	The Status column of the ContactAutomations table.
TimeSpan	String	The TimeSpan column of the ContactAutomations table.
TotalElements	String	The TotalElements column of the ContactAutomations table.

Retrieve ContactList for each contact Group or for the specific Contact group.

Table Specific Information

Select

Retrieving information from ContactLists requires specifying a ContactId.

SELECT * FROM ContactLists WHERE ContactId = 1000

Columns

Name	Type	Description
Id [KEY]	String	The Id column of the ContactLists table.
ContactId	String	The ContactId column of the ContactLists table.
AutomationId	String	The AutomationId column of the ContactLists table.
AutosyncLog	String	The AutosyncLog column of the ContactLists table.
Campaign	String	The Campaign column of the ContactLists table.
CreatedBy	String	The CreatedBy column of the ContactLists table.
CreatedTimestamp	Datetime	The CreatedTimestamp column of the ContactLists table.
FirstName	String	The FirstName column of the ContactLists table.
Form	String	The Form column of the ContactLists table.
Ip4Sub	String	The Ip4Sub column of the ContactLists table.
Ip4Unsub	String	The Ip4Unsub column of the ContactLists table.
Ip4Last	String	The Ip4Last column of the ContactLists table.
LastName	String	The LastName column of the ContactLists table.
AutomationLink	String	The AutomationLink column of the ContactLists table.
AutosyncLogLink	String	The AutosyncLogLink column of the ContactLists table.
CampaignLink	String	The CampaignLink column of the ContactLists table.
ContactLink	String	The ContactLink column of the ContactLists table.
FormLink	String	The FormLink column of the ContactLists table.
ListLink	String	The ListLink column of the ContactLists table.
MessageLink	String	The MessageLink column of the ContactLists table.
UnsubscribeAutomationLink	String	The UnsubscribeAutomationLink column of the ContactLists table.
ListId	String	The ListId column of the ContactLists table.
Message	String	The Message column of the ContactLists table.
Responder	String	The Responder column of the ContactLists table.
Sdate	Datetime	The Sdate column of the ContactLists table.
SeriesId	String	The SeriesId column of the ContactLists table.
Status	String	The Status column of the ContactLists table.
SourceId	String	The SourceId column of the ContactLists table.
Sync	String	The Sync column of the ContactLists table.
Unsubreason	String	The Unsubreason column of the ContactLists table.
UnsubscribeAutomation	String	The UnsubscribeAutomation column of the ContactLists table.
UpdatedBy	String	The UpdatedBy column of the ContactLists table.
UpdatedTimestamp	Datetime	The UpdatedTimestamp column of the ContactLists table.

Retrieve tags added for each contact or for the specific Contact Id

Table Specific Information

Select

Retrieving information for ContactTags requires specifying a ContactId.

SELECT * FROM ContactTags WHERE ContactId = 1

Columns

Name	Type	Description
Id [KEY]	String	The Id column of the ContactTags table.
ContactId	String	The ContactId column of the ContactTags table.
Cdate	Datetime	The Cdate column of the ContactTags table.
CreatedBy	String	The CreatedBy column of the ContactTags table.
CreatedTimestamp	Datetime	The CreatedTimestamp column of the ContactTags table.
ContactLink	String	The ContactLink column of the ContactTags table.
TagLink	String	The TagLink column of the ContactTags table.
Tag	String	The Tag column of the ContactTags table.
UpdatedBy	String	The UpdatedBy column of the ContactTags table.
UpdatedTimestamp	Datetime	The UpdatedTimestamp column of the ContactTags table.

Retrieve Deal Activities for each Deal or for the specific Deal Id.

Columns

Name	Type	Description
Id [KEY]	String	The Id of the activity.
DealId	String	The Id of the Deal to which the activity belongs to.
StageId	String	The Id of the Stage to which the parent Deal of the activity belongs to.
UserId	String	The Id of the User which triggered the activity.
DataId	String	The Id for the related object (e.g. a Task or Note or similar), if relevant.
DataType	String	The type of the activity. Examples include 'userid' or 'subscriberid' or 'task' or 'note' or empty quotes ('') for the deal's initial creation.
DataAction	String	The action taken by this activity. Examples include 'add' or 'complete' or the new value ('100') if the value is changing.
DataOldVal	String	The previous value, if the value has changed (see DataAction); otherwise, empty quotes ('')
CreatedDate	Datetime	The creation date of the activity.
SortDate	Datetime
IsAddTask	Boolean	Indicates whether the activity was adding a task to the deal.
Deleted	Boolean	Indicates whethere the activity was deleted or not.
SeriesId	String
DealLink	String	The API endpoint to the Deal related to this activity.
StageLink	String	The API endpoint to the Stage related to this activity.
UserLink	String	The API endpoint to the User related to this activity.
AutomationLink	String	The API endpoint to the Automation related to this activity.
ActivityLink	String	The API endpoint to the Activity.
Deal	String	The related to this Activity.
Stage	String	The Stage column of the DealActivities table.
User	String	The User column of the DealActivities table.
Automation	String	The Automation which triggered this activity.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Exclude	String	Include this param to exclude 'email', 'connection_email', and 'LinkData' activity types. The allowed values are email.

Usage information for the operation Lists.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following queries are processed server side:

SELECT * FROM Lists WHERE Id = 1

SELECT * FROM Lists WHERE Name = 'list1'

In addition the Sync App supports retrieving information about members of lists in your account by supporting them dynamically as VIEWS. Selecting from a dynamic list will return information about all the contacts that are members of that list. Lists names always start with "List_".

Columns

Name	Type	Description
Id [KEY]	String	The Id column of the Lists table.
AnalyticsDomains	String	The AnalyticsDomains column of the Lists table.
AnalyticsSource	String	The AnalyticsSource column of the Lists table.
AnalyticsUa	String	The AnalyticsUa column of the Lists table.
CarbonCopy	String	The CarbonCopy column of the Lists table.
Cdate	Datetime	The Cdate column of the Lists table.
Udate	Datetime	The Udate column of the Lists table.
DeleteStamp	String	The DeleteStamp column of the Lists table.
FacebookSession	String	The FacebookSession column of the Lists table.
FullAddress	String	The FullAddress column of the Lists table.
UnsubscribeReason	String	The UnsubscribeReason column of the Lists table.
AddressListsLink	String	The AddressListsLink column of the Lists table.
ContactGoalListsLink	String	The ContactGoalListsLink column of the Lists table.
UserLink	String	The UserLink column of the Lists table.
Name	String	The Name column of the Lists table.
OptinMessageId	String	The OptinMessageId column of the Lists table.
OptinOptout	String	The OptinOptout column of the Lists table.
OptoutConf	String	The OptoutConf column of the Lists table.
EmbedImage	String	The EmbedImage column of the Lists table.
UseAnalyticsLink	String	The UseAnalyticsLink column of the Lists table.
UseAnalyticsRead	String	The UseAnalyticsRead column of the Lists table.
UseCaptcha	String	The UseCaptcha column of the Lists table.
UseFacebook	String	The UseFacebook column of the Lists table.
UseTracking	String	The UseTracking column of the Lists table.
UseTwitter	String	The UseTwitter column of the Lists table.
Private	String	The Private column of the Lists table.
RequireName	String	The RequireName column of the Lists table.
SendLastBroadcast	String	The SendLastBroadcast column of the Lists table.
SenderAddr1	String	The SenderAddr1 column of the Lists table.
SenderAddr2	String	The SenderAddr2 column of the Lists table.
SenderCity	String	The SenderCity column of the Lists table.
SenderCountry	String	The SenderCountry column of the Lists table.
SenderName	String	The SenderName column of the Lists table.
SenderPhone	String	The SenderPhone column of the Lists table.
SenderReminder	String	The SenderReminder column of the Lists table.
SenderState	String	The SenderState column of the Lists table.
SenderUrl	String	The SenderUrl column of the Lists table.
SenderZip	String	The SenderZip column of the Lists table.
StringId	String	The StringId column of the Lists table.
SubscriptionNotify	String	The SubscriptionNotify column of the Lists table.
ToName	String	The ToName column of the Lists table.
TwitterToken	String	The TwitterToken column of the Lists table.
TwitterTokenSecret	String	The TwitterTokenSecret column of the Lists table.
UnsubscriptionNotify	String	The UnsubscriptionNotify column of the Lists table.
ListsUser	String	The ListsUser column of the Lists table.
ListsUserid	String	The ListsUserid column of the Lists table.

View many or all contacts by including their ID's or various filters.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM Scores WHERE Id = 10

Columns

Name	Type	Description
Id	String	The Id column of the Scores table.
Cdate	Datetime	The Cdate column of the Scores table.
Descript	String	The Descript column of the Scores table.
Mdate	Datetime	The Mdate column of the Scores table.
Name	String	The Name column of the Scores table.
RelType	String	The RelType column of the Scores table.
Status	String	The Status column of the Scores table.

View many or all tags by including their ID's or various filters.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM Tags WHERE Id = 10003

Columns

Name	Type	Description
Id [KEY]	String	The Id column of the Tags table.
Tag	String	The Tag column of the Tags table.
TagType	String	The TagType column of the Tags table.
Description	String	The Description column of the Tags table.
Cdate	Datetime	The Cdate column of the Tags table.
ContactGoalTagsLink	String	The ContactGoalTagsLink column of the Tags table.

Retrieve trackingLogs for the specific contact or all contacts

Columns

Name	Type	Description
Id [KEY]	String	The Id column of the TrackingLogs table.
ContactId	String	The ContactId column of the TrackingLogs table.
Hash	String	The Hash column of the TrackingLogs table.
ContactLink	String	The ContactLink column of the TrackingLogs table.
SubscriberidLink	String	The SubscriberidLink column of the TrackingLogs table.
TstampLink	Datetime	The TstampLink column of the TrackingLogs table.
TypeLink	String	The TypeLink column of the TrackingLogs table.
ValueLink	String	The ValueLink column of the TrackingLogs table.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
UDateLink	Datetime

Usage information for the operation Users.rsd.

Table Specific Information

Select

The Sync App uses the ActiveCampaign API to process some of the filters.

For example, the following query is processed server side:

SELECT * FROM Users WHERE Id = 10003

Columns

Name	Type	Description
Id	String	The Id column of the Users table.
Email	String	The Email column of the Users table.
FirstName	String	The FirstName column of the Users table.
LastName	String	The LastName column of the Users table.
ConfigsLink	String	The ConfigsLinks column of the Users table.
DealGroupTotalsLink	String	The DealGroupTotalsLink column of the Users table.
DealGroupUsersLink	String	The DealGroupUsersLink column of the Users table.
ListsLink	String	The ListsLink column of the Users table.
UserGroupLink	String	The UserGroupLink column of the Users table.
Phone	Unknown	The Phone column of the Users table.
Signature	Unknown	The Signature column of the Users table.
Username	String	The Username column of the Users table.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
APIKey	The APIKey obtained from the ActiveCampaign UI.
URL	Base URL which is used to access the API.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from ActiveCampaign.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
APIKey	The APIKey obtained from the ActiveCampaign UI.
URL	Base URL which is used to access the API.

The APIKey obtained from the ActiveCampaign UI.

Remarks

API key can be found in your account on the Settings page under the "Developer" tab. Each user in your ActiveCampaign account has their own unique API key.

Base URL which is used to access the API.

Remarks

URL can be found in your account on the My Settings page under the "Developer" tab. For example: https://{yourAccountName}.api-us1.com

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to ActiveCampaign and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\ActiveCampaign Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from ActiveCampaign.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

The maximum number of results to return per page from ActiveCampaign.

Remarks

The Pagesize property affects the maximum number of results to return per page from ActiveCampaign. ActiveCampaign allows a maximum of 100 records to be returned in each page.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Contacts WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.