Contacts
Activities
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.
Delete
POST contacts/delete
Delete an existing contact record.
Delete Groups
POST contacts/deleteGroups
Remove contact from the groups provided. ContactID or email is required.
Email History
POST GET contacts/getEmailHistory
Get emails sent to a single contact. ContactID or email is required.
Groups
POST GET contacts/getGroups
Get groups for a single contact. ContactID or email is required.
Import
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.
Lookup
POST GET contacts/lookup
Get full details for contacts by either contactID or email
Save
POST contacts/save
Save a single contact record. ContactID or email is required. Only data for parameters passed in is saved.
Save Groups
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.
Search
POST GET contacts/search
Search contacts by various criteria
Custom Fields
Emails
How To: Build email content Send marketing emails Send transactional emails Send automated emails
Cancel Schedule
POST emails/cancelSchedule
Cancel a scheduled email send
Copy
POST emails/copy
Create a copy an existing email and return it as a draft
Delete
POST emails/delete
Delete an existing email. Deleting a sent email will throw an error.
Activity Log
POST GET emails/getActivityLog
Get log of activity for a given email (who, what, when)
Lookup
POST GET emails/lookup
Get full details for emails, including high-level deliverability metrics (for sent emails)
Save
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.
Schedule
POST emails/schedule
Schedule future delivery of a one-time email send. Equivalent to "sending" a scheduled email. Email must be ready to send.
Search
POST GET emails/search
Search emails by various criteria.
Send
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.
Send Test
POST emails/sendTest
Send a test of an existing email to a single recipient.
Send Transactional
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.
Transactional Categories
POST GET emails/transactionalCategories
Get all transactional categories
Email Reports
Bounces
POST GET emailReports/bounces
Get bounce data per contact for a given email
Bounce Summary
POST GET emailReports/bounceSummary
Summary counts of bounces by type for a given email
Clicks
POST GET emailReports/clicks
Get link click data per contact for a given email
Click Summary
POST GET emailReports/clickSummary
Summary of clicks for a given email
Complaints
POST GET emailReports/complaints
Contacts who complained about a given email
Device Summary
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)
Domain Summary
POST GET emailReports/domainSummary
Summary metrics of top domains for a given email
Forwards
POST GET emailReports/forwards
Contacts who forwarded a given email
Recipient Search
POST GET emailReports/recipients
Get recipients for a given email
Shares
POST GET emailReports/shares
Contacts who shared a given email on social networks
Unsubscribes
POST GET emailReports/unsubscribes
Contacts who unsubscribed from a given email
Views
POST GET emailReports/views
Contacts who viewed (opened) a given email
Web Views
POST GET emailReports/webviews
Contacts who viewed a given email as a web page
Groups
Add Contacts
POST groups/addContacts
Add one or more existing contacts to a group.
Delete
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.
Get Contacts
POST GET groups/getContacts
Get subscription data for contacts in a static group
Lookup
POST GET groups/lookup
Get full details for groups
Remove Contacts
POST groups/removeContacts
Remove one or more existing contacts from a group.
Save
POST groups/save
Add/update a single group record. Dynamic groups cannot be created through the API.
Search
POST GET groups/search
Search groups by various criteria
SMS
Activate
POST sms/activate
For manual SMS, begin sending to assigned recipients according to the date scheduled (if none, sending will begin ASAP). For automated SMS, enable sending when workflow trigger fires. SMS records can be created using /sms/save.
Lookup
POST GET sms/lookup
Get full details of an SMS record
Messaging Services
POST GET sms/messagingServices
Get all SMS messaging services
Recipients
POST GET sms/recipients
Get recipients for a given SMS
Recipients Summary
POST GET sms/recipientsSummary
Get summary metrics for a given SMS
Save
POST sms/save
Save a single SMS record.
Search
POST GET sms/search
Search SMS by various criteria
Templates
Users
Exports
Bulk export methods are for large data sets not easily retrieved via normal API calls. Export Process Overview
Contacts
POST GET exports/contacts
Export contact data
Email Bounces
POST GET exports/emailBounces
Get bounce data across email campaigns. Date range cannot span more than 90 days.
Email Clicks
POST GET exports/emailClicks
Get clicks data across email campaigns. Date range cannot span more than 90 days.
Email Complaints
POST GET exports/emailComplaints
Get complaint data across email campaigns. Date range cannot span more than 90 days.
Email Forwards
POST GET exports/emailForwards
Get forwards data across email campaigns. Date range cannot span more than 90 days.
Email Recipients
POST GET exports/emailRecipients
Get recipient data across email campaigns. Date range cannot span more than 90 days.
Emails
POST GET exports/emails
Get all metrics for sent emails. Date range cannot span more than 90 days.
Email Shares
POST GET exports/emailShares
Get shares data across email campaigns. Date range cannot span more than 90 days.
Email Unsubscribes
POST GET exports/emailUnsubscribes
Get unsubscribe data across email campaigns. Date range cannot span more than 90 days.
Email Views
POST GET exports/emailViews
Get views data across email campaigns. Date range cannot span more than 90 days.
Email Web Views
POST GET exports/emailWebViews
Get web views data across email campaigns. Date range cannot span more than 90 days.
Get Export File
POST GET exports/getFile
Get file generated from an export
Job Status
POST GET exports/jobStatus
Check the status of an export job