API Data Provider - Online Help

Connecting to SendPulse

To authenticate to SendPulse, you can use the OAuth standard to connect to your own data or to allow other users to connect to their data.

Using OAuth Authentication

To obtain you OAuth credentials, log-in to your SendPulse Account and click on the Profile icon at the top right corner of the screen, then go to 'Account Settings' > 'API', and grab your Id (OAuthClientId) and Secret (OAuthClientSecret).

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

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • OAuthClientId: Set this to your SendPulse API Id.
  • OAuthClientSecret: Set this to your SendPulse API Secret.

Example connection string:

Profile=C:\profiles\SendPulse.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_api_id;OAuthClientSecret=your_api_secret;

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
AuthScheme The scheme used for authentication. Accepted entries are None or OAuth.
Allowed values are: NONE, OAUTH
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 23.0.8839.0