latestOpenAPI 3.1.02026-08-085123123.9 KB
bf0b51ee8e8a
Mailings
Retrieve a mailing
Retrieve a specific mailing based on its ID.
get/mailings/{id}
Path parameters
idinteger required
The mailing's numerical ID
Response
The mailing representation
Example response
{
"id": 2481,
"subject": "API Testing",
"language": "en_ca",
"scheduledOn": "2015-10-14 08:58:33.000",
"replyTo": "info@example.org",
"bodyHtml": "<a href=\"http://example.org\">Hello world</a>...",
"bodyText": "Hello world !!!",
"emailsSent": 2,
"emailsDelivered": 2,
"views": 1,
"clicks": 1,
"sentToFriend": 1,
"clickRate": 0.5,
"viewRate": 0.5,
"status": "sent",
"mailFrom": "admin@example.org",
"fromName": "John Doe",
"mailingStatistics": "detailed",
"links": [
{
"id": 6899,
"url": "https://example.org"
}
],
"recipientGroups": [
{
"id": 159854,
"title": "Testing group"
}
],
"viewOnlineURL": "http://example.org"
}