API Data Provider - Online Help

Connecting to Dotmailer

To authenticate to Dotmailer, you can use Basic Authentication.

Using Basic Authentication

In order to connect to Dotmailer, you will first need to create an API user using these steps. While logged in to your Dotdigital Engagement cloud platform, navigate to the setup screen, and select 'Access' > 'API Users' > 'New User'. For your current email address, specify a password, and make sure to check the box 'Enabled'. After saving this change, you will be able to use this account to access your Dotmailer data.

To connect, set the User and Password in the connection string. You will also need to specify the RegionId, found in the URL to your account, in the ProfileSettings connection property.

Example connection string

Profile=C:\profiles\Dotmailer.apip;User=your_api_username;Password=your_api_password;ProfileSettings='RegionId=your_regionid';

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
Password The password used to authenticate the user.
RegionId Your RegionId with Dotmailer.
User The API user account used to authenticate.

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