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.
string message = "{'accountName':'acme','login':'ApiUser', 'password':'sdve4t3gfd', 'mailingTitle':'Valetines 2018', 'replaceExisting':'false', 'recipients':['dave@aol.com', 'bob@aol.com', 'sam@aol.com', 'Dave@aol.com']}";
string url = "http://example.com/api/rest/Mailings/Audience";
try
{
System.Net.HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
request.Method = "POST";
request.ContentType = "application/json";
request.ContentLength = message.Length;
using (Stream webStream = request.GetRequestStream())
using (StreamWriter requestWriter = new StreamWriter(webStream, System.Text.Encoding.ASCII))
requestWriter.Write(message);
System.Net.WebResponse webResponse = request.GetResponse();
using (Stream webStream = webResponse.GetResponseStream())
using (StreamReader responseReader = new StreamReader(webStream))
Console.Out.WriteLine(responseReader.ReadToEnd());
}
catch (Exception e)
{
System.Diagnostics.Debug.Fail(e.Message);
}
# encoding: utf-8
require 'rest-client'
require 'json'
url = 'http://www.acme.com/api/rest/Mailings/Audience'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 'password'=>'sdf3w4tw', '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 = "http://www.example.com/api/rest/Mailings/Audience";
args = {'accountName':'acme','login':'ApiUser','password':'34t3f34f','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 -X POST -H "Content-Type: application/json" -d "{'accountName':'acme','login':'ApiUser','password':'34t3f34f','mailingTitle':'Valetines 2018',
'replaceExisting':'false','recipients':['dave@aol.com','bob@aol.com','sam@aol.com','Al@aol.com']}" http://example.com/api/rest/Mailings/Audience