Masters

API change history

The Masters API is the primary service for interacting with marketing messages that will be sent to a large targeted audience of subscribers. This service supports the creation, updating, reading, archiving, enabling, and disabling of messages.
This service is primarily used by clients that are managing message creation and creative design outside the Yesmail Marketing Platform user interface.
A master is composed of four main components, targeting, scheduling, template (content and envelope), and delivery parameters. The first three have been broken out from the master as separate resources, so they can be independenly updated. Most delivery parameters have default values defined at the company level and are rarely updated.

/v2/masters

The masters resource is the collection of all non-archived masters in your instance. With this resouce you can get a count of masters, filter your masters by keyword, subscription (division) or campaign. This service is useful for building lists of masters based on filtered criteria, e.g. Welcome messages in your brand x division. QUERY PARAMETERS: GET /v2/masters?offset=&limit=&keyword=&campaign=&subscription= &triggered=&state=&schedulePeriod=&id=&id=&archived=

Try it

Request

Request URL

Request parameters

  • (optional)
    integer

    Valid values are integers 0-100.

  • (optional)
    integer

    Valid values are 0-any positive integer.

  • (optional)
    string

    Filters list of masters by keyword

  • (optional)
    string

    Filters list of masters by campaign

  • (optional)
    string

    Filters list of masters by subscription division

  • (optional)
    string

    Boolean parameter used to indicate whether to include only triggered messages (true), or only non-triggered messages (false), or both (if the parameter is not present in the URL).

  • (optional)
    string

    Used to filter based on the state of the master. It accepts comma separated list of states. Accepted states are (disabled, enabled, delivered, halted, paused, deleted).

  • (optional)
    string

    akes a period / interval to filter the masters based on the scheduled time period (nextTimeToDeliver). It takes the interval in ISO format 2015-08-01T13:00:00Z/2015-05-11T15:30:00Z. Note that this period should be in future. Zero results will return if it is in past.

Request headers

  • string

    Include a valid Api-User. The combination of Api-Key and Api-User will be authorized.

  • (optional)
    string

    Only media type "application/json" is supported

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

Request body

Responses

200 OK

The request has succeeded.

400 Bad Request

The request could not be understood by the server due to malformed syntax. For example, incorrect syntax of parameters, 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/masters/?limit=25&offset=0&keyword={string}&campaign={string }&subscription={string }&triggered={string }&state=false&schedulePeriod={string}"
-H "Api-User: "
-H "Accept: "
-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.Accept.Add(MediaTypeWithQualityHeaderValue.Parse(""));
            client.DefaultRequestHeaders.Add("api-key", "{subscription key}");

            // Request parameters
            queryString["limit"] = "25";
            queryString["offset"] = "0";
            queryString["keyword"] = "{string}";
            queryString["campaign"] = "{string }";
            queryString["subscription"] = "{string }";
            queryString["triggered"] = "{string }";
            queryString["state"] = "false";
            queryString["schedulePeriod"] = "{string}";
            var uri = "https://api.test.yesmail.com/v2/masters/?" + 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/masters/");

            builder.setParameter("limit", "25");
            builder.setParameter("offset", "0");
            builder.setParameter("keyword", "{string}");
            builder.setParameter("campaign", "{string }");
            builder.setParameter("subscription", "{string }");
            builder.setParameter("triggered", "{string }");
            builder.setParameter("state", "false");
            builder.setParameter("schedulePeriod", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Api-User", "");
            request.setHeader("Accept", "");
            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
            "limit": "25",
            "offset": "0",
            "keyword": "{string}",
            "campaign": "{string }",
            "subscription": "{string }",
            "triggered": "{string }",
            "state": "false",
            "schedulePeriod": "{string}",
        };
      
        $.ajax({
            url: "https://api.test.yesmail.com/v2/masters/?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Api-User","");
                xhrObj.setRequestHeader("Accept","");
                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/masters/";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"limit=25",
                         @"offset=0",
                         @"keyword={string}",
                         @"campaign={string }",
                         @"subscription={string }",
                         @"triggered={string }",
                         @"state=false",
                         @"schedulePeriod={string}",
                      ];
    
    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:@"" forHTTPHeaderField:@"Accept"];
    [_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/masters/');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'limit' => '25',
    'offset' => '0',
    'keyword' => '{string}',
    'campaign' => '{string }',
    'subscription' => '{string }',
    'triggered' => '{string }',
    'state' => 'false',
    'schedulePeriod' => '{string}',
);

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

params = urllib.urlencode({
    # Request parameters
    'limit': '25',
    'offset': '0',
    'keyword': '{string}',
    'campaign': '{string }',
    'subscription': '{string }',
    'triggered': '{string }',
    'state': 'false',
    'schedulePeriod': '{string}',
})

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

params = urllib.parse.urlencode({
    # Request parameters
    'limit': '25',
    'offset': '0',
    'keyword': '{string}',
    'campaign': '{string }',
    'subscription': '{string }',
    'triggered': '{string }',
    'state': 'false',
    'schedulePeriod': '{string}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'limit' => '25',
    'offset' => '0',
    'keyword' => '{string}',
    'campaign' => '{string }',
    'subscription' => '{string }',
    'triggered' => '{string }',
    'state' => 'false',
    'schedulePeriod' => '{string}'
})
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['Accept'] = ''
# 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