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.

getMessageTimeline

Retrieves a list of sent messages (classic or smart) filtered by group, email date and more.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    Optional. A url-encoded classic group name to filter by.

  • (optional)
    string

    Format - uuid. Optional. A messageID used for pagination, returns emails sent before the specified message.

  • (optional)
    string

    Format - uuid. Optional. A messageID used for pagination, returns emails sent after the specified message.

  • (optional)
    integer

    Format - int32. Optional. Maximum number of results to return in a single request

  • (optional)
    string

    Optional. Filter messages by status.

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

Responses

200 OK

List of sent messages in JSON format.

Representations

[
  {
    "MessageID": "7c505353-a03e-4f3c-b579-d3e48214476e",
    "Status": "Sent",
    "SentAt": "2019-01-01T10:00:00.0000000+01:00",
    "Recipient": "Peter Pan <[email protected]>",
    "From": "TouchBasePro <[email protected]>",
    "Subject": "January 2019 newsletter",
    "TotalOpens": 2,
    "TotalClicks": 4,
    "CanBeResent": true
  },
  {
    "MessageID": "a071b393-c218-40c6-adcc-90555bf70e96",
    "Status": "Sent",
    "SentAt": "2018-12-01T10:00:00.0000000+01:00",
    "Recipient": "Peter Pan <[email protected]>",
    "From": "TouchBasePro <[email protected]>",
    "Subject": "December 2018 newsletter",
    "TotalOpens": 1,
    "TotalClicks": 3,
    "CanBeResent": true,
    "Group": "News"
  },
  {
    "MessageID": "024e0564-2e51-4fd0-a5e5-4fbaca022cb6",
    "Status": "Sent",
    "SentAt": "2018-12-30T10:00:00.0000000+01:00",
    "Recipient": "Peter Pan <[email protected]>",
    "From": "TouchBasePro <[email protected]>",
    "Subject": "Happy New Year!",
    "TotalOpens": 2,
    "TotalClicks": 4,
    "CanBeResent": true,
    "SmartEmailID": 2309480239
  }
]
{
  "type": "array",
  "items": {
    "required": [
      "MessageID",
      "Status",
      "SentAt",
      "Recipient",
      "From",
      "Subject",
      "TotalOpens",
      "TotalClicks",
      "CanBeResent"
    ],
    "type": "object",
    "properties": {
      "MessageID": {
        "type": "string",
        "description": "Message ID value",
        "format": "uuid",
        "readOnly": true
      },
      "Status": {
        "type": "string",
        "description": "Message status",
        "readOnly": true
      },
      "SentAt": {
        "type": "string",
        "description": "Message send date",
        "format": "date-time",
        "readOnly": true
      },
      "Recipient": {
        "type": "string",
        "description": "Message recipient email address",
        "format": "email",
        "readOnly": true
      },
      "From": {
        "type": "string",
        "description": "Message sender email address",
        "format": "email",
        "readOnly": true
      },
      "Subject": {
        "type": "string",
        "description": "Message subject",
        "readOnly": true
      },
      "TotalOpens": {
        "type": "integer",
        "description": "Total number of email open events",
        "format": "int32",
        "readOnly": true
      },
      "TotalClicks": {
        "type": "integer",
        "description": "Total number of email click events",
        "format": "int32",
        "readOnly": true
      },
      "CanBeResent": {
        "type": "boolean",
        "description": "Indicator whether or not message can be re-sent",
        "readOnly": true
      }
    }
  }
}

400 Bad Request

The request was incorrect. These are the possible errors which may be included in the body of the response:

CodeDescription
404Not Found
Send ID not found
850Invalid count
Must be a number between 1 and 200.
904Invalid sentbeforeid
Value must be a valid GUID.
905Invalid sentafterid
Value must be a valid GUID.
925Invalid smartEmailID
Value must be a valid GUID.
932Invalid status parameter
Must be one of "all", "active", or "draft"
993You need to set up custom authentication to send transactional emails. Update the settings in your account to manage your own authentication.
994Your sending domain must match your authenticated domain to send transactional email.

Representations

{
  "Code": 404,
  "Message": "Not Found"
}
{
  "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 GET "https://api.touchbasepro.com/email/transactional/messages?group={string}&sentBeforeID={string}&sentAfterID={string}&count=50&status="all""
-H "Authorization: Bearer API_KEY"

--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");

            // Request parameters
            queryString["group"] = "{string}";
            queryString["sentBeforeID"] = "{string}";
            queryString["sentAfterID"] = "{string}";
            queryString["count"] = "50";
            queryString["status"] = ""all"";
            var uri = "https://api.touchbasepro.com/email/transactional/messages?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // 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/transactional/messages");

            builder.setParameter("group", "{string}");
            builder.setParameter("sentBeforeID", "{string}");
            builder.setParameter("sentAfterID", "{string}");
            builder.setParameter("count", "50");
            builder.setParameter("status", ""all"");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Authorization", "Bearer API_KEY");


            // 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
            "group": "{string}",
            "sentBeforeID": "{string}",
            "sentAfterID": "{string}",
            "count": "50",
            "status": ""all"",
        };
      
        $.ajax({
            url: "https://api.touchbasepro.com/email/transactional/messages?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","Bearer API_KEY");
            },
            type: "GET",
            // 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/transactional/messages";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"group={string}",
                         @"sentBeforeID={string}",
                         @"sentAfterID={string}",
                         @"count=50",
                         @"status="all"",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"Bearer API_KEY" forHTTPHeaderField:@"Authorization"];
    // 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/transactional/messages');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Authorization' => 'Bearer API_KEY',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'group' => '{string}',
    'sentBeforeID' => '{string}',
    'sentAfterID' => '{string}',
    'count' => '50',
    'status' => '"all"',
);

$url->setQueryVariables($parameters);

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

// 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',
}

params = urllib.urlencode({
    # Request parameters
    'group': '{string}',
    'sentBeforeID': '{string}',
    'sentAfterID': '{string}',
    'count': '50',
    'status': '"all"',
})

try:
    conn = httplib.HTTPSConnection('api.touchbasepro.com')
    conn.request("GET", "/email/transactional/messages?%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',
}

params = urllib.parse.urlencode({
    # Request parameters
    'group': '{string}',
    'sentBeforeID': '{string}',
    'sentAfterID': '{string}',
    'count': '50',
    'status': '"all"',
})

try:
    conn = http.client.HTTPSConnection('api.touchbasepro.com')
    conn.request("GET", "/email/transactional/messages?%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/transactional/messages')

query = URI.encode_www_form({
    # Request parameters
    'group' => '{string}',
    'sentBeforeID' => '{string}',
    'sentAfterID' => '{string}',
    'count' => '50',
    'status' => '"all"'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Authorization'] = 'Bearer API_KEY'
# 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