Emails

API change history

The Emails API is a transactional messaging service. It is designed for sending 1 to 1 messages to individuals that are either subscribed or not subscribed to a mailing division. The Emails API supports pure transactional messaging, this is useful if you are required to send messages to inviduals that have opted out of your messaging programs. Use the transactional=true flag to bypass subscription logic. Subscribe and Send requests can also be made using the Emails API. When adding new subscribers and sending them a welcome message, define their profile information, add their new subscription and designate them as members of the division. If you do not know whether the requestor is a subscriber or you do not wish to resubscribe them, you must first do a look-up of their subscription using GET /v2/subscribers//subscriptions.

/test

POST /v2/emails/test triggers a specific email template personalized for a specific user and sent to one or more email addresses. These recipients do not have to be subscribers. Optionally, the personalization values for the subscriber can be over-ridden using the profile object. Messages sent using this method have their subjectline prepended with PREVIEW. Key performance metrics associated with these messages are not available through any means.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    A customer-specified URI where Yesmail’s service can post the final status of the request. See Tickets API documentation for more details.

  • (optional)
    string

    A customer-specified value that the customer may wish to use to track the ticket internally. See Tickets API documentation for more details.

Request headers

  • string
  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "renderSubscriber": {
    "profile": {
      "userAttrs": [
        {
          "firstname": "string"
        }
      ]
    },
    "id": "string"
  },
  "recipients": [
    {
      "email": "string"
    }
  ],
  "content": {
    "templateId": "string"
  }
}
{
  "type": "object",
  "properties": {
    "renderSubscriber": {
      "type": "object",
      "properties": {
        "profile": {
          "type": "object",
          "properties": {
            "userAttrs": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "firstname": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "id": {
          "type": "string"
        }
      }
    },
    "recipients": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string"
          }
        }
      }
    },
    "content": {
      "type": "object",
      "properties": {
        "templateId": {
          "type": "string"
        }
      }
    }
  }
}

Responses

202 Accepted

Auto generated using Swagger Inspector

Representations

{
  "request": {
    "id": "string",
    "time": "string",
    "user": "string",
    "uri": "string"
  },
  "lastUpdate": "string",
  "state": "string",
  "id": "string",
  "message": "string",
  "events": [
    {
      "state": "string",
      "time": "string",
      "message": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "request": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "time": {
          "type": "string"
        },
        "user": {
          "type": "string"
        },
        "uri": {
          "type": "string"
        }
      }
    },
    "lastUpdate": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "state": {
            "type": "string"
          },
          "time": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.test.yesmail.com/v2/emails/test?responseUri={string}&responseRef={string}"
-H "Api-User: "
-H "Content-Type: application/json"
-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["responseUri"] = "{string}";
            queryString["responseRef"] = "{string}";
            var uri = "https://api.test.yesmail.com/v2/emails/test?" + 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.test.yesmail.com/v2/emails/test");

            builder.setParameter("responseUri", "{string}");
            builder.setParameter("responseRef", "{string}");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Api-User", "");
            request.setHeader("Content-Type", "application/json");
            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
            "responseUri": "{string}",
            "responseRef": "{string}",
        };
      
        $.ajax({
            url: "https://api.test.yesmail.com/v2/emails/test?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Api-User","");
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("api-key","{subscription key}");
            },
            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.test.yesmail.com/v2/emails/test";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"responseUri={string}",
                         @"responseRef={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Api-User"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_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/emails/test');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'responseUri' => '{string}',
    'responseRef' => '{string}',
);

$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
    'Api-User': '',
    'Content-Type': 'application/json',
    'api-key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'responseUri': '{string}',
    'responseRef': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.test.yesmail.com')
    conn.request("POST", "/v2/emails/test?%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': '',
    'Content-Type': 'application/json',
    'api-key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'responseUri': '{string}',
    'responseRef': '{string}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'responseUri' => '{string}',
    'responseRef' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Api-User'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# 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