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.

updateSubscriber

Updates any aspect of an existing subscriber, including email address, name, and custom field data if supplied.

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.

For all custom fields besides Multi-Valued Select Many fields, any missing values will remain unchanged. When updating Multi-Valued Select Many custom fields, all options that are selected for that customer need to be passed through each time an update is made. If you do not pass through all the options that you wish to have selected for that customer, all historically selected options will be replaced with what’s included in your most recent call. 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”.

Note: the email value in the query string is the old email address. Use the EmailAddress property in the request body to change the email address.

The update will apply whether the subscriber is active or inactive, although if the subscriber does not exist, a new one will not be added.

Inactive subscribers will not be resubscribed unless Resubscribe is set to true. Operation of the Resubscribe value and associated welcome and confirmation emails are identical to adding a subscriber, and should therefore be treated with the same caution.

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.

Any registered Update webhooks will be triggered, whether the subscriber is inactive or not.

Try it

Request

Request URL

Request parameters

  • string

    listId is in UUID format.

  • string

    Subscriber old email address

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

Subscriber to update

{
  "EmailAddress": "[email protected]",
  "Name": "Peter Pan",
  "CustomFields": [
    {
      "Key": "Flying",
      "Value": "Yes"
    },
    {
      "Key": "Skills",
      "Value": "Swordsman"
    },
    {
      "Key": "Skills",
      "Value": "Magician"
    }
  ],
  "Resubscribe": true,
  "RestartSubscriptionBasedAutoresponders": true,
  "ConsentToTrack": "Yes"
}
{
  "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"
        }
      }
    }
  ]
}

Responses

200 OK

Subscriber successfully updated.

400 Bad Request

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

CodeDescription
1Invalid Email Address
Email address is missing or incorrectly formatted.
201Already subscribed
New Email Address is already subscribed to the list. Subscriber not updated.
203Subscriber Not In List
Email Address does not belong to the list. Subscriber not updated.
211Invalid New Email Address
New Email Address was invalid. Subscriber not updated.
214Please provide a consent to track value.
215Please provide a valid consent to track value.

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 PUT "https://api.touchbasepro.com/email/subscribers/{listId}?email={email}"
-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}?email={email}&" + 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.PutAsync(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}?email={email}");


            URI uri = builder.build();
            HttpPut request = new HttpPut(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}?email={email}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","Bearer API_KEY");
                xhrObj.setRequestHeader("Content-Type","application/json");
            },
            type: "PUT",
            // 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}?email={email}";
    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:@"PUT"];
    // 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}?email={email}');
$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_PUT);

// 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("PUT", "/email/subscribers/{listId}?email={email}&%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("PUT", "/email/subscribers/{listId}?email={email}&%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}?email={email}')


request = Net::HTTP::Put.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