Connectors / Service / Campaign Monitor

Email marketing (updated: 1604942853661)

Campaign Monitor

Campaign Monitor gives you everything you need to run beautifully-designed, professional email marketing campaigns to grow your business.

Overview

Campaign Monitor is a global technology company that provides an email marketing platform which is easy to use, yet extremely powerful.

Authentication

When using the Campaign Monitor connector, the first thing you will need to do is go to your Tray.io account page, and select the workflow you wish to work on. Once in the workflow dashboard itself, search and drag the Campaign Monitor connector from the connectors panel (on the left hand side) onto your workflow.

With the new Campaign Monitor connector step highlighted, in the properties panel on the right, click on 'New Authentication' which is located under the 'Settings' heading.

add-auth

This will result in a Tray.io authentication pop-up window, that should look like this:

campaign-monitor-popup

Once you named your authentication, click on 'Next step' and make sure you set your permission scopes as appropriate. There are several scopes to choose from so make sure to scroll through to view them all.

IMPORTANT!: Please

make sure that the account you are authenticating with has the corresponding permission scopes

else this will not authenticate properly!.

campaign-monitor-auth-step-1

Once you click 'Next', you will be presented with a popup login screen for Campaign Monitor and to enter your access credentials.

campaign-monitor-auth-step-2

Once you have clicked the 'Add authentication' button, go to back to your authentication field (within the workflow dashboard properties panel from earlier), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Note on Operations usage

PLEASE NOTE: when using the 'Add person' operation you will need to have your 'CustomClient Access Number' as well.

This is created when you set your permissions/ add another person to your Client settings. While you can set your permissions here, be they "Full", "Standard" or "Pick & Choose", you CANNOT get the number here. Only create.

campaign-monitor-dashboard

In order to get the number required with the correct permissions, you need to visit the Campaign Monitor API documentation and use the permission helper, in order to get the number required.

campaign-monitor-number-1

Example usage

TRAY POTENTIAL: Tray.io is extremely flexible. By design there is no fixed way of working with it - you can pull whatever data you need from other services and work with it using our core and helper connectors. This demo which follows shows only one possible way of working with Tray.io and the Campaign Monitor connector. Once you've finished working through this example please see our Introduction to working with data and jsonpaths page and Data Guide for more details.

Below is an example of a way in which you could potentially use the Campaign Monitor connector, to create a new client and add a person to said client.

The steps will be as follows:

  1. Set up your manual trigger and your first Campaign Monitor connector to create a client.

  2. Set up your second Campaign Monitor connector to add a person to your client.

The final outcome should look like this:

campaign-monitor-complete-workflow

1 - Setup trigger & Create client

Once you have clicked 'Create new workflow' on your main Tray.io dashboard (and named said new workflow), select the Manual trigger from the trigger options available:

campaign-monitor-manual-trigger

When you have been redirected to the Tray.io workflow dashboard, from the connectors panel on the left, add a Campaign Monitor connector to your second step. Set the operation to 'Create client'.

Feel free to re-name your steps as you go along to make things clearer for yourself and other users.

Make sure to give a 'Client name' and use the dropdown lists to set your client's country and timezone.

campaign-monitor-step-1

Now when this workflow is run, it will create a client with the given details. You should see your client's ID as a result when you click on your debug panel, and expend the output field.

campaign-monitor-step-1-debug

2 - Add person

Once you have added a second Campaign Monitor connector to your third step, set the operation to 'Add person'.

Use the Connector-snake to set the 'Client ID' using the previous Campaign Monitor connector step, by clicking and dragging on the orange circle mapping icon. Alternatively, use the dropdown list to choose the desired client's ID as well.

CONNECTOR-SNAKE: The simplest and easiest way to generate your jsonpaths is to use our feature called the Connector-snake. Please see the main page for more details.

JSONPATHS: For more information on what jsonpaths are and how to use jsonpaths with Tray.io, please see our Intro page and Data Guide for more details.

You will also have to set the 'Email Address', 'Name', 'Access level' and 'Password' of said person within this operation's scope.

While most of the above information should be self explanatory, in order to set the access level correctly, dont forget that you will need the Custom Client Access Number.

For more information about how to generate/ get this number, please see the explanation given in the above Note on Operations usage section.

In this example, 'Custom client access' is displayed along with the generated 'Custom client access' number.

campaign-monitor-step-2

Now when this workflow is run, it will add a person with the given details to your client. You should see the person's email address as a result when you click on your debug panel, and expend the output field.

campaign-monitor-step-2-debug

BEST PRACTICES: Whenever you do decide to create your own workflow, please make sure you take a look at our managing data best practices guide.

All Operations

Latest version:

1.5

Add person

Adds a new person to the client.

Add subscriber

Adds a subscriber to an existing subscriber list, including custom field data if supplied. If the subscriber (email address) already exists, their name and any custom field values are updated with whatever is passed in.

Add user to a list

Create client

Creates a new client in your account with basic contact information and no access to the application.

Create list

Creates a new list into which subscribers can be added or imported.

Create segment

Creates a new segment for a specific list.

Get campaign summary

Return a basic summary of the results for any sent campaign.

Get client details

Gets the complete details for a client including their API key, access level, contact details and billing settings.

Get journey summary

Return a full summary of a journey.

Get list details

A basic summary for the given list in your account.

Get person details

Returns the details of a single person associated with a client.

Get segment details

Returns the name, list ID, segment ID and number of active subscribers within an existing segment as well as the current rules for that segment.

Get subscriber

Get a subscriber from a list, using their unique email address.

Get subscriber history

Retrieves a historical record of campaigns and automated workflow emails received by a subscriber.

Is email suppressed?

Check to see if an email is in your suppression list.

List active subscribers

Return all the active subscribers for a given list.

List bounced subscribers

Return all the bounced subscribers for a given list.

List campaign clicks

Return a paged result representing all subscribers who clicked a link in a given campaign.

List campaign email client usage

Return the email clients subscribers used to open the campaign.

List campaign opens

Return a paged result representing all subscribers who opened a given campaign.

List campaign recipients

Return a paged result representing all the subscribers that a given campaign was sent to.

List campaign spam complaints

Return a paged result representing all subscribers who marked the given campaign as spam.

List campaign unsubscribes

Return a paged result representing all subscribers who unsubscribed from the email for a given campaign.

List client segments

Retrieves a list of all list segments belonging to a particular client.

List clients

Retrieve a list of all the clients in user account, including their name and ID.

List clients DDL

List countries

Retrieves a list of all the valid countries accepted as input when a country is required.

List countries DDL

List custom fields

Return a list of all the custom fields for a given list in your account.

List deleted subscribers

Return all the deleted subscribers for a given list.

List journey email bounces

Return a paged result representing all emails that were bounced.

List journey email clicks

Return a paged result representing all subscribers who clicked a link in a given journey email.

List journey email opens

Return a paged result representing all subscribers who opened a given journey email.

List journey email recipients

Return a paged result representing all subscribers who have been sent a particular email within a journey.

List journey email unsubscribes

Return a paged result representing all subscribers who unsubscribed from a journey email.

List journeys

Return a list of all journeys belonging to a particular client.

List list segments

Returns all the segments you have created for this list including the name, segment and list ID.

List lists DDL

List lists by email

Return all the subscriber lists across the client, to which an email address is subscribed.

List people

Retrieves a list of all (active or invited) people associated with a particular client.

List sent campaigns

Return a list of all sent campaigns for a client.

List subscriber lists

Returns all the subscriber lists that belong to that client, including the list name and ID.

List suppressed subscribers

Get a list of all of the subscribers in your suppression list.

List timezones

Retrieves a list of all the valid timezones accepted as input when a timezone is required.

List timezones DDL

List unconfirmed subscribers

Return all the unconfirmed subscribers for a given list.

List unsubscribed subscribers

Return all the unsubscribed subscribers for a given list.

Remove user from a list

Send transactional email (smart)

Update subscriber

Updates any aspect of an existing subscriber, including email address, name, and custom field data if supplied.