POST GET emails/lookup

Get full details for emails, including high-level deliverability metrics (for sent emails)

* required

Parameters

Name	Type	Description
emailID	integer	Unique ID of an email
emailIDs	array[integer]	Multiple emailIDs. Requests that use this parameter will change the response data from a single object to an array of objects. Max: 25

Response Data

Returns a fully populated email object, or an array of email objects if looking up multiple emailIDs

Name

Type

Description

abSplit

object

A/B split details

abSplitID	integer	ID of A/B split
parentEmailID	integer	ID of parent email
testEmailIDs	array[integer]	IDs of test emails
winnerEmailID	integer	ID of winner email

approval

object

approvalsCurrent	integer	Number of users who have approved email
approvalsNeeded	integer	Number of users who must approve email
approved	boolean	Overall approved status
requiresApproval	boolean	Indicates if email requires approval (can vary based on user and template settings)
users	array	Array of objects containing approval data per user

automation

object

Automation settings. Automated emails cannot be managed via the API.

active	boolean	Is automation active?
recipientDelay	integer	Delay (in minutes) before contacts will receive email
schedule	array	Array of objects with daily schedule details. e.g. [{"dayOfWeek":1,"scheduledSendTime": "07:00:00"},{"dayOfWeek":2,"scheduledSendTime": "07:00:00"},etc...]

bccAddress

string

Email address that will receive a BCC (blind carbon copy) for every recipient.

campaignIDs

array[integer]

Campaigns the email is assigned to

content

object

body_slot1...body_slot10	string	Content for email template slots (1 to 10)
htmlHead	string	Markup that will be placed in the <head> of the HTML version. Only applies to emails using a template that has the htmlHeadEditable property set to true.
htmlVersion	string	HTML version of email. Auto-generated by default using template in conjunction with body_slot* and htmlHead properties. If htmlVersionEditable==true, user can manually set (no template is used)
textVersion	string	Text version of email. Auto-generated by default, but can be manually set

dateAdded

datetime

Date record was added

dateModified

datetime

Date record was modified

dateSent

datetime

Date email was sent

deliveryType

string

How email gets delivered. One of: Manual, Automated, Transactional

emailID

integer

Unique ID of email

fromAddress

string

Email address used in From header

fromName

string

Name used in From header

htmlVersionEditable

boolean

If true, no template is used and user provides the full HTML version of email (see htmlVersion property). The HTML Version must contain the unsubscribe link variable: $$url[unsubscribe]. The value of htmlVersionEditable cannot be changed on an existing email.

ignoreContactSuppression

boolean

Indicates whether or not suppressed contacts can receive the email. Applies to transactional emails only.

metrics

object

Summary deliverability metrics

bounces	integer	Total number of bounces
clickToViewRate	decimal	Percentage of unique contacts who viewed the email and also clicked (unique views / unique clicks)
clicks	integer	Total number of clicks
complaints	integer	Total number of spam complaints
forwards	integer	Total number of forwards (forward-to-friend)
recipients	integer	Total email recipients
sendingIssues	integer	Total number of sending issues
shares	integer	Total number of shares
uniqueClicks	integer	Unique contacts that clicked a link
uniqueForwards	integer	Unique contacts that forwarded email
uniqueShares	integer	Unique contacts that shared email
uniqueViews	integer	Unique contacts that viewed email
uniqueWebViews	integer	Unique contacts that viewed as a web page
unsubscribes	integer	Total number of unsubscribes
views	integer	Total number of views
webViews	integer	Total number of web views

parentEmailID

integer

ID of parent email record

preheader

string

Summary text that follows subject line in the inbox

recipients

object

contactIDs	array[integer]	Individual contacts assigned to receive the email. For larger sends, add the contacts to a group and send to the group.
excludeGroupIDs	array[integer]	Exclude contacts in these groups from receiving the email
groupIDs	array[integer]	Groups assigned to receive the email

replyToAddress

string

Email address used in Reply-to header

replyToName

string

Name used in Reply-to header

schedule

object

confirmed	boolean	Is schedule delivery confirmed?
dateScheduled	datetime	Date/time of scheduled delivery

status

string

Current status of email delivery. One of: Draft, Sent, Scheduled

subject

string

Subject of email

templateID

integer

ID of template used by email. Set htmlVersionEditable property to true to provide full HTML Version without using a template

throttling

object

Throttling settings

minimumDeliveryDuration

integer

Number of hours delivery is throttled. 0 means no custom throttling. Only applies to emails with manual delivery type.

title

string

Title of email (for internal use)

tracking

object

Tracking options

clicksEnabled	boolean	Track which links were clicked and who did the clicking
viewsEnabled	boolean	Embed an invisible image in email that tracks who viewed

userID

integer

ID of system user email belongs to

Example Calls

Lookup email

GET

/emails/lookup?emailID=123

cURL

Copy

curl https://api.emailer.emfluence.com/v1/emails/lookup?emailID=123 \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"data":{"subject":"Check out the latest news!","preheader":"","dateAdded":"2014-03-26 21:49:28","fromName":"ACME","automation":{},"recipients":{"groupIDs":[123],"contactIDs":[]},"schedule":{"dateScheduled":"","confirmed":0},"dateModified":"2014-03-26 21:49:28","dateSent":"","status":"Draft","emailID":123,"approval":{"users":[{"name":"super admin","comments":"","date":"","approved":"","userID":123}],"approvalsCurrent":0,"approved":1,"requiresApproval":0,"approvalsNeeded":0},"htmlVersionEditable":0,"content":{"body_slot3":"","body_slot10":"","body_slot4":"","body_slot5":"","body_slot6":"","body_slot7":"","body_slot8":"","body_slot9":"","textVersion":"emfluence, llc\r\nBanner content goes here...\r\nMain content goes here...","body_slot1":"Banner content goes here...","htmlVersion":"<html><head><title>emfluence, llc</title></head><body><h1>Banner content goes here...</h1><p>Main content goes here...</p></body></html>","body_slot2":"Main content goes here..."},"templateID":123,"deliveryType":"Manual","parentEmailID":"","metrics":{"views":0,"forwards":0,"uniqueViews":0,"webViews":0,"recipients":0,"bounces":0,"uniqueClicks":0,"uniqueForwards":0,"shares":0,"clicks":0,"complaints":0,"unsubscribes":0,"uniqueWebViews":0,"uniqueShares":0},"fromAddress":"sample@example.com","replyToName":"","replyToAddress":"","bccAddress":"","title":"Monthly Newsletter","userID":123,"abSplit":{},"campaignIDs":[]},"code":0,"requestID":"5983A153-07C7-4318-83984E6727A2C23C"}

Lookup multiple emails by array of emailIDs

POST

/emails/lookup

cURL

Copy

curl https://api.emailer.emfluence.com/v1/emails/lookup \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"emailIDs": [123,456,789]
	}'

Response Data

{"success":1,"data":[{"subject":"API Email Example 1","preheader":"","dateAdded":"2014-03-26 21:49:28","fromName":"emfluence","automation":{},"recipients":{"groupIDs":[123],"contactIDs":[]},"schedule":{"dateScheduled":"","confirmed":0},"dateModified":"2014-03-26 21:49:28","dateSent":"","status":"Draft","emailID":123,"approval":{"users":[{"name":"super admin","comments":"","date":"","approved":"","userID":123}],"approvalsCurrent":0,"approved":1,"requiresApproval":0,"approvalsNeeded":0},"htmlVersionEditable":0,"content":{"body_slot3":"","body_slot10":"","body_slot4":"","body_slot5":"","body_slot6":"","body_slot7":"","body_slot8":"","body_slot9":"","textVersion":"emfluence, llc\r\nBanner content goes here...\r\nMain content goes here...","body_slot1":"Banner content goes here...","htmlVersion":"<html><head><title>emfluence, llc</title></head><body><h1>Banner content goes here...</h1><p>Main content goes here...</p></body></html>","body_slot2":"Main content goes here..."},"templateID":123,"deliveryType":"Manual","parentEmailID":"","metrics":{"views":0,"forwards":0,"uniqueViews":0,"webViews":0,"recipients":0,"bounces":0,"uniqueClicks":0,"uniqueForwards":0,"shares":0,"clicks":0,"complaints":0,"unsubscribes":0,"uniqueWebViews":0,"uniqueShares":0},"fromAddress":"sample@example.com","replyToName":"","replyToAddress":"","bccAddress":"","title":"API Email Example 1","userID":123,"abSplit":{},"campaignIDs":[]},{"subject":"API Email Example 2","preheader":"","dateAdded":"2013-10-02 21:37:00","fromName":"emfluence","automation":{},"recipients":{"groupIDs":[123],"contactIDs":[]},"schedule":{"dateScheduled":"","confirmed":0},"dateModified":"2015-06-10 11:25:00","dateSent":"","status":"Draft","emailID":456,"approval":{"users":[{"name":"super admin","comments":"","date":"","approved":"","userID":123}],"approvalsCurrent":0,"approved":1,"requiresApproval":0,"approvalsNeeded":0},"content":{"body_slot3":"","body_slot10":"","body_slot4":"","body_slot5":"","body_slot6":"","body_slot7":"","body_slot8":"","body_slot9":"","textVersion":"emfluence, llc\r\nBanner content goes here...\r\nMain content goes here...","body_slot1":"Banner content goes here...","htmlVersion":"<html><head><title>emfluence, llc</title></head><body><h1>Banner content goes here...</h1><p>Main content goes here...</p></body></html>","body_slot2":"Main content goes here..."},"templateID":123,"deliveryType":"Manual","parentEmailID":"","metrics":{"views":0,"forwards":0,"uniqueViews":0,"webViews":0,"recipients":0,"bounces":0,"uniqueClicks":0,"uniqueForwards":0,"shares":0,"clicks":0,"complaints":0,"unsubscribes":0,"uniqueWebViews":0,"uniqueShares":0},"fromAddress":"sample@example.com","replyToName":"","replyToAddress":"","bccAddress":"","title":"API Email Example 2","userID":123,"abSplit":{},"campaignIDs":[]},{"subject":"API Email Example 3","preheader":"","dateAdded":"2014-02-20 16:03:00","fromName":"emfluence","automation":{},"recipients":{"groupIDs":[123],"contactIDs":[]},"schedule":{"dateScheduled":"","confirmed":0},"dateModified":"2015-01-07 17:42:00","dateSent":"","status":"Draft","emailID":789,"approval":{"users":[{"name":"super admin","comments":"","date":"","approved":"","userID":123}],"approvalsCurrent":0,"approved":1,"requiresApproval":0,"approvalsNeeded":0},"content":{"body_slot3":"","body_slot10":"","body_slot4":"","body_slot5":"","body_slot6":"","body_slot7":"","body_slot8":"","body_slot9":"","textVersion":"emfluence, llc\r\nBanner content goes here...\r\nMain content goes here...","body_slot1":"Banner content goes here...","htmlVersion":"<html><head><title>emfluence, llc</title></head><body><h1>Banner content goes here...</h1><p>Main content goes here...</p></body></html>","body_slot2":"Main content goes here..."},"templateID":123,"deliveryType":"Manual","parentEmailID":"","metrics":{"views":0,"forwards":0,"uniqueViews":0,"webViews":0,"recipients":0,"bounces":0,"uniqueClicks":0,"uniqueForwards":0,"shares":0,"clicks":0,"complaints":0,"unsubscribes":0,"uniqueWebViews":0,"uniqueShares":0},"fromAddress":"sample@example.com","replyToName":"","replyToAddress":"","bccAddress":"","title":"API Email Example 3","userID":123,"abSplit":{},"campaignIDs":[]}],"code":0,"requestID":"73FC4AEF-F3F1-408D-87F1BA68C962F869"}

API Console

The console uses production data, so BE CAREFUL!

GET

emails/lookup

Param	Value	Type	Description
emailID		integer	Unique ID of an email
emailIDs		array[integer]	Multiple emailIDs. Requests that use this parameter will change the response data from a single object to an array of objects. Max: 25

Access token: *

Emails

POST GET emails/lookup

Parameters

Response Data

Example Calls

Lookup email

Lookup multiple emails by array of emailIDs

API Console