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.

createCampaignFromTemplate

By calling this method you can creates a draft campaign based on a template ready to be tested as a preview or sent.

Set the basic campaign information (name, subject, from name and from email), the template ID, the template content, plus the lists and/or segments you’d like it to be eventually sent to. You can find the template ID you want to use by getting a client’s templates.

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

Details of the campaign to be created. Part of this request is the following information:

  1. SingleLines: Represents content for floating singleline tags. Each entry should contain:
  • Content The content to populate the singleline tag in the template.
  • Href Optional URL to be used as a link for the singleline content.
  1. Multilines Represents content for floating multiline tags. Each entry should contain:
  • Content The content to populate the multiline tag in the template.
  1. Images Represents content for floating editable image tags. Each entry should contain:
  • Content The URL of the image to be downloaded and used in the template.

  • Href Optional URL to be used as a link for the image.

  • Alt Optional alternate text for the image.

  1. Repeaters Represents content for repeaters. Each repeater should contain an Items collection. Each repeater item should contain:
  • Layout Optional layout identifier if a specific layout is being targeted in the repeater.

  • Singlelines Should be formatted in the same way as described above for floating singleline tags.

  • Multilines Should be formatted in the same way as described above for floating multiline tags.

  • Images Should be formatted in the same way as described above for floating editable image tags.

It is important to note that all content provided in the request body (singlelines, multilines, images, and repeaters), will be matched with their corresponding template tags in the order in which they are found in the template.

If you wish to skip an editable image in the template and use the default image, simply pass an empty string as the value for the Content field for the image. Also note that use of datarepeater tags is not yet supported when using the API to create a campaign from a template.

{
  "Name": "string",
  "Subject": "string",
  "FromName": "string",
  "FromEmail": "string",
  "ReplyTo": "string",
  "ListIDs": [
    "string"
  ],
  "SegmentIDs": [
    "string"
  ],
  "TemplateID": "string",
  "TemplateContent": {
    "Singlelines": [
      {
        "Content": "string",
        "Href": "string"
      }
    ],
    "Multilines": [
      {
        "Content": "string"
      }
    ],
    "Images": [
      {
        "Content": "string",
        "Alt": "string",
        "Href": "string"
      }
    ],
    "Repeaters": [
      {
        "Items": [
          {
            "Layout": "string",
            "Singlelines": [
              {
                "Content": "string",
                "Href": "string"
              }
            ],
            "Multilines": [
              {
                "Content": "string"
              }
            ],
            "Images": [
              {
                "Content": "string",
                "Alt": "string",
                "Href": "string"
              }
            ]
          }
        ]
      }
    ]
  }
}
{
  "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": [
        "ListIDs",
        "SegmentIDs",
        "TemplateID",
        "TemplateContent"
      ],
      "type": "object",
      "properties": {
        "ListIDs": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "description": "Array of list ID values"
        },
        "SegmentIDs": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid"
          },
          "description": "Array of segment ID values"
        },
        "TemplateID": {
          "type": "string",
          "description": "Template ID value",
          "format": "uuid"
        },
        "TemplateContent": {
          "required": [
            "Singlelines",
            "Multilines",
            "Images",
            "Repeaters"
          ],
          "type": "object",
          "properties": {
            "Singlelines": {
              "type": "array",
              "items": {
                "required": [
                  "Content",
                  "Href"
                ],
                "type": "object",
                "properties": {
                  "Content": {
                    "type": "string",
                    "description": "Single-line content"
                  },
                  "Href": {
                    "type": "string",
                    "description": "Single-line content url",
                    "format": "uri"
                  }
                }
              },
              "description": "Array of slingle-line content descriptors"
            },
            "Multilines": {
              "type": "array",
              "items": {
                "required": [
                  "Content"
                ],
                "type": "object",
                "properties": {
                  "Content": {
                    "type": "string",
                    "description": "Multi-line content"
                  }
                }
              },
              "description": "Array of multi-line content descriptors"
            },
            "Images": {
              "type": "array",
              "items": {
                "required": [
                  "Content",
                  "Alt",
                  "Href"
                ],
                "type": "object",
                "properties": {
                  "Content": {
                    "type": "string",
                    "description": "Image url",
                    "format": "uri"
                  },
                  "Alt": {
                    "type": "string",
                    "description": "Alternative text for image"
                  },
                  "Href": {
                    "type": "string",
                    "description": "Image link url",
                    "format": "uri"
                  }
                }
              },
              "description": "Array of image content descriptors"
            },
            "Repeaters": {
              "type": "array",
              "items": {
                "required": [
                  "Items"
                ],
                "type": "object",
                "properties": {
                  "Items": {
                    "type": "array",
                    "items": {
                      "required": [
                        "Layout",
                        "Singlelines",
                        "Multilines",
                        "Images"
                      ],
                      "type": "object",
                      "properties": {
                        "Layout": {
                          "type": "string",
                          "description": "Layout name"
                        },
                        "Singlelines": {
                          "type": "array",
                          "items": {
                            "required": [
                              "Content",
                              "Href"
                            ],
                            "type": "object",
                            "properties": {
                              "Content": {
                                "type": "string",
                                "description": "Single-line content"
                              },
                              "Href": {
                                "type": "string",
                                "description": "Single-line content url",
                                "format": "uri"
                              }
                            }
                          },
                          "description": "Array of slingle-line content descriptors"
                        },
                        "Multilines": {
                          "type": "array",
                          "items": {
                            "required": [
                              "Content"
                            ],
                            "type": "object",
                            "properties": {
                              "Content": {
                                "type": "string",
                                "description": "Multi-line content"
                              }
                            }
                          },
                          "description": "Array of multi-line content descriptors"
                        },
                        "Images": {
                          "type": "array",
                          "items": {
                            "required": [
                              "Content",
                              "Alt",
                              "Href"
                            ],
                            "type": "object",
                            "properties": {
                              "Content": {
                                "type": "string",
                                "description": "Image url",
                                "format": "uri"
                              },
                              "Alt": {
                                "type": "string",
                                "description": "Alternative text for image"
                              },
                              "Href": {
                                "type": "string",
                                "description": "Image link url",
                                "format": "uri"
                              }
                            }
                          },
                          "description": "Array of image content descriptors"
                        }
                      }
                    }
                  }
                }
              },
              "description": "Array of repeater items"
            }
          },
          "description": "Template content data"
        }
      }
    }
  ]
}

Responses

201 Created

The response will include the segmentIDs from the requests.

Representations

{
  "2c3b5169f32abe2b5bf6287235a5dc67",
  "f9f55267a8d5cb5212bc626a3b33eb27"
}

400 Bad Request

The request was incorrect. These are the possible errors 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.
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.
319Campaign Name Required
A campaign name was not provided, and is required.
320Template Content Required
Template content must be provided.
321Template Content Includes Invalid Image
Template content includes an image with an invalid URL, which we couldn't download.
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, fallback=team@example.com]
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, fallback=team@example.com]
4001Invalid Template ID
Invalid Template ID, or the template doesn't exist or belong to the client.

Representations

{
  "Code": 1,
  "Message": "Invalid Email Address"
}
{
  "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/fromtemplate"
-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/fromtemplate?" + 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/fromtemplate");


            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/fromtemplate?" + $.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/fromtemplate";
    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/fromtemplate');
$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/fromtemplate?%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/fromtemplate?%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/fromtemplate')


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