API Data Provider - Online Help

Connecting to CampaignMonitor

To authenticate to CampaignMonitor, you can use either Token authentication or the OAuth standard. Use Token to connect to your own data. Use OAuth to allow other users to connect to their data.

Using Token Authentication

To use Token Authentication, set the API Key to your CampaignMonitor API Key in the ProfileSettings connection property.

Example connection string

Profile=C:\profiles\CampaignMonitor.apip;ProfileSettings='APIKey=my_api_key';

Using OAuth Authentication

First you need to register an OAuth app with CampaignMonitor. To do this, log into your Campaign Monitor account, click App store in the top navigation (you may need to select a client first to see the option), then select OAuth Registration in the right sidebar. From there you will be asked for a few details to register your OAuth app.

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to OAuth.
  • OAuthClientId: Set this to the Client Id of your app.
  • OAuthClientSecret: Set this to the Client Secret of your app.
  • CallbackURL: Set this to the Redirect URI you specified when applied for an app with CampaignMonitor.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.

Example connection string

Profile=C:\profiles\CampaignMonitor.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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.


Property Description
APIKey Your Campaign Monitor API Key.
AuthScheme The scheme used for authentication. Accepted entries are None or OAuth.
Allowed values are: BASIC, NONE, NTLM, OAUTH, OAUTH_CLIENT
CallbackURL The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Allowed values are: OFF, GETANDREFRESH, REFRESH
OAuthClientId The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060.0