emfluence Marketing Platform API Documentation

POST GET contacts/activities

Get all contact activities by date range. When paging through results it is important to use static dates for startDate and endDate to ensure the data is consistent throughout the results. Data provided by this endpoint may be delayed.

Param	Type	Description
startDate *	datetime	Return activities after this date. Due to the large amount of data that can be returned, it is recommended to use a narrow date range.
endDate *	datetime	Return activities before this date. For consistent results, use a static value (i.e. don't use a function to get the current time) in the past and keep the same value when paging through results.
activities *	array[string]	Activities are categorized by type and can be filtered using the pattern "{activityType}:{activity}". Use * to return all activities of a particular type (e.g. EMAIL:* will return all email-related activities). Allowed Values: EMAIL:, EMAIL:SENT, EMAIL:VIEWED, EMAIL:CLICKED, EMAIL:VIEWEDASWEBPAGE, EMAIL:FORWARDED, EMAIL:SHARED, EMAIL:BOUNCED, EMAIL:COMPLAINED, EMAIL:UNSUBSCRIBED, WEBTRACKING:, WEBTRACKING:PAGEVIEW, LANDINGPAGE:, LANDINGPAGE:CLICK, LANDINGPAGE:CONVERSION, LANDINGPAGE:VIEW, SURVEY:, SURVEY:STARTED, SURVEY:COMPLETED, SMS:*, SMS:SENT, SMS:FAILED, SMS:UNSUBSCRIBED, SMS:INCOMINGMESSAGE
contactID	integer	Return activities for a specific contact
contactFields	string	Comma-separated list of contact fields to return. If not included, contactID will be automatically added. Available fields: address1, address2, city, company, contactID, content1-content10, country, custom1-customX, customerID, dateAdded, dateHeld, dateModified, dateOfBirth, dateSuppressed, email, fax, firstName, held, lastName, mobileNumber, originalSource, phone, purl, state, suppressed, title, userID, zipCode, lastActivityDate, lastClickDate, contactScore, contactScore1-contactScoreX, notes Default: contactID, email
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 100 Min: 1 Max: 1000
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

POST contacts/delete

Delete an existing contact record.

Request Body

{"contactID":0,"deleteSuppressed":"0"}

Access token: *

POST contacts/deleteGroups

Remove contact from the groups provided. ContactID or email is required.

Request Body

{"groupIDs":"","contactID":0,"email":""}

Access token: *

POST GET contacts/getEmailHistory

Get emails sent to a single contact. ContactID or email is required.

Param	Type	Description
contactID	integer	Unique ID of a contact
email	email-address	An email address of an existing contact
dateSentStart	datetime	Emails sent since this date.
dateSentEnd	datetime	Emails sent before this date.
viewed	boolean
clicked	boolean
suppressed	boolean
complained	boolean
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 250
sortField	string	The field to sort results by Default: dateSent Allowed Values: dateSent
sortDirection	string	The direction to sort results Default: desc Allowed Values: asc, desc

Access token: *

POST GET contacts/getGroups

Get groups for a single contact. ContactID or email is required.

Param	Value	Type	Description
contactID		integer	Unique ID of a contact
email		email-address	An email address of an existing contact

Access token: *

POST contacts/import

Save multiple contact records from a JSON array. All records in array must match in structure! The structure is defined by the first record. All records must contain an email address. Max of 1000 records at a time. Suppressed contact records cannot be unsuppressed through this endpoint.

Request Body

{"groupIDs":"","updateExisting":"1","removeGroupIDs":"","contacts":[]}

Access token: *

POST GET contacts/lookup

Get full details for contacts by either contactID or email

Param	Type	Description
contactID	integer	Unique ID of a contact
contactIDs	array[integer]	Multiple contactIDs. Requests that use this parameter will change the response data from a single object to an array of objects. Max: 100
email	email-address	An email address of an existing contact

Access token: *

POST contacts/save

Save a single contact record. ContactID or email is required. Only data for parameters passed in is saved.

Request Body

{"groupIDs":"","company":"","address2":"","notes":"","purl":"","contactID":0,"address1":"","removeGroupIDs":"","state":"","firstName":"","held":0,"city":"","ipaddress":"","email":"","userID":0,"memo":"","country":"","originalSource":"","customerID":"","lastName":"","fax":"","zipCode":"","dateofbirth":"","suppressed":0,"customFields":{},"phone":"","title":"","contentVariables":{},"mobileNumber":""}

Access token: *

POST contacts/saveGroups

Save groups for an existing contact. ContactID or email is required. By default, this call mirrors the functionality of /contacts/save when passing the "groupIDs" parameter. However, here you can include a "suppressed" flag per group which allows you to set group-level suppression.

Request Body

{"groups":[],"contactID":0,"email":""}

Access token: *

POST GET contacts/search

Search contacts by various criteria

Param	Type	Description
groupID	integer	Filter results by group
suppressed	boolean	Opted out of receiving emails
held	boolean	Bad email address (too many bounces)
contactIDs	array[integer]	Multiple contactIDs Max: 100
email	string	Search by email address. Use * as a wildcard, e.g. *@gmail.com
userID	integer	Returns contacts owned by this user
customerID	string	ID of record in client system
lastName	string
company	string
title	string
phone	string
fax	string
city	string
state	string
zipCode	string
country	string
purl	string	Personal URL (PURL) used with emfluence Marketing Platform landing pages. PURLs must be unique per contact. PURLs can contain only letters, numbers, and any of the following characters: .-_!
dobMonth	integer	Month number for date of birth (1-12) Min: 1 Max: 12
dobDay	integer	Day number for date of birth (1-31) Min: 1 Max: 31
dobYear	integer	4-digit year for date of birth Min: 1900 Max: 2024
lastActivityDateStart	datetime	Start date of when contacts viewed or clicked any email
lastActivityDateEnd	datetime	End date of when contacts viewed or clicked any email
lastActivityType	string	Filter contact activity positivly (active) or negatively (inactive). Use with lastActivityDateStart and lastActivityDateEnd Default: active Allowed Values: active, inactive
lastClickDateStart	datetime	Start date of when contacts clicked any email
lastClickDateEnd	datetime	End date of when contacts clicked any email
lastClickType	string	Filter contact click activity positivly (active) or negatively (inactive). Use with lastClickDateStart and lastClickDateEnd Default: active Allowed Values: active, inactive
dateAddedStart	datetime	Start date of when contacts were added
dateAddedEnd	datetime	End date of when contacts were added
dateModifiedStart	datetime	Start date of when contacts were last modified
dateModifiedEnd	datetime	End date of when contacts were last modified
fields	string	Comma-separated list of fields to return. Available fields: address1, address2, city, company, contactID, content1-content10, country, custom1-customX, customerID, dateAdded, dateHeld, dateModified, dateOfBirth, dateSuppressed, email, fax, firstName, held, lastName, mobileNumber, originalSource, phone, purl, state, suppressed, title, userID, zipCode, lastActivityDate, lastClickDate, contactScore, contactScore1-contactScoreX, notes Default: contactID, userID, email, firstName, lastName, suppressed, held, dateAdded, dateModified
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 1000
sortField	string	The field to sort results by Default: email Allowed Values: contactID, email, dateModified, contactScore
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc
custom1 - customX	varies	Custom fields (1 to X). Custom fields are defined per account so the number of fields as well as the data type of each field will vary. Make a call to the customFields/search endpoint for more information.

Access token: *

POST GET customFields/lookup

Get full details for a single custom field by systemName

Param	Value	Type	Description
systemName *		string	Internal name used to identify each custom field (customX)

Access token: *

POST GET customFields/search

Search custom fields

Param	Value	Type	Description
page		integer	Number of page in results to return Default: 1 Min: 1
rpp		integer	Number of records to return per page Default: 25 Min: 1 Max: 250

Access token: *

POST groups/addContacts

Add one or more existing contacts to a group.

Request Body

{"contactIDs":"","groupID":0}

Access token: *

POST groups/delete

Delete single group record. This does not delete contacts records that belong to the group. Groups marked as "protected" cannot be deleted.

Request Body

{"groupID":0}

Access token: *

POST GET groups/getContacts

Get subscription data for contacts in a static group

Param	Type	Description
groupID *	integer	Unique ID of a group
suppressed	boolean	Opted out of recieving emails for the group
dateAddedStart	datetime	Start date of when contacts were added to the group
dateAddedEnd	datetime	End date of when contacts were added to the group
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 100 Min: 1 Max: 1000

Access token: *

POST GET groups/lookup

Get full details for groups

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

Access token: *

POST groups/removeContacts

Remove one or more existing contacts from a group.

Request Body

{"contactIDs":"","groupID":0}

Access token: *

POST groups/save

Add/update a single group record. Dynamic groups cannot be created through the API.

Request Body

{"friendlyName":"","externalID":"","private":"1","notes":"","status":"","userIDs":"","groupID":0,"protected":"0","groupName":"","description":""}

Access token: *

POST GET groups/search

Search groups by various criteria

Param	Type	Description
groupName	string	Matches any part of a group name (i.e. "customer" matches "Retail Customers")
status	string	By default, archived groups are excluded from results. Pass "All" to match any status. Default: Active Allowed Values: Active, Archived, All
groupIDs	array[integer]	Multiple groupIDs
userID	integer	Returns groups that this user has access to
private	boolean	Pass 0 to return groups displayed on contact preferences page
type	string	Default: All Allowed Values: Dynamic, Static, All
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 250
sortField	string	The field to sort results by Default: groupName Allowed Values: groupID, groupName, dateAdded, dateModified, dateLastEmailSent, totalMembers, activeMembers
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

POST emails/cancelSchedule

Cancel a scheduled email send

Request Body

{"emailID":0}

Access token: *

POST emails/copy

Create a copy an existing email and return it as a draft

Request Body

{"emailID":0}

Access token: *

POST emails/delete

Delete an existing email. Deleting a sent email will throw an error.

Request Body

{"emailID":0}

Access token: *

POST GET emails/getActivityLog

Get log of activity for a given email (who, what, when)

Param	Value	Type	Description
emailID *		integer	Unique ID of email

Access token: *

POST GET emails/lookup

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

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: *

POST emails/save

Save content and header information for an email. Can pass an email object (i.e. response from /emails/lookup) or just key/value pairs.

Request Body

{"content":{},"templateID":0,"replyToAddress":"","userID":0,"fromAddress":"","recipients":{},"preheader":"","subject":"","throttling":{},"tracking":{},"fromName":"","htmlVersionEditable":"0","emailID":0,"replyToName":"","title":"","bccAddress":""}

Access token: *

POST emails/schedule

Schedule future delivery of a one-time email send. Equivalent to "sending" a scheduled email. Email must be ready to send.

Request Body

{"emailID":0,"scheduleSendTime":""}

Access token: *

POST GET emails/search

Search emails by various criteria.

Param	Type	Description
deliveryType	string	All searches are filtered by delivery type Default: manual Allowed Values: manual, automated, transactional
status	array[string]	Status only applies when deliveryType is "manual". Ignored for all other deliveryTypes. Default: sent Allowed Values: draft, scheduled, sent
automatedResults	string	AutomatedResults only applies when deliveryType is "automated". Ignored for all other deliveryTypes. Searching by "summary" will return aggregated results for each automated email. Searching by "detail" will return results for each individual send. Default: summary Allowed Values: summary, detail
userID	integer	ID of system user email belongs to
title	string	Searches title field. Use * as a wildcard.
subject	string	Searches subject field. Use * as a wildcard.
dateSentStart	datetime	Emails sent since this date. Defaults to 6 months ago.
dateSentEnd	datetime	Emails sent before this date. Defaults to current date.
emailIDs	array[integer]	Search by emailID (multiples allowed)
parentEmailID	integer	Search by parentEmailID to return the individual sends of an automated or A/B split email.
transactionalCategory	string	Search by transactionalCategory. Only valid when deliveryType is "transactional".
campaignID	integer	Emails assigned to a specific campaign
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 250
sortField	string	The field to sort results by. Default sorting depends on the "status". Sent emails are sorted by dateSent desc (most recently sent first). Scheduled and Draft are sorted by dateAdded desc (newest first). Allowed Values: emailID, userID, title, subject, dateAdded, dateModified, dateSent
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

POST emails/send

Send an existing email to its assigned recipients. The email must first be created using /emails/save. Once an email is sent, it cannot be modified in any way, but it can be copied to a new draft.

Request Body

{"emailID":0}

Access token: *

POST emails/sendTest

Send a test of an existing email to a single recipient.

Request Body

{"recipientEmail":"","emailID":0}

Access token: *

POST emails/sendTransactional

Send a transactional email to a limited number of contacts in a single call. Transactional emails contain information that completes a transaction or process the recipient has started with you. This endpoint should never be used to send marketing emails. To include suppressed contacts, be sure to use the ignoreContactSuppression flag. NOTE: This endpoint must be enabled for your account before use. Please contact support for access.

Request Body

{"ignoreContactSuppression":"0","transactionalCategory":"","contactIDs":"","contacts":[],"email":{}}

Access token: *

POST GET emails/transactionalCategories

Get all transactional categories

Param	Value	Type	Description
page		integer	Number of page in results to return Default: 1 Min: 1
rpp		integer	Number of records to return per page Default: 15 Min: 1 Max: 100

Access token: *

POST GET emailReports/bounces

Get bounce data per contact for a given email

Param	Type	Description
emailID *	integer	ID of email
bounceType	string	Filter by bounce type. SB (soft bounce) returns all bounce types except HB (hard bounce) Allowed Values: HB, SB
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 1000
sortField	string	The field to sort results by Default: date Allowed Values: contactID, email, date
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

POST GET emailReports/bounceSummary

Summary counts of bounces by type for a given email

Param	Value	Type	Description
emailID *		integer	ID of email

Access token: *

POST GET emailReports/clicks

Get link click data per contact for a given email

Param	Type	Description
emailID *	integer	ID of email
link	string	Filter by specific link
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 1000
sortField	string	The field to sort results by Default: date Allowed Values: contactID, email, date
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

POST GET emailReports/clickSummary

Summary of clicks for a given email

Param	Value	Type	Description
emailID *		integer	ID of email

Access token: *

POST GET emailReports/complaints

Contacts who complained about a given email

Param	Type	Description
emailID *	integer	ID of email
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 1000
sortField	string	The field to sort results by Default: date Allowed Values: contactID, email, date
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

POST GET emailReports/deviceSummary

Summary of devices (i.e. Outlook, iPhone) by type (Desktop/Mobile) for a given email (device data only available for recipients who viewed or clicked email)

Param	Value	Type	Description
emailID *		integer	ID of email

Access token: *

POST GET emailReports/domainSummary

Summary metrics of top domains for a given email

Param	Value	Type	Description
emailID *		integer	ID of email

Access token: *

POST GET emailReports/forwards

Contacts who forwarded a given email

Param	Type	Description
emailID *	integer	ID of email
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 1000
sortField	string	The field to sort results by Default: date Allowed Values: contactID, email, date
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

POST GET emailReports/recipients

Get recipients for a given email

Param	Type	Description
emailID *	integer	ID of email
viewed	boolean	Filter by contacts who viewed
clicked	boolean	Filter by contacts who clicked a link
bounced	boolean	Filter by contacts who bounced
bounceType	string	Filter by bounce type. SB (soft bounce) returns all bounce types except HB (hard bounce) Allowed Values: HB, SB
suppressed	boolean	Filter by contacts who opted out
complained	boolean	Filter by contacts who complained
contactFields	string	Comma-separated list of contact fields to return. Available fields: address1, address2, city, company, contactID, content1-content10, country, custom1-customX, customerID, dateAdded, dateHeld, dateModified, dateOfBirth, dateSuppressed, email, fax, firstName, held, lastName, mobileNumber, originalSource, phone, purl, state, suppressed, title, userID, zipCode, lastActivityDate, lastClickDate, contactScore, contactScore1-contactScoreX, notes Default: contactID, email, firstName, lastName
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 1000

Access token: *

POST GET emailReports/shares

Contacts who shared a given email on social networks

Param	Type	Description
emailID *	integer	ID of email
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 1000
sortField	string	The field to sort results by Default: date Allowed Values: contactID, email, date
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

POST GET emailReports/unsubscribes

Contacts who unsubscribed from a given email

Param	Type	Description
emailID *	integer	ID of email
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 1000
sortField	string	The field to sort results by Default: date Allowed Values: contactID, email, date
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

POST GET emailReports/views

Contacts who viewed (opened) a given email

Param	Type	Description
emailID *	integer	ID of email
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 1000
sortField	string	The field to sort results by Default: date Allowed Values: contactID, email, date
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

POST GET emailReports/webviews

Contacts who viewed a given email as a web page

Param	Type	Description
emailID *	integer	ID of email
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 1000
sortField	string	The field to sort results by Default: date Allowed Values: contactID, email, date
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

POST GET templates/lookup

Get full details for email templates

Param	Value	Type	Description
templateID		integer	Unique ID of a template
templateIDs		array[integer]	Multiple templateIDs. Requests that use this parameter will change the response data from a single object to an array of objects.

Access token: *

POST GET templates/search

Search email templates

Param	Type	Description
userID	integer	Get templates for a specific user
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 50
sortField	string	The field to sort results by Default: templateName Allowed Values: templateID, templateName, editableSlots
sortDirection	string	The direction to sort results Default: asc Allowed Values: asc, desc

Access token: *

POST GET users/lookup

Get full details for users by ID or username

Param	Type	Description
userID	integer	Unique ID of a user
userIDs	array[integer]	Multiple userIDs. Requests that use this parameter will change the response data from a single object to an array of objects. Max: 25
username	string	Unique username

Access token: *

POST GET users/search

Search users by various criteria

Param	Type	Description
lastName	string
email	string
userIDs	array[integer]	Multiple userIDs
page	integer	Number of page in results to return Default: 1 Min: 1
rpp	integer	Number of records to return per page Default: 20 Min: 1 Max: 50

Access token: *

POST GET users/self

Get full details for the authenticated user.

Param	Value	Type	Description
Method has no parameters

Access token: *

POST GET exports/contacts

Export contact data

Param	Type	Description
groupID	integer	Return contacts in a given group
lastActivityDate	datetime	Date since contacts viewed or clicked any email
fields	string	Comma-separated list of fields to return. Available fields: address1, address2, city, company, contactID, content1, content2, content3, country, custom1, custom2, ...custom20, customerID, dateAdded, dateHeld, dateModified, dateOfBirth, dateSuppressed, email, fax, firstName, held, lastName, originalSource, phone, purl, state, suppressed, title, userID, zipCode Default: contactID, userID, email, firstName, lastName, suppressed, held, dateAdded

Access token: *

POST GET exports/emailBounces

Get bounce data across email campaigns. Date range cannot span more than 90 days.

Param	Type	Description
startDate *	datetime	Bounces after this date
endDate *	datetime	Bounces before this date
fields	string	Comma-separated list of fields to return. Available fields: id, emailID, parentEmailID, dateBounced, bounceType, contactID, email Default: id, emailID, dateBounced, bounceType, contactID, email

Access token: *

POST GET exports/emailClicks

Get clicks data across email campaigns. Date range cannot span more than 90 days.

Param	Type	Description
startDate *	datetime	Clicks after this date
endDate *	datetime	Clicks before this date
fields	string	Comma-separated list of fields to return. Available fields: id, emailID, parentEmailID, dateClicked, link, contactID, email Default: id, emailID, dateClicked, link, contactID, email

Access token: *

POST GET exports/emailComplaints

Get complaint data across email campaigns. Date range cannot span more than 90 days.

Param	Type	Description
startDate *	datetime	Complaints after this date
endDate *	datetime	Complaints before this date
fields	string	Comma-separated list of fields to return. Available fields: id, emailID, parentEmailID, dateComplained, contactID, email Default: id, emailID, dateComplained, contactID, email

Access token: *

POST GET exports/emailForwards

Get forwards data across email campaigns. Date range cannot span more than 90 days.

Param	Type	Description
startDate *	datetime	Forwards after this date
endDate *	datetime	Forwards before this date
fields	string	Comma-separated list of fields to return. Available fields: id, emailID, parentEmailID, dateForwarded, contactID, email Default: id, emailID, dateForwarded, contactID, email

Access token: *

POST GET exports/emailRecipients

Get recipient data across email campaigns. Date range cannot span more than 90 days.

Param	Type	Description
startDate *	datetime	Emails sent after this date
endDate *	datetime	Emails sent before this date
fields	string	Comma-separated list of fields to return. Available fields: id, emailID, parentEmailID, contactID, email, dateSent Default: id, emailID, contactID, email, dateSent

Access token: *

POST GET exports/emails

Get all metrics for sent emails. Date range cannot span more than 90 days.

Param	Value	Type	Description
startDate *		datetime	Emails sent after this date
endDate *		datetime	Emails sent before this date

Access token: *

POST GET exports/emailShares

Get shares data across email campaigns. Date range cannot span more than 90 days.

Param	Type	Description
startDate *	datetime	Shares after this date
endDate *	datetime	Shares before this date
fields	string	Comma-separated list of fields to return. Available fields: id, emailID, parentEmailID, dateShared, channel, contactID, email Default: id, emailID, dateShared, channel, contactID, email

Access token: *

POST GET exports/emailUnsubscribes

Get unsubscribe data across email campaigns. Date range cannot span more than 90 days.

Param	Type	Description
startDate *	datetime	Unsubscribes after this date
endDate *	datetime	Unsubscribes before this date
fields	string	Comma-separated list of fields to return. Available fields: id, emailID, parentEmailID, dateUnsubscribed, contactID, email Default: id, emailID, dateUnsubscribed, contactID, email

Access token: *

POST GET exports/emailViews

Get views data across email campaigns. Date range cannot span more than 90 days.

Param	Type	Description
startDate *	datetime	Views after this date
endDate *	datetime	Veiws before this date
fields	string	Comma-separated list of fields to return. Available fields: id, emailID, parentEmailID, dateViewed, contactID, email Default: id, emailID, dateViewed, contactID, email

Access token: *

POST GET exports/emailWebViews

Get web views data across email campaigns. Date range cannot span more than 90 days.

Param	Type	Description
startDate *	datetime	Web Views after this date
endDate *	datetime	Web Views before this date
fields	string	Comma-separated list of fields to return. Available fields: id, emailID, parentEmailID, dateViewed, contactID, email Default: id, emailID, dateViewed, contactID, email

Access token: *

POST GET exports/getFile

Get file generated from an export

Sorry, the console is unavailable for this endpoint.

POST GET exports/jobStatus

Check the status of an export job

Param	Value	Type	Description
jobID *		integer	Unique ID of export job

Access token: *

POST GET helper/ping

Use to test API status

Param	Value	Type	Description
Method has no parameters

Access token: *

POST GET helper/systemInfo

Get server information

Param	Value	Type	Description
Method has no parameters

Access token: *

POST GET helper/throw

Manually throw an error. Use to test your application's error handling.

Param	Value	Type	Description
code		integer	Code for a specific error to throw

Access token: *

Console

Contacts

POST GET contacts/activities

POST contacts/delete

POST contacts/deleteGroups

POST GET contacts/getEmailHistory

POST GET contacts/getGroups

POST contacts/import

POST GET contacts/lookup

POST contacts/save

POST contacts/saveGroups

POST GET contacts/search

Custom Fields

POST GET customFields/lookup

POST GET customFields/search

Groups

POST groups/addContacts

POST groups/delete

POST GET groups/getContacts

POST GET groups/lookup

POST groups/removeContacts

POST groups/save

POST GET groups/search

Emails

POST emails/cancelSchedule

POST emails/copy

POST emails/delete

POST GET emails/getActivityLog

POST GET emails/lookup

POST emails/save

POST emails/schedule

POST GET emails/search

POST emails/send

POST emails/sendTest

POST emails/sendTransactional

POST GET emails/transactionalCategories

Email Reports

POST GET emailReports/bounces

POST GET emailReports/bounceSummary

POST GET emailReports/clicks

POST GET emailReports/clickSummary

POST GET emailReports/complaints

POST GET emailReports/deviceSummary

POST GET emailReports/domainSummary

POST GET emailReports/forwards

POST GET emailReports/recipients

POST GET emailReports/shares

POST GET emailReports/unsubscribes

POST GET emailReports/views

POST GET emailReports/webviews

Email Templates

POST GET templates/lookup

POST GET templates/search

Users

POST GET users/lookup

POST GET users/search

POST GET users/self

Bulk Exports

POST GET exports/contacts

POST GET exports/emailBounces

POST GET exports/emailClicks

POST GET exports/emailComplaints

POST GET exports/emailForwards

POST GET exports/emailRecipients

POST GET exports/emails

POST GET exports/emailShares

POST GET exports/emailUnsubscribes

POST GET exports/emailViews

POST GET exports/emailWebViews

POST GET exports/getFile

POST GET exports/jobStatus

Helper

POST GET helper/ping

POST GET helper/systemInfo

POST GET helper/throw