Connecting to Campaigner

Campaigner uses token authentication to control access to the API.

Using Token Authentication

In order to authenticate to Campaigner, you'll need to provide your API Key. An API key can be obtained by signing in to your account, and then going to Account Settings > Users > Create New User > At User Role choose API User > Save. An Api Key will be created for the API user. Set the API Key in the ProfileSettings property to connect.

Example connection string

Profile=C:\profiles\Campaigner.apip;ProfileSettings='APIKey=your_api_key';

Connection Properties

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.