Email API
API change historyEmail 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.
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
Content of the email to send
{
"Subject": "string",
"From": "string",
"ReplyTo": "string",
"To": [
"string"
],
"CC": [
"string"
],
"BCC": [
"string"
],
"Html": "string",
"Text": "string",
"Attachments": [
{
"Content": "string",
"Name": "string",
"Type": "string"
}
],
"TrackOpens": true,
"TrackClicks": true,
"InlineCSS": true,
"Group": "string",
"AddRecipientsToListID": "string",
"ConsentToTrack": "Yes"
}
{
"required": [
"From",
"To",
"CC",
"BCC",
"TrackOpens",
"TrackClicks",
"InlineCSS",
"ConsentToTrack"
],
"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",
"format": "email"
},
"description": "Optional. List of email addresses to send copy of email to"
},
"Html": {
"type": "string",
"description": "Email message HTML content"
},
"Text": {
"type": "string",
"description": "Optional. Text component of the email. If not provided, we'll auto-generate the text version from the HTML."
},
"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."
},
"TrackOpens": {
"type": "boolean",
"description": "Indicator of whether or not message open event is to be tracked.",
"default": true
},
"TrackClicks": {
"type": "boolean",
"description": "Indicator of whether or not message click event is to be tracked.",
"default": true
},
"InlineCSS": {
"type": "boolean",
"description": "Moves any CSS inline to improve compatibility with email clients.",
"default": true
},
"Group": {
"type": "string",
"description": "Optional. A name to use for grouping email for reporting. There is a limited number of groups, so this should not be unique or changed frequently."
},
"AddRecipientsToListID": {
"type": "string",
"description": "Optional. The ID of a subscriber list to add all recipients to, including CC/BCC. You must have permission from your recipients before adding them to a subscriber list to send them marketing email.",
"format": "uuid"
},
"ConsentToTrack": {
"enum": [
"Yes",
"No",
"Unchanged"
],
"type": "string",
"description": "This value applies to all recipients (To, CC, and BCC) of the email, as well as any subscribers with the same email address across all lists within a client. If an email address has no value stored for ConsentToTrack, it is assumed that the subscriber has given consent.\n- `Yes` - Tracking is permitted for this email address\n- `No` - Tracking is not permitted for this email address\n- `Unchanged` - Do not change the current email address tracking preference"
}
}
}
Responses
202 Accepted
Returns an array of recipients,with each recipient getting its own MessageID.
Representations
[
{
"Status": "Accepted",
"MessageID": "3112df6e-934e-4c5d-90b4-897f193c9193",
"Recipient": "Peter Pan <[email protected]>"
},
{
"Status": "Accepted",
"MessageID": "7f29B932-219d-4207-a6c3-3b85b3802a53",
"Recipient": "[email protected]"
},
{
"Status": "Accepted",
"MessageID": "3918eb2a-faf1-48ea-8285-d7b5493ebe5c",
"Recipient": "[email protected]"
}
]
{
"type": "array",
"items": {
"required": [
"Status",
"MessageID",
"Recipient"
],
"type": "object",
"properties": {
"Status": {
"type": "string",
"description": "Smart email send status"
},
"MessageID": {
"type": "string",
"description": "Smart email ID value"
},
"Recipient": {
"type": "string",
"description": "Recipient email address",
"format": "email"
}
}
}
}
400 Bad Request
The request was incorrect. These are the possible errors which may be included in the body of the response:
Code | Description |
---|---|
1 | Invalid Email Address Email address is missing or incorrectly formatted. |
952 | Recipient Required Recipient is required. At least one To, CC, or a BCC address is required |
953 | Recipient too long Recipient name and email address have a maximum length of 250 characters |
954 | Too many recipients {number} email addresses specified across To, Cc and Bcc. The limit is 25 |
955 | Invalid Reply-To address Must be a valid email address. |
957 | From Required A valid email address is required. |
958 | Long From details From name and email address have a maximum length of 250 characters |
960 | Content is required Either "HTML" or "Text" content must be specified. |
970 | TrackClicks parameter invalid Must be "true" or "false". |
971 | TrackOpens parameter invalid Must be "true" or "false". |
972 | InlineCSS parameter invalid Must be "true" or "false". |
974 | Consent to track value is invalid or not provided |
981 | Attachment name is required Each attachment requires a name |
982 | Attachment type is required Each attachment requires a mime type |
984 | Invalid attachment content Attachment content is invalid, must be valid base64 encoded file. |
993 | You need to set up custom authentication to send transactional emails. Update the settings in your account to manage your own authentication. |
994 | Your sending domain must match your authenticated domain to send transactional email. |
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/transactional/classicEmail/send"
-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/transactional/classicEmail/send?" + 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/transactional/classicEmail/send");
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/transactional/classicEmail/send?" + $.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/transactional/classicEmail/send";
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/transactional/classicEmail/send');
$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/transactional/classicEmail/send?%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/transactional/classicEmail/send?%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/classicEmail/send')
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