How to pipe ActiveCampaign Data to CSV in PowerShell

The CData Cmdlets Module for ActiveCampaign is a standard PowerShell module offering straightforward integration with ActiveCampaign. Below, you will find examples of using our ActiveCampaign Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your ActiveCampaign Data

ActiveCampaign supports authenticating with the API Key. To connect to ActiveCampaign, set the following:

• URL: This can be found in your account on the My Settings page under the Developer tab. For example: https://{yourAccountName}.api-us1.com
• APIKey: This 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.

$conn = Connect-ActiveCampaign  -URL "$URL" -APIKey "$APIKey"

Selecting Data

Follow the steps below to retrieve data from the Contacts table and pipe the result into to a CSV file:

Select-ActiveCampaign -Connection $conn -Table Contacts | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myContactsData.csv -NoTypeInformation

You will notice that we piped the results from Select-ActiveCampaign into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

Deleting Data

The following line deletes any records that match the criteria:

Select-ActiveCampaign -Connection $conn -Table Contacts -Where "LastName = Smith" | Remove-ActiveCampaign

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into ActiveCampaign, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyContactsUpdates.csv | %{
  $record = Select-ActiveCampaign -Connection $ActiveCampaign -Table Contacts -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-ActiveCampaign -Connection $activecampaign -Table Contacts -Columns ("LastName","Email") -Values ($_.LastName, $_.Email) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-ActiveCampaign -Connection $activecampaign -Table Contacts -Columns ("LastName","Email") -Values ($_.LastName, $_.Email)
  }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!