Connecting to ReplyIO

The Reply.io API uses API Key authentication via the x-api-key request header.

Using API Key Authentication

Your Reply.io API key is required to create a connection. To obtain your API key:

1. Log into your Reply.io account.
2. Click your profile icon and select Settings.
3. Navigate to the API section.
4. Copy your API Key.

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Reply.io API key.
• UserEmail (optional): Set this to the email address of the Reply.io user on whose behalf requests are made.

Example connection string:

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

Usage Examples

BillingInfo:

SELECT * FROM BillingInfo

Blacklists:

SELECT * FROM Blacklists

CampaignClickStatistics:

SELECT * FROM CampaignClickStatistics WHERE CampaignId = 12345

Campaigns:

SELECT * FROM Campaigns

CampaignStatistics:

SELECT * FROM CampaignStatistics WHERE CampaignId = 12345

CampaignSteps:

SELECT * FROM CampaignSteps WHERE CampaignId = 12345

CampaignStepStatistics:

SELECT * FROM CampaignStepStatistics WHERE CampaignId = 12345 AND StepId = 1

ContactCampaigns:

SELECT * FROM ContactCampaigns WHERE ContactId = 987654

Contacts:

SELECT * FROM Contacts

ContactStatistics:

SELECT * FROM ContactStatistics WHERE Email = '[email protected]'

ContactStatusInCampaign:

SELECT * FROM ContactStatusInCampaign WHERE Email = '[email protected]'

CustomFields:

SELECT * FROM CustomFields

EmailAccounts:

SELECT * FROM EmailAccounts

EmailContent:

SELECT * FROM EmailContent WHERE EmailMessageId = 'msg_abc123'

ListContacts:

SELECT * FROM ListContacts WHERE ListId = 42

Lists:

SELECT * FROM Lists

ProspectStatusChanges:

SELECT * FROM ProspectStatusChanges WHERE TeamId = 12345 AND FromDate = '2024-01-01' AND ToDate = '2024-01-03'

Schedules:

SELECT * FROM Schedules

SharedPageUrl:

SELECT * FROM SharedPageUrl

Templates:

SELECT * FROM Templates

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	The API Key from Reply.io. You can obtain your API Key from your Reply.io account settings under the API section.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT
UserEmail	The Email address of the API Key owner.