Target Lists

API change history

The Target Lists API allows clients to manage lists of subscribers for use in targeting. With the Target List API clients can:

Retrieve a list of target lists and number of subscribers Retrieve list and number of subscribers for a target list Add or remove individuals subscribers from a target list Batch add subscribers to a target list Archive a target list

Target lists provide a convenient mechanism to sort specific groups of subscribers. These lists can contain subscribers from a particular marketing initiative, from a specific source or system. Target lists are available for use in the Yesmail Enterprise Marketing platform when defining the targeting for a message.

/

The Target-List API permits interaction with target lists associated with your company. You can use the API's GET /v2/target-lists call to return the names and summary information of your target lists. In order to limit payload size, the maximum number of target lists that can be returned in a single call is 100. The full list of target lists can be obtained via a series of GET /v2/target-lists calls using appropriate values of the LIMIT and OFFSET parameters.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    The GET target-lists?view=schema call returns the list load attributes that are available for the specified company If the targetList array is empty in the response then personalization has not been set-up for that company.

  • (optional)
    integer

    Valid values are integers 0-100.

  • (optional)
    integer

    Valid values are 0-any positive integer.

Request headers

  • string
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

The request has succeeded.

Representations

{
  "total": 0,
  "offset": 0,
  "lists": [
    {
      "lastUsed": "string",
      "memberCount": 0,
      "name": "string",
      "id": 0,
      "lastModified": "string"
    }
  ],
  "limit": 0,
  "count": 0
}
{
  "type": "object",
  "properties": {
    "total": {
      "type": "integer",
      "format": "int32"
    },
    "offset": {
      "type": "integer",
      "format": "int32"
    },
    "lists": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "lastUsed": {
            "type": "string"
          },
          "memberCount": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string"
          },
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "lastModified": {
            "type": "string"
          }
        }
      }
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "count": {
      "type": "integer",
      "format": "int32"
    }
  }
}

400 Bad Request

The request could not be understood by the server due to malformed syntax. For example, invalid parameter values.

401 Unauthorized

The request requires user authentication. Invalid Api-User and/or Api-Key header value.

Code samples

@ECHO OFF

curl -v -X GET "https://api.test.yesmail.com/v2/target-lists/?view="\"\\\"\\\\\\\"schema\\\\\\\"\\\"\""&limit=25&offset=0"
-H "Api-User: "
-H "api-key: {subscription 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("Api-User", "");
            client.DefaultRequestHeaders.Add("api-key", "{subscription key}");

            // Request parameters
            queryString["view"] = ""\"\\\"\\\\\\\"schema\\\\\\\"\\\"\""";
            queryString["limit"] = "25";
            queryString["offset"] = "0";
            var uri = "https://api.test.yesmail.com/v2/target-lists/?" + 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.test.yesmail.com/v2/target-lists/");

            builder.setParameter("view", ""\"\\\"\\\\\\\"schema\\\\\\\"\\\"\""");
            builder.setParameter("limit", "25");
            builder.setParameter("offset", "0");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Api-User", "");
            request.setHeader("api-key", "{subscription 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
            "view": ""\"\\\"\\\\\\\"schema\\\\\\\"\\\"\""",
            "limit": "25",
            "offset": "0",
        };
      
        $.ajax({
            url: "https://api.test.yesmail.com/v2/target-lists/?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Api-User","");
                xhrObj.setRequestHeader("api-key","{subscription 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.test.yesmail.com/v2/target-lists/";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"view="\"\\\"\\\\\\\"schema\\\\\\\"\\\"\""",
                         @"limit=25",
                         @"offset=0",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Api-User"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"api-key"];
    // 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.test.yesmail.com/v2/target-lists/');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Api-User' => '',
    'api-key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'view' => '"\"\\\"\\\\\\\"schema\\\\\\\"\\\"\""',
    'limit' => '25',
    'offset' => '0',
);

$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
    'Api-User': '',
    'api-key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'view': '"\"\\\"\\\\\\\"schema\\\\\\\"\\\"\""',
    'limit': '25',
    'offset': '0',
})

try:
    conn = httplib.HTTPSConnection('api.test.yesmail.com')
    conn.request("GET", "/v2/target-lists/?%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
    'Api-User': '',
    'api-key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'view': '"\"\\\"\\\\\\\"schema\\\\\\\"\\\"\""',
    'limit': '25',
    'offset': '0',
})

try:
    conn = http.client.HTTPSConnection('api.test.yesmail.com')
    conn.request("GET", "/v2/target-lists/?%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.test.yesmail.com/v2/target-lists/')

query = URI.encode_www_form({
    # Request parameters
    'view' => '"\"\\\"\\\\\\\"schema\\\\\\\"\\\"\""',
    'limit' => '25',
    'offset' => '0'
})
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['Api-User'] = ''
# Request headers
request['api-key'] = '{subscription 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