Get a few key pieces of information about a range of mailings.
Post
/API/Rest/Mailings/Retrieve
| titles | (Optional) Array of one or more mailing titles |
| topic | (Optional) The name of a topic to limit the search |
| sentStart | (Optional) The start date and time to start searching |
| sentEnd | (Optional) The end date and time for searching |
| subject | (Optional) A word to look for in the subject |
| bodyText | (Optional) A word to look for in the body text, both the HTML and plain text are searched |
ViewMailing
No Permission
Invalid subject search
Invalid bodyText search
Invalid mailing title
Database error
Unknown error
Details for the mailing in the format to accommodate a large result set. Columns:
| mailingId | The internal numeric ID for the mailing |
| mailingTitle | The title assigned to the mailing |
| subject | The subject line of the mailing |
| topic | The topic used for unsubscribes for this mailing. |
{"downloadGuid":"baba7cab-7c36-40b8-8d60-d5d4989a1eb4","totalRows":2,"userData":[["1149","Maintenance: August 20th","Push Maintenance: August 20th","Example Mailings"],["1155","maintenance_20180902","Scheduled Maintenance 2nd of September in EU / Geplante Wartungsarbeiten 02. September EU","Example Mailings"]]}
Get the basic information for all mailings sent after a specific date.
using System;
using System.Net.Http;
using System.Text;
string url = "https://example.com/API/Rest/Mailings/Retrieve";
string message = "{\"accountName\":\"acme\",\"login\":\"ApiUser\",\"password\":\"YOUR_PASSWORD\",\"sentStart\":\"2018-08-15 00:00:00Z\"}";
// 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/Retrieve'
args = {'accountName'=>'acme', 'login'=>'ApiUser', 'password'=>'YOUR_PASSWORD', 'sentStart'=>'2018-08-15 00:00:00Z'}
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/Retrieve"
args = {'accountName':'acme','sentStart':'2018-08-15 00:00:00Z', 'login':'ApiUser', 'password':'YOUR_PASSWORD'}
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", "sentStart":"2018-08-15 00:00:00Z"}' "https://example.com/API/Rest/Mailings/Retrieve"