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.
getCampaignUnsubscribers
Retrieves a paged result representing all subscribers who unsubscribed from the email for a given campaign, including the date/time and IP address they unsubscribed from.
You have complete control over how results should be returned including page size, sort order and sort direction.
Try itRequest
Request URL
Request parameters
-
string
Format - uuid. Campaign ID
-
(optional)string
Format - date (as full-date in RFC3339). Unsubscribes on or after the date value specified will be returned. Must be in the format YYYY-MM-DD HH:MM. If not provided, results will not be filtered by date.
-
(optional)integer
Format - int32. The results page to retrieve.
-
(optional)integer
Format - int32. The number of records to retrieve per results page.
-
(optional)string
The field which should be used to order the results.
-
(optional)string
The direction in which results should be ordered.
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
Campaign unsubscribers list.
Representations
{
"Results": [
{
"EmailAddress": "[email protected]",
"ListID": "9bda12161ea91689f8ad596d762b2c37",
"Date": "2019-01-01T11:00:00.0000000+00:00",
"IPAddress": "192.168.0.1"
},
{
"EmailAddress": "[email protected]",
"ListID": "9bda12161ea91689f8ad596d762b2c37",
"Date": "2019-01-01T12:00:00.0000000+00:00",
"IPAddress": "192.168.0.2"
},
{
"EmailAddress": "[email protected]",
"ListID": "61e52c66789f5937dbfa21411ad4b665",
"Date": "2019-01-01T13:00:00.0000000+00:00",
"IPAddress": "192.168.0.3"
},
{
"EmailAddress": "[email protected]",
"ListID": "61e52c66789f5937dbfa21411ad4b665",
"Date": "2019-01-01T14:00:00.0000000+00:00",
"IPAddress": "192.168.0.4"
}
],
"ResultsOrderedBy": "date",
"OrderDirection": "asc",
"PageNumber": 2,
"PageSize": 100,
"RecordsOnThisPage": 4,
"TotalNumberOfRecords": 104,
"NumberOfPages": 2
}
{
"required": [
"Results",
"ResultsOrderedBy,",
"OrderDirection",
"PageNumber",
"PageSize",
"RecordsOnThisPage",
"TotalNumberOfRecord",
"NumberOfPages"
],
"type": "object",
"properties": {
"Results": {
"type": "array",
"items": {
"allOf": [
{
"required": [
"EmailAddress",
"ListID",
"Date"
],
"type": "object",
"properties": {
"EmailAddress": {
"type": "string",
"description": "Subscriber email address",
"format": "email"
},
"ListID": {
"type": "string",
"description": "Subscriber list ID",
"format": "uuid"
},
"Date": {
"type": "string",
"description": "Bounce date",
"format": "date-time"
}
}
},
{
"required": [
"IPAddress"
],
"type": "object",
"properties": {
"IPAddress": {
"type": "string",
"description": "IP address",
"format": "ipv4"
}
}
}
]
},
"description": "Campaign unsubscribe list satisfying query criteria"
},
"ResultsOrderedBy": {
"type": "string",
"description": "Result sort criteria"
},
"OrderDirection": {
"type": "string",
"description": "Result sort order (ascending or descending)"
},
"PageNumber": {
"type": "integer",
"description": "Result page number",
"format": "int32"
},
"PageSize": {
"type": "integer",
"description": "Result page size",
"format": "int32"
},
"RecordsOnThisPage": {
"type": "integer",
"description": "Number of records on current page",
"format": "int32"
},
"TotalNumberOfRecords": {
"type": "integer",
"description": "Total number of records",
"format": "int32"
},
"NumberOfPages": {
"type": "integer",
"description": "Total number of pages",
"format": "int32"
}
}
}
400 Bad Request
The request was incorrect. These are the possible errors which may be included in the body of the response:
Code | Description |
---|---|
5 | Invalid Date The Send Date provided was invalid. |
800 | Invalid page number The page number you have provided is invalid. |
801 | Invalid Page Size The page size must be between 10 and 1000. |
802 | Invalid Order Field The order field must be either email, name or date. |
803 | Invalid Order Direction The order direction must be either 'asc' or 'desc' |
Representations
{
"Code": 5,
"Message": "Invalid Date"
}
{
"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/campaigns/{campaignId}/unsubscribes?date=YYYY-MM-DD HH:MM&page=1&pagesize=1000&orderfield="email"&orderdirection="asc""
-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["date"] = "YYYY-MM-DD HH:MM";
queryString["page"] = "1";
queryString["pagesize"] = "1000";
queryString["orderfield"] = ""email"";
queryString["orderdirection"] = ""asc"";
var uri = "https://api.touchbasepro.com/email/campaigns/{campaignId}/unsubscribes?" + 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/campaigns/{campaignId}/unsubscribes");
builder.setParameter("date", "YYYY-MM-DD HH:MM");
builder.setParameter("page", "1");
builder.setParameter("pagesize", "1000");
builder.setParameter("orderfield", ""email"");
builder.setParameter("orderdirection", ""asc"");
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
"date": "YYYY-MM-DD HH:MM",
"page": "1",
"pagesize": "1000",
"orderfield": ""email"",
"orderdirection": ""asc"",
};
$.ajax({
url: "https://api.touchbasepro.com/email/campaigns/{campaignId}/unsubscribes?" + $.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/campaigns/{campaignId}/unsubscribes";
NSArray* array = @[
// Request parameters
@"entities=true",
@"date=YYYY-MM-DD HH:MM",
@"page=1",
@"pagesize=1000",
@"orderfield="email"",
@"orderdirection="asc"",
];
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/campaigns/{campaignId}/unsubscribes');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => 'Bearer API_KEY',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'date' => 'YYYY-MM-DD HH:MM',
'page' => '1',
'pagesize' => '1000',
'orderfield' => '"email"',
'orderdirection' => '"asc"',
);
$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
'date': 'YYYY-MM-DD HH:MM',
'page': '1',
'pagesize': '1000',
'orderfield': '"email"',
'orderdirection': '"asc"',
})
try:
conn = httplib.HTTPSConnection('api.touchbasepro.com')
conn.request("GET", "/email/campaigns/{campaignId}/unsubscribes?%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
'date': 'YYYY-MM-DD HH:MM',
'page': '1',
'pagesize': '1000',
'orderfield': '"email"',
'orderdirection': '"asc"',
})
try:
conn = http.client.HTTPSConnection('api.touchbasepro.com')
conn.request("GET", "/email/campaigns/{campaignId}/unsubscribes?%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/{campaignId}/unsubscribes')
query = URI.encode_www_form({
# Request parameters
'date' => 'YYYY-MM-DD HH:MM',
'page' => '1',
'pagesize' => '1000',
'orderfield' => '"email"',
'orderdirection' => '"asc"'
})
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