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.

importSubscribers

Allows you to add many subscribers to a subscriber list in one API request, including custom field data if supplied. If a subscriber (email address) already exists, their name and any custom field values are updated with whatever is passed in. Subscribers will be added instantaneously. The call will only return back once all subscribers have been added.

When specifying a value for a date custom field, avoid the ambiguous date formats dd/mm/yyyy and mm/dd/yyyy. Instead use an explicit format like yyyy/mm/dd.

Please note that each custom field value has a data limit of 250 characters.

Any missing custom field values will remain unchanged. Multi-Valued Select Many custom fields are set by providing multiple Custom Field array items with the same key.

To clear the value of a custom field, pass a parameter of Clear with a value of true along with the custom field name/value. To remove a specific Multi-Valued Select Many option, pass the option name in the Value field along with the Clear: true parameter. To clear all values of a Multi-Valued Select Many field, pass an empty Value along with the Clear: true parameter. Alternatively, Date type custom fields may be still cleared by passing in a value of “0000-00-00”

New subscribers only will be sent the follow-up email as configured in the list settings. If the list has been set as double opt-in, they will be sent the verification email, otherwise they will be sent the confirmation email you have set up for the list being subscribed to. Also, any registered Subscribe webhooks will be triggered. If the subscriber is not new, any registered Update webhooks will be triggered.

By default, automated workflow emails that are based on the subscription date will not be sent for subscribers imported with this method. This can be overridden by setting the QueueSubscriptionBasedAutoResponders parameter to true.

Please note: If any subscribers are in an inactive state or have previously been unsubscribed or added to the suppression list and you specify the Resubscribe input value as true, they will be re-added to the active list. Therefore, this method should be used with caution and only where suitable. If Resubscribe is specified as false, subscribers will not be re-added to the active list.

By default, resubscribed subscribers will not restart any automated workflow sequences, but they will receive any remaining emails. However, if you specify theRestartSubscriptionBasedAutoresponders input value as true, any sequences will be restarted.RestartSubscriptionBasedAutoresponders only affects resubscribing subscribers, and will default tofalse if omitted.

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

Subscribers to import to list

{
  "Subscribers": [
    {
      "EmailAddress": "peter.pan1@touchbasepro.com",
      "Name": "Peter Pan",
      "CustomFields": [
        {
          "Key": "Flying",
          "Value": "Yes"
        },
        {
          "Key": "Skills",
          "Value": "Swordsman"
        },
        {
          "Key": "Skills",
          "Value": "Magician"
        }
      ],
      "ConsentToTrack": "Yes"
    },
    {
      "EmailAddress": "atom.ant@touchbasepro.com",
      "Name": "Atom Ant",
      "ConsentToTrack": "No"
    },
    {
      "EmailAddress": "bugs.bunny@touchbasepro.com",
      "Name": "Bugs Bunny",
      "ConsentToTrack": "Unchanged"
    }
  ],
  "Resubscribe": true,
  "QueueSubscriptionBasedAutoResponders": false,
  "RestartSubscriptionBasedAutoresponders": true
}
{
  "required": [
    "Subscribers",
    "Resubscribe",
    "QueueSubscriptionBasedAutoResponders",
    "RestartSubscriptionBasedAutoresponders"
  ],
  "type": "object",
  "properties": {
    "Subscribers": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "required": [
              "EmailAddress",
              "Name",
              "CustomFields"
            ],
            "type": "object",
            "properties": {
              "EmailAddress": {
                "type": "string",
                "description": "Subscriber email address"
              },
              "Name": {
                "type": "string",
                "description": "Subscriber name"
              },
              "CustomFields": {
                "type": "array",
                "items": {
                  "required": [
                    "Key",
                    "Value"
                  ],
                  "type": "object",
                  "properties": {
                    "Key": {
                      "type": "string",
                      "example": "age"
                    },
                    "Value": {
                      "type": "string",
                      "example": "22"
                    }
                  }
                },
                "description": "Subscriber custom field values. Custom field values of `MultiSelectMany` are saved with multiple values having the same key"
              },
              "ConsentToTrack": {
                "enum": [
                  "Yes",
                  "No"
                ],
                "type": "string",
                "description": "Subscriber tracking preference"
              }
            }
          },
          {
            "required": [
              "Resubscribe",
              "RestartSubscriptionBasedAutoresponders"
            ],
            "type": "object",
            "properties": {
              "Resubscribe": {
                "type": "boolean",
                "description": "If the subscriber is in an inactive state or has previously been unsubscribed or added to the suppression list and you specify the Resubscribe input value as true, they will be re-added to the list"
              },
              "RestartSubscriptionBasedAutoresponders": {
                "type": "boolean",
                "description": "By default, resubscribed subscribers will not restart any automated workflows, but they will receive any remaining emails. However, if you specify the RestartSubscriptionBasedAutoresponders input value as true, any sequences will be restarted. RestartSubscriptionBasedAutoresponders only affects resubscribing subscribers, and will default to false if omitted"
              }
            }
          }
        ]
      },
      "description": "List of subscribers data to import"
    },
    "Resubscribe": {
      "type": "boolean",
      "description": "If any subscribers are in an inactive state or have previously been unsubscribed or added to the suppression list and you specify the Resubscribe input value as true, they will be re-added to the active list."
    },
    "QueueSubscriptionBasedAutoResponders": {
      "type": "boolean",
      "description": "By default, automated workflow emails that are based on the subscription date will not be sent for subscribers imported with this method. This can be overridden by setting the QueueSubscriptionBasedAutoResponders parameter to true."
    },
    "RestartSubscriptionBasedAutoresponders": {
      "type": "boolean",
      "description": "By default, resubscribed subscribers will not restart any automated workflow sequences, but they will receive any remaining emails. However, if you specify theRestartSubscriptionBasedAutoresponders input value as true, any sequences will be restarted. RestartSubscriptionBasedAutoresponders only affects resubscribing subscribers, and will default tofalse if omitted."
    }
  }
}

Responses

200 OK

Subscribers successfully imported with the listed details.

Representations

{
  "FailureDetails": [ ],
  "TotalUniqueEmailsSubmitted": 3,
  "TotalExistingSubscribers": 0,
  "TotalNewSubscribers": 3,
  "DuplicateEmailsInSubmission": [ ]
}
{
  "required": [
    "TotalUniqueEmailsSubmitted",
    "TotalExistingSubscribers",
    "TotalNewSubscribers",
    "DuplicateEmailsInSubmission",
    "FailureDetails"
  ],
  "type": "object",
  "properties": {
    "TotalUniqueEmailsSubmitted": {
      "type": "integer",
      "description": "Number of unique email subscribers submitted",
      "format": "int32"
    },
    "TotalExistingSubscribers": {
      "type": "integer",
      "description": "Number of submitted subscribers that were already present",
      "format": "int32"
    },
    "TotalNewSubscribers": {
      "type": "integer",
      "description": "Number of new subscribers that were submitted",
      "format": "int32"
    },
    "DuplicateEmailsInSubmission": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of duplicate subscriber emails submitted"
    },
    "FailureDetails": {
      "type": "array",
      "items": {
        "required": [
          "EmailAddress",
          "Code",
          "Message"
        ],
        "type": "object",
        "properties": {
          "EmailAddress": {
            "type": "string",
            "description": "Subscriber email address",
            "format": "email"
          },
          "Code": {
            "type": "integer",
            "description": "Error code",
            "format": "int32"
          },
          "Message": {
            "type": "string",
            "description": "Error message"
          }
        }
      },
      "description": "Entry describing failure reason for individual subscribers"
    }
  }
}

400 Bad Request

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

CodeDescription
209Too many subscribers in this batch. You can only add 1000 subscribers in one call
When importing many subscribers at once, you may only import up to 1000 subscribers at once. If you need to import more than this number of subscribers, you will need to make additional requests.
210Subscriber Import had some failures
There were some failures when attempting to import some subscribers. You will need to inspect the ResultData property of the result for the full details of these failures.
212No subscribers were provided in this batch
No subscribers were provided in this batch.
214Please provide a consent to track value.
215Please provide a valid consent to track value.

Representations

{
  "ResultData": {
    "TotalUniqueEmailsSubmitted": 3,
    "TotalExistingSubscribers": 2,
    "TotalNewSubscribers": 0,
    "DuplicateEmailsInSubmission": [ ],
    "FailureDetails": [
      {
        "EmailAddress": "peter.pan@touchbasepro",
        "Code": 1,
        "Message": "Invalid Email Address"
      }
    ]
  },
  "Code": 210,
  "Message": "Subscriber Import had some failures"
}
{
  "required": [
    "ResultData",
    "Code",
    "Message"
  ],
  "type": "object",
  "properties": {
    "ResultData": {
      "required": [
        "TotalUniqueEmailsSubmitted",
        "TotalExistingSubscribers",
        "TotalNewSubscribers",
        "DuplicateEmailsInSubmission",
        "FailureDetails"
      ],
      "type": "object",
      "properties": {
        "TotalUniqueEmailsSubmitted": {
          "type": "integer",
          "description": "Number of unique email subscribers submitted",
          "format": "int32"
        },
        "TotalExistingSubscribers": {
          "type": "integer",
          "description": "Number of submitted subscribers that were already present",
          "format": "int32"
        },
        "TotalNewSubscribers": {
          "type": "integer",
          "description": "Number of new subscribers that were submitted",
          "format": "int32"
        },
        "DuplicateEmailsInSubmission": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of duplicate subscriber emails submitted"
        },
        "FailureDetails": {
          "type": "array",
          "items": {
            "required": [
              "EmailAddress",
              "Code",
              "Message"
            ],
            "type": "object",
            "properties": {
              "EmailAddress": {
                "type": "string",
                "description": "Subscriber email address",
                "format": "email"
              },
              "Code": {
                "type": "integer",
                "description": "Error code",
                "format": "int32"
              },
              "Message": {
                "type": "string",
                "description": "Error message"
              }
            }
          },
          "description": "Entry describing failure reason for individual subscribers"
        }
      }
    },
    "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/subscribers/{listId}/import"
-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/subscribers/{listId}/import?" + 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/subscribers/{listId}/import");


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


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