REST Email Marketing API Documentation

MAILINGS — AUDIENCE

Assigns the audience (recipients) for an unsent mailing.

HTTP VERB

Post

URL

/API/Rest/Mailings/Audience

ARGUMENTS

mailingTitle
replaceExisting (boolean)
recipients (string array of email addresses)

Required permission

EditMailing

ERRORS

No Permission
Invalid mailing title
Mailing is using segmentation
Mailing has been queued
Database error
Unknown error

RETURNS

A structure with the following fields:

int successfully added
string array badRecipients
string array duplicatedInInput
string array alreadyInMailing

{"successfullyAdded":1,"badRecipients":["fred@aol.com","bob@aol.com","sam@aol.com"],"duplicatedInInput":["bob@aol.com"],"alreadyInMailing":["kim@yahoo.com"]}

EXAMPLE

Add recipients to a mailing.

using System;
using System.Net.Http;
using System.Text;

string url = "https://example.com/API/Rest/Mailings/Audience";
string message = "{\"accountName\":\"acme\",\"login\":\"ApiUser\",\"password\":\"YOUR_PASSWORD\",\"mailingTitle\":\"Valetines 2018\",\"replaceExisting\":false,\"recipients\":[\"dave@aol.com\",\"bob@aol.com\",\"sam@aol.com\",\"Dave@aol.com\"]}";

// Reuse HttpClient for multiple requests in production code.
using (var client = new HttpClient())
using (var request = new HttpRequestMessage(HttpMethod.Post, url))
{
	request.Content = new StringContent(message, Encoding.UTF8, "application/json");

	using (HttpResponseMessage response = await client.SendAsync(request))
	{
		response.EnsureSuccessStatusCode();
		Console.WriteLine(await response.Content.ReadAsStringAsync());
	}
}
			
# encoding: utf-8
require 'rest-client'
require 'json'
							
url = 'https://example.com/API/Rest/Mailings/Audience'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 'password'=>'YOUR_PASSWORD', 'mailingTitle'=>'Valetines 2018','replaceExisting'=>false,'recipients'=>['dave@aol.com','bob@aol.com','sam@aol.com','bob@aol.com']}
response = RestClient.post(url, args.to_json, :content_type => "application/json;charset=utf-8")
puts response	
						
import requests

url = "https://example.com/API/Rest/Mailings/Audience"
args = {'accountName':'acme','login':'ApiUser','password':'YOUR_PASSWORD','mailingTitle':'Valetines 2018','replaceExisting':False,'recipients':['dave@aol.com','bob@aol.com','sam@aol.com','Al@aol.com']}
headers = {'Content-Type': 'application/json'}
resp = requests.post(url, json=args, headers=headers)
if resp.status_code == 200:
	print(resp.text)

curl --request POST --header "Content-Type: application/json" --data '{"accountName":"acme","login":"ApiUser", "password":"YOUR_PASSWORD", "mailingTitle":"Valetines 2018", "replaceExisting":false, "recipients":["dave@aol.com", "bob@aol.com", "sam@aol.com", "Dave@aol.com"]}' "https://example.com/API/Rest/Mailings/Audience"