Email API

API change history

Email API contains methods for handling various aspects of email campaigns (design, send) as well as recipients (list of email addresses, additional data to merge into message text), etc.

createDraftCampaign

By calling this method you can create new draft campaign, ready to be tested as a preview or sent. Set the basic campaign information (name, subject, from name and from email), the URL of the HTML content plus the lists and/or segments you’d like it to be eventually sent to. We’ll automatically move all CSS inline for the HTML component.

Note that you may optionally specify a TextUrl field in your input if you want to specify text content for the campaign. If you don’t specify TextUrl or if TextUrl is left empty, the text content for the campaign will be automatically generated from the HTML content.

If you are using the SegmentIDs section, remove the ListIDs section from your request.

Try it

Request

Request URL

Request headers

  • string

    The authorization token. The token will be in the format "Bearer API_KEY". For example: "Authorization: Bearer 123456789". Please include the space between "Bearer" and "API_KEY".

Request body

The details for the draft compaign. It includes the following data:

  • Name (string) - The name of the campaign.
  • Subject (string) - The email subject line.
  • FromName (string) - The "From" name to use for the emails.
  • FromEmail (string) - The "From" email address to use for the emails.
  • ReplyTo (string) - The "ReplyTo" address to use for the emails.
  • HtmlUrl (string) - The URL to provide for people to connect to.
  • ListIDs (array) - String array of ListIDs. Please note if using SegmentIDs, do not use ListIDs.
  • SegmentIDs (array) - String array of SegmentIDs.

Please note if using SegmentIDs, do not use ListIDs.

{
  "Name": "New campaign",
  "Subject": "Winter sale",
  "FromName": "Touchbasepro",
  "FromEmail": "[email protected]",
  "ReplyTo": "[email protected]",
  "HtmlUrl": "http://www.touchbasepro.com/salcampaign/index.html",
  "ListIDs": [
    "9bda12161ea91689f8ad596d762b2c37",
    "61e52c66789f5937dbfa21411ad4b665"
  ],
  "SegmentIDs": [
    "2c3b5169f32abe2b5bf6287235a5dc67",
    "f9f55267a8d5cb5212bc626a3b33eb27"
  ]
}
{
  "allOf": [
    {
      "required": [
        "Name",
        "Subject",
        "FromName",
        "FromEmail",
        "ReplyTo"
      ],
      "type": "object",
      "properties": {
        "Name": {
          "type": "string",
          "description": "Campaign name"
        },
        "Subject": {
          "type": "string",
          "description": "Campaign subject"
        },
        "FromName": {
          "type": "string",
          "description": "Campaign sender name"
        },
        "FromEmail": {
          "type": "string",
          "description": "Campaign sender email address",
          "format": "email"
        },
        "ReplyTo": {
          "type": "string",
          "description": "Campaign reply email address",
          "format": "email"
        }
      }
    },
    {
      "required": [
        "HtmlUrl",
        "ListIDs",
        "SegmentIDs"
      ],
      "type": "object",
      "properties": {
        "HtmlUrl": {
          "type": "string",
          "description": "Campaign contents url",
          "format": "uri"
        },
        "ListIDs": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "description": "ID values of subscriber lists referenced by campaign"
        },
        "SegmentIDs": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "description": "ID values of segments referenced by campaign"
        }
      }
    }
  ]
}

Responses

200 OK

The response will be the ListIDs or SegmentIDs as from the created campaign.

Representations

{
  "2c3b5169f32abe2b5bf6287235a5dc67": "",
  "f9f55267a8d5cb5212bc626a3b33eb27": ""
}

400 Bad Request

An invalid or badly formatted request. The following are possible error messages which may be included in the body of the response:

CodeDescription
303Duplicate Campaign Name
The campaign name passed in already exists for this client.
304Campaign Subject Required
A campaign subject must be provided.
305From Name Required
The From name field is required and must be provided.
307Invalid From Email Address
The From Email Address must be a valid email address.
308Reply to Address Required
The Reply-To Address is a required field and must be provided.
309Invalid Reply-To Address
The Reply-To Address must be a valid email address.
310HTML Content URL Required
You must provide a URL of the HTML content for your campaign.
311Invalid HTML Content
Your content contains JavaScript or Flash which cannot be sent to email clients.
312Invalid Text Content URL
Text Content URL is optional, but must be valid if provided.
313Invalid ListID’s
The List ID’s you supplied are invalid.
314Invalid Segments
The Segments you supplied are invalid.
315Lists or Segments Required
You must provide either List ID’s or Segments to send to.
316Problems Importing Links
There was a problem parsing and importing your links.
317Link Too Long
At least one of your links was too long to import.
318Text Unsubscribe Tag In HTML Email
You currently only have a text unsubscribe link of the format {[unsubscribe]} in your HTML content. We require a single-click unsubscribe link in every campaign you send. You can do this by adding the tags and around the words you want to become an unsubscribe link, and then re-import your content.
319Campaign Name Required
A campaign name was not provided, and is required.
322From Name Contains Reserved Personalization Tag
From name can not include personalization tags other than custom fields
323From Email Address Requires a Fallback
From email address requires a fallback: [customfield, [email protected]]
324From Address Contains Reserved Personalization Tag
From email address can not include personalization tags other than custom fields
325Reply-To Address Requires a Fallback
Reply-to address requires a fallback: [customfield, [email protected]]
326Reply-To Address Uses Reserved Personalization Tag
Reply-to address can not include personalization tags other than custom fields
4201Contains Flash
Flash is not supported by almost every email client out there and should not be included in your emails.
4202Contains Script
Almost every popular email client and spam filter does not support JavaScript. Your campaign will either be filtered as spam, or will display a security warning to your recipients. We recommend removing all JavaScript code from your campaign and then re-import it.
4203Contains Java
Java is not supported by almost every email client out there and should not be included in your emails. Please remove it from your content.
4302Unsubscribe Tag Contains Less Than 3 Chars
You'll need to add some text, such as 'unsubscribe' in between your and tags. Those words will then become an unsubscribe link for each recipient.
4303Unsubscribe Tag Contains A Link
It appears your <unsubscribe> tag contains a link. Please ensure you add the tags and around only the words (and not links) you want to become an unsubscribe link. We'll automatically convert that to a link for each recipient.
4304No Closing Unsubscribe Tag
We found the <unsubscribe> tag, but couldn't track down the </unsubscribe> tag. You'll need to add this before the unsubscribe link will work.
4306Nested Unsubscribe tag
We've detected an <unsubscribe> tag inside another Campaign Monitor tag. This will render the Unsubscribe link unusable, and can cause problems with your subscribers attempting to unsubscribe. Please place the <unsubscribe> tag outside the Campaign Monitor tag.
4307Nested Unsubscribe tag
We've detected an <unsubscribe> tag inside another link (ie. an <a> tag). This will render the Unsubscribe link unusable, and can cause problems with your subscribers attempting to unsubscribe. Please place the <unsubscribe> tag outside the link.

Representations

{
  "Code": 303,
  "Message": "Duplicate Campaign Name"
}
{
  "required": [
    "Code",
    "Message"
  ],
  "type": "object",
  "properties": {
    "Code": {
      "type": "integer",
      "description": "Error code",
      "format": "int32"
    },
    "Message": {
      "type": "string",
      "description": "Error message"
    }
  }
}

401 Unauthorized

The API key is invalid. Please verify it is correct and try again.

Representations

{
  "status": 401,
  "message": "API key is invalid."
}

403 Forbidden

There is not enough credits on your account or your account has been suspended. Please check with your account representative for more information.

Representations

{
  "status": 403,
  "message": "Not enough credits in this account."
}

429 Too many requests

The number of API calls has been exceeded. The return will include the number of seconds (represented by (number of seconds) in the example) until the API call can be tried again.

Representations

{
  "status": 429,
  "message": "Rate limit is exceeded.  Try again in {number of seconds} seconds."
}

500 Internal Server Error

Some error occurred in the processing request. Please try it again at a later time.

Representations

{
  "status": 500,
  "message": "An internal error has occurred. We have been notified about it and will restore service functionality as soon as possible."

Code samples

@ECHO OFF

curl -v -X POST "https://api.touchbasepro.com/email/campaigns"
-H "Authorization: Bearer API_KEY"
-H "Content-Type: application/json"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Authorization", "Bearer API_KEY");

            var uri = "https://api.touchbasepro.com/email/campaigns?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.touchbasepro.com/email/campaigns");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Authorization", "Bearer API_KEY");
            request.setHeader("Content-Type", "application/json");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.touchbasepro.com/email/campaigns?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","Bearer API_KEY");
                xhrObj.setRequestHeader("Content-Type","application/json");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.touchbasepro.com/email/campaigns";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"Bearer API_KEY" forHTTPHeaderField:@"Authorization"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.touchbasepro.com/email/campaigns');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => 'Bearer API_KEY',
    'Content-Type' => 'application/json',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Authorization': 'Bearer API_KEY',
    'Content-Type': 'application/json',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.touchbasepro.com')
    conn.request("POST", "/email/campaigns?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Authorization': 'Bearer API_KEY',
    'Content-Type': 'application/json',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.touchbasepro.com')
    conn.request("POST", "/email/campaigns?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.touchbasepro.com/email/campaigns')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Authorization'] = 'Bearer API_KEY'
# Request headers
request['Content-Type'] = 'application/json'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body