With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our ActiveCampaign Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Installing and Connecting

If you have PSGet, installing the cmdlets can be accomplished from the PowerShell Gallery with the following command. You can also obtain a setup from the CData site.

Install-Module ActiveCampaignCmdlets

The following line is then added to your profile, loading the cmdlets on the next session:

Import-Module ActiveCampaignCmdlets;

You can then use the Connect-ActiveCampaign cmdlet to create a connection object that can be passed to other cmdlets:

$conn = Connect-ActiveCampaign -URL "yourURL" -APIKEY "yourApiKey"

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.

Retrieving Data

The Select-ActiveCampaign cmdlet provides a native PowerShell interface for retrieving data:

$results = Select-ActiveCampaign -Connection $conn -Table "Contacts" -Columns @("LastName, Email") -Where "FirstName='Bob'"

The Invoke-ActiveCampaign cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file:

Select-ActiveCampaign -Connection $conn -Table Contacts -Where "FirstName = 'Bob'" | 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 object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON:

 
PS C:\> $conn  = Connect-ActiveCampaign -URL "yourURL" -APIKEY "yourApiKey"
PS C:\> $row = Select-ActiveCampaign -Connection $conn -Table "Contacts" -Columns (LastName, Email) -Where "FirstName = 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Contacts",
  "Columns":  [

  ],
  "LastName":  "MyLastName",
  "Email":  "MyEmail"
} 

Deleting Data

The following line deletes any records that match the criteria:

Select-ActiveCampaign -Connection $conn -Table Contacts -Where "FirstName = 'Bob'" | Remove-ActiveCampaign

Modifying 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 $conn -Table Contacts -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-ActiveCampaign -Connection $conn -Table Contacts -Columns @("LastName","Email") -Values @($_.LastName, $_.Email) -Where "Id  = `'$_.Id`'"
  }else{
    Add-ActiveCampaign -Connection $conn -Table Contacts -Columns @("LastName","Email") -Values @($_.LastName, $_.Email)
  }
}