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.

getMessageDetails

Retrieves get message details as specified by MessageID.

Try it

Request

Request URL

Request parameters

  • string

    Format - uuid. ID of the message details are to be returned for

  • (optional)
    boolean

    Optional. Whether to include detailed opens/clicks

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

Requested email message details.

Representations

{
  "MessageID": "string",
  "Status": "string",
  "SentAt": "string",
  "SmartEmailID": "string",
  "CanBeResent": true,
  "Recipient": "string",
  "Message": {
    "Subject": "string",
    "From": "string",
    "ReplyTo": "string",
    "To": [
      "string"
    ],
    "CC": [
      "string"
    ],
    "BCC": [
      "string"
    ],
    "Attachments": [
      {
        "Content": "string",
        "Name": "string",
        "Type": "string"
      }
    ],
    "Body": {
      "Html": "string",
      "Text": "string"
    },
    "Data": {}
  },
  "Group": "string",
  "TotalOpens": 0,
  "TotalClicks": 0,
  "Opens": [
    {
      "EmailAddress": "string",
      "Date": "string",
      "IPAddress": "string",
      "Geolocation": {
        "Latitude": 0.0,
        "Longitude": 0.0,
        "City": "string",
        "Region": "string",
        "CountryCode": "string",
        "CountryName": "string"
      },
      "MailClient": {
        "Name": "string",
        "Version": "string"
      }
    }
  ],
  "Clicks": [
    {
      "EmailAddress": "string",
      "Date": "string",
      "IPAddress": "string",
      "Geolocation": {
        "Latitude": 0.0,
        "Longitude": 0.0,
        "City": "string",
        "Region": "string",
        "CountryCode": "string",
        "CountryName": "string"
      },
      "URL": "string"
    }
  ]
}
{
  "required": [
    "MessageID",
    "Status",
    "SentAt",
    "SmartEmailID",
    "CanBeResent",
    "Recipient",
    "Message",
    "Group",
    "TotalOpens",
    "TotalClicks",
    "Opens",
    "Clicks"
  ],
  "type": "object",
  "properties": {
    "MessageID": {
      "type": "string",
      "description": "Spcified message ID (from request URL)",
      "format": "uuid"
    },
    "Status": {
      "type": "string",
      "description": "Message status"
    },
    "SentAt": {
      "type": "string",
      "format": "date-time"
    },
    "SmartEmailID": {
      "type": "string",
      "description": "Smart email ID value. Not returned if message was sent as classic email message",
      "format": "uuid"
    },
    "CanBeResent": {
      "type": "boolean",
      "description": "Indicator whether or not email message can be re-sent"
    },
    "Recipient": {
      "type": "string",
      "description": "Recipient email address",
      "format": "email"
    },
    "Message": {
      "required": [
        "Subject",
        "From",
        "To",
        "Body"
      ],
      "type": "object",
      "properties": {
        "Subject": {
          "type": "string",
          "description": "Optional. Email message subject"
        },
        "From": {
          "type": "string",
          "description": "Sender email address",
          "format": "email"
        },
        "ReplyTo": {
          "type": "string",
          "description": "Email address to use when recipient replies to email message",
          "format": "email"
        },
        "To": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "email"
          },
          "description": "List of email recipients"
        },
        "CC": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "email"
          },
          "description": "Optional. List of email addresses to send copy of email to"
        },
        "BCC": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Optional. List of email addresses to send copy of email to",
          "format": "email"
        },
        "Attachments": {
          "type": "array",
          "items": {
            "required": [
              "Content",
              "Name",
              "Type"
            ],
            "type": "object",
            "properties": {
              "Content": {
                "type": "string",
                "description": "Base64 encoded file content",
                "format": "byte"
              },
              "Name": {
                "type": "string",
                "description": "Attachment file name"
              },
              "Type": {
                "type": "string",
                "description": "Attachment file type"
              }
            }
          },
          "description": "Optional. Specifies attachments to include with transactional email. Must include Base64 encoded content, a file name, and file type. All file types accepted."
        },
        "Body": {
          "required": [
            "Html",
            "Text"
          ],
          "type": "object",
          "properties": {
            "Html": {
              "type": "string",
              "description": "Message content in HTML"
            },
            "Text": {
              "type": "string",
              "description": "Message content as plain text"
            }
          },
          "description": "Message content (HTML, Text) is only returned for 30 days after sending, if email message was sent as classic email"
        },
        "Data": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "List of key-value pairs used when message was sent (for providing customized content per recipient)"
        }
      }
    },
    "Group": {
      "type": "string",
      "description": "Email message group"
    },
    "TotalOpens": {
      "type": "integer",
      "description": "Total number of times email was opened (by distinct recipients)",
      "format": "int32"
    },
    "TotalClicks": {
      "type": "integer",
      "description": "Totoal number of times email link was clicked",
      "format": "int32"
    },
    "Opens": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "required": [
              "EmailAddress",
              "Date",
              "IPAddress",
              "Geolocation"
            ],
            "type": "object",
            "properties": {
              "EmailAddress": {
                "type": "string",
                "description": "Subscriber email address",
                "format": "email"
              },
              "Date": {
                "type": "string",
                "description": "Date subscriber action took place",
                "format": "date-time"
              },
              "IPAddress": {
                "type": "string",
                "description": "Subscriber IP address",
                "format": "ipv4"
              },
              "Geolocation": {
                "required": [
                  "Latitude",
                  "Longitude",
                  "City",
                  "Region",
                  "CountryCode",
                  "CountryName"
                ],
                "type": "object",
                "properties": {
                  "Latitude": {
                    "type": "number",
                    "format": "float"
                  },
                  "Longitude": {
                    "type": "number",
                    "format": "float"
                  },
                  "City": {
                    "type": "string"
                  },
                  "Region": {
                    "type": "string"
                  },
                  "CountryCode": {
                    "type": "string"
                  },
                  "CountryName": {
                    "type": "string"
                  }
                }
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "MailClient": {
                "required": [
                  "Name",
                  "Version"
                ],
                "type": "object",
                "properties": {
                  "Name": {
                    "type": "string",
                    "description": "Email client name"
                  },
                  "Version": {
                    "type": "string",
                    "description": "Email client version"
                  }
                }
              }
            }
          }
        ]
      },
      "description": "Email open records"
    },
    "Clicks": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "required": [
              "EmailAddress",
              "Date",
              "IPAddress",
              "Geolocation"
            ],
            "type": "object",
            "properties": {
              "EmailAddress": {
                "type": "string",
                "description": "Subscriber email address",
                "format": "email"
              },
              "Date": {
                "type": "string",
                "description": "Date subscriber action took place",
                "format": "date-time"
              },
              "IPAddress": {
                "type": "string",
                "description": "Subscriber IP address",
                "format": "ipv4"
              },
              "Geolocation": {
                "required": [
                  "Latitude",
                  "Longitude",
                  "City",
                  "Region",
                  "CountryCode",
                  "CountryName"
                ],
                "type": "object",
                "properties": {
                  "Latitude": {
                    "type": "number",
                    "format": "float"
                  },
                  "Longitude": {
                    "type": "number",
                    "format": "float"
                  },
                  "City": {
                    "type": "string"
                  },
                  "Region": {
                    "type": "string"
                  },
                  "CountryCode": {
                    "type": "string"
                  },
                  "CountryName": {
                    "type": "string"
                  }
                }
              }
            }
          },
          {
            "required": [
              "URL"
            ],
            "type": "object",
            "properties": {
              "URL": {
                "type": "string",
                "description": "Clicked link URL",
                "format": "uri"
              }
            }
          }
        ]
      },
      "description": "Email click records"
    }
  }
}

400 Bad Request

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

CodeDescription
302Invalid Message ID
Message ID not found
935Invalid statistics parameter
Value must be 'true' or 'false'
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": 302,
  "Message": "Invalid Message ID"
}
{
  "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/{messageID}?statistics=false"
-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["statistics"] = "false";
            var uri = "https://api.touchbasepro.com/email/transactional/messages/{messageID}?" + 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/{messageID}");

            builder.setParameter("statistics", "false");

            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
            "statistics": "false",
        };
      
        $.ajax({
            url: "https://api.touchbasepro.com/email/transactional/messages/{messageID}?" + $.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/{messageID}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"statistics=false",
                      ];
    
    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/{messageID}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'statistics' => 'false',
);

$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
    'statistics': 'false',
})

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

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

query = URI.encode_www_form({
    # Request parameters
    'statistics' => 'false'
})
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