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.

createSegment

Creates a new segment for a specific list.

Please keep in mind that: The RuleGroups collection is optional. Individual RuleGroups can also be added incrementally. RuleGroups can be complicated.

Membership of a list segment is decided on the basis of a collection of RuleGroups and the Rules within them. The rules within a rulegroup are joined together by means of a logical OR. The rulegroups are joined together by means of a logical AND, so that any subscriber who satisfies at least one of the rules in every rulegroup is a member of the segment.

Rules themselves consist of a RuleType, and a collection of Clauses which will operate on that RuleType. A Clause is simply a string which consists of an operating Verb and in most cases an Object (or operand).

The example below creates a segment of any subscribers from touchbasepro.com’ who subscribed in January of 2019.

Try it

Request

Request URL

Request parameters

  • string

    listId is in UUID format.

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

Segment to add to subscriber list.

{
  "Title": "New subscribers",
  "RuleGroups": [
    {
      "Rules": [
        {
          "RuleType": "EmailAddress",
          "Clause": "CONTAINS @touchbasepro.com"
        }
      ]
    },
    {
      "Rules": [
        {
          "RuleType": "Date",
          "Clause": "AFTER 2019-01-01"
        },
        {
          "RuleType": "Date",
          "Clause": "EQUALS 2019-01-01"
        }
      ]
    },
    {
      "Rules": [
        {
          "RuleType": "DateSubscribed",
          "Clause": "BEFORE 2019-02-01"
        }
      ]
    }
  ]
}
{
  "allOf": [
    {
      "required": [
        "ListID",
        "SegmentID",
        "Title"
      ],
      "type": "object",
      "properties": {
        "ListID": {
          "type": "string",
          "description": "Subscriber list ID value. Assigned by the system as part of response",
          "format": "uuid",
          "readOnly": true
        },
        "SegmentID": {
          "type": "string",
          "description": "Segment ID value. Assigned by the system as part of response",
          "format": "uuid",
          "readOnly": true
        },
        "Title": {
          "type": "string",
          "description": "Segment title"
        }
      }
    },
    {
      "required": [
        "ActiveSubscribers",
        "RuleGroups"
      ],
      "type": "object",
      "properties": {
        "ActiveSubscribers": {
          "type": "integer",
          "description": "Number of active subscribers in current segment. Assigned only as part of response",
          "format": "int32",
          "readOnly": true
        },
        "RuleGroups": {
          "type": "array",
          "items": {
            "required": [
              "Rules"
            ],
            "type": "object",
            "properties": {
              "Rules": {
                "type": "array",
                "items": {
                  "required": [
                    "RuleType",
                    "Clause"
                  ],
                  "type": "object",
                  "properties": {
                    "RuleType": {
                      "type": "string",
                      "example": "DateSubscribed"
                    },
                    "Clause": {
                      "type": "string",
                      "example": "AFTER 2009-01-01"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  ]
}

Responses

201 Created

Segment successfully created.

Representations

2c3b5169f32abe2b5bf6287235a5dc67
{
  "type": "string",
  "example": "\"2c3b5169f32abe2b5bf6287235a5dc67\""
}

400 Bad Request

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

CodeDescription
273Segment Title Empty
The segment title cannot be empty.
275Duplicate Segment Title
The segment title must be unique in a list.
277Invalid Segment Rules
One or more of the supplied Rules could not be parsed. Check the ResultData object for more detail.
283Segment Limits Reached
You’ve reached your API segment limit. To create additional segments or segment rules, please contact customer support.

Representations

{
  "Code": 273,
  "Message": "Segment Title Empty"
}
{
  "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."
}

404 Not Found

The listId does not exist.

Representations

{
  "status": 404,
  "message": "The listId does not exist."
}

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/segments/{listId}"
-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/segments/{listId}?" + 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/segments/{listId}");


            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/segments/{listId}?" + $.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/segments/{listId}";
    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/segments/{listId}');
$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/segments/{listId}?%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/segments/{listId}?%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/segments/{listId}')


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