Send data to Campaign Monitor¶
Campaign Monitor is an email marketing platform that tracks details related to email campaigns (opens, clicks, bounces, unsubscribes, spam complaints, and recipients) and email subscriber lists (active, unconfirmed, bounced, and deleted subscribers), and other details.
Note
This destination uses the Campaign Monitor Lists API .
This topic describes the steps that are required to send subscriber lists to Campaign Monitor from Amperity:
Get details¶
The Campaign Monitor destination requires the following configuration details:
The customer’s Campaign Monitor client ID.
The customer’s API key.
The name of the list.
The unsubscribe behavior preference.
The unsubscribe URL.
The confirmation URL.
How do I find Campaign Monitor account information?
You can find all of this information after you log into Campaign Monitor.
The Campaign Monitor client ID and API key is associated with your account username. Click your username, then Account settings, and then API keys. Generate an API key (if there isn’t one already), copy the API key and client ID.
The rest of this information–the master list name, the unsubscribe and confirmation URLs, and the unsubscribe preference–is under Lists & subscribers.
On the Lists & Subscribers page, click the name of the list to which Amperity will send data. This is also the master list name.
On the left side, click Settings to verify the unsubscribe options and confirmation URL.
Under Unsubscribe options, for Unsubscribe actions verify the option that is selected. If Remove subscriber from all lists is selected, set the Unsubscribe behavior option in Amperity to “AllClientLists”, otherwise choose “OnlyThisList”.
Under Unsubscribe options, for Unsubscribe link verify the configuration. You may leave the Unsubscribe URL setting in Amperity blank if Campaign Monitor is configured to add unsubscribe links automatically.
Under Subscribe options, for Subscription success page, verify the configuration. Add this value to the Subscribe URL option in Amperity.
Add destination¶
Configure Amperity to send subscriber lists directly to Campaign Monitor.
To add a destination
From the Destinations tab, click Add Destination. This opens the Add Destination dialog box.
Enter the name of the destination and a description. For example: “Campaign Monitor” and “This sends subscriber lists to Campaign Monitor”.
From the Plugin drop-down, select Campaign Monitor.
The “campaign-monitor” credential type is selected automatically.
From the Credential drop-down, select Create a new credential. This opens the Create New Credential dialog box.
Enter a name for the credential along with the API key and the client ID. Click Save.
Under Campaign Monitor Settings, enter the name of the master list, unsubscribe behavior, the unsubscribe URL, and the confirmation URL.
The master list is the name of the list to which Amperity will send data.
The unsubcribe URL is similar to: “<tenant-name>.createsend.com/t/GenericUnsubscribe”.
The confirmation URL is similar to: “<tenant-name>.createsend.com/t/Subscribed”.
The default unsubscribe behavior in Campaign Monitor is “AllClientLists”.
Select Allow customers to use this data template.
Select Allow orchestrations from users with limited PII access. (A user with limited PII access has been assigned the Restrict PII Access policy option.)
Click Save.
Add data template¶
A data template defines how columns in Amperity data structures are sent to downstream workflows. A data template is part of the configuration for sending query and segment results from Amperity to an external location.
To add a data template
![]() |
From the Destinations tab, open the menu for a destination that is configured for Campaign Monitor, and then select Add data template. This opens the Add Data Template dialog box. ![]() From the Destinations tab, open the menu for a destination that is configured for Campaign Monitor, and then select Add data template. This opens the Add Data Template dialog box. |
![]() |
Verify business user access to queries and orchestrations and access to segments and campaigns. A business user may also have restricted access to PII, which prevents them from viewing and sending customer profile data. ![]() If business user access was not configured as part of the destination, you may configure access from the data template. |
![]() |
Verify all configuration settings. |
![]() |
Review all settings, and then click Save. ![]() After you have saved the data template, and depending on how you configured it, business users can send query results to Campaign Monitor in Campaign Monitor. |
Campaign Monitor API¶
To identify the data mappings that are required to send data to Campaign Monitor, and that may need to be defined as part of a data template, refer to the following endpoints in the Campaign Monitor API.
API Endpoint |
Filename |
---|---|
active-subscriber.ndjson |
|
bounced-subscriber.ndjson |
|
deleted-subscriber.ndjson |
|
bounce.ndjson |
|
click.ndjson |
|
open.ndjson |
|
recipient.ndjson |
|
spam.ndjson |
|
unsubscribe.ndjson |
|
subscriber-list.ndjson |
|
campaign.ndjson |
|
unconfirmed-subscriber.ndjson |
|
unsubscribed-subscriber.ndjson |
|
suppression.ndjson |