Make calls to API endpoints without the need for a REST client. Just click on an endpoint to see available parameters. An active access token is required. If you don't have one, please contact your account representative.
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 an existing contact record.
Remove contact from the groups provided. ContactID or email is required.
POST GET contacts/getEmailHistory
Get emails sent to a single contact. ContactID or email is required.
POST GET contacts/getGroups
Get groups for a single contact. ContactID or email is required.
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.
POST GET contacts/lookup
Get full details for contacts by either contactID or email
Save a single contact record. ContactID or email is required. Only data for parameters passed in is saved.
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.
POST GET contacts/search
Search contacts by various criteria
POST GET customFields/lookup
Get full details for a single custom field by systemName
POST GET customFields/search
Search custom fields
Add one or more existing contacts to a group.
Delete single group record. This does not delete contacts records that belong to the group. Groups marked as "protected" cannot be deleted.
POST GET groups/lookup
Get full details for groups
Remove one or more existing contacts from a group.
Add/update a single group record. Dynamic groups cannot be created through the API.
POST GET groups/search
Search groups by various criteria
Cancel a scheduled email send
Create a copy an existing email and return it as a draft
Delete an existing email. Deleting a sent email will throw an error.
POST GET emails/getActivityLog
Get log of activity for a given email (who, what, when)
POST GET emails/lookup
Get full details for emails, including high-level deliverability metrics (for sent emails)
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 future delivery of a one-time email send. Equivalent to "sending" a scheduled email. Email must be ready to send.
POST GET emails/search
Search emails by various criteria.
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 a test of an existing email to a single recipient.
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.
POST GET emails/transactionalCategories
Get all transactional categories
POST GET emailReports/bounces
Get bounce data per contact for a given email
POST GET emailReports/bounceSummary
Summary counts of bounces by type for a given email
POST GET emailReports/clicks
Get link click data per contact for a given email
POST GET emailReports/clickSummary
Summary of clicks for a given email
POST GET emailReports/complaints
Contacts who complained about a given email
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)
POST GET emailReports/domainSummary
Summary metrics of top domains for a given email
POST GET emailReports/forwards
Contacts who forwarded a given email
POST GET emailReports/recipients
Get recipients for a given email
POST GET emailReports/shares
Contacts who shared a given email on social networks
POST GET emailReports/unsubscribes
Contacts who unsubscribed from a given email
POST GET emailReports/views
Contacts who viewed (opened) a given email
POST GET emailReports/webviews
Contacts who viewed a given email as a web page
POST GET templates/lookup
Get full details for email templates
POST GET templates/search
Search email templates
POST GET users/lookup
Get full details for users by ID or username
POST GET users/search
Search users by various criteria
POST GET users/self
Get full details for the authenticated user.
POST GET exports/contacts
Export contact data
POST GET exports/emailBounces
Get bounce data across email campaigns. Date range cannot span more than 90 days.
POST GET exports/emailClicks
Get clicks data across email campaigns. Date range cannot span more than 90 days.
POST GET exports/emailComplaints
Get complaint data across email campaigns. Date range cannot span more than 90 days.
POST GET exports/emailForwards
Get forwards data across email campaigns. Date range cannot span more than 90 days.
POST GET exports/emailRecipients
Get recipient data across email campaigns. Date range cannot span more than 90 days.
POST GET exports/emails
Get all metrics for sent emails. Date range cannot span more than 90 days.
POST GET exports/emailShares
Get shares data across email campaigns. Date range cannot span more than 90 days.
POST GET exports/emailUnsubscribes
Get unsubscribe data across email campaigns. Date range cannot span more than 90 days.
POST GET exports/emailViews
Get views data across email campaigns. Date range cannot span more than 90 days.
POST GET exports/emailWebViews
Get web views data across email campaigns. Date range cannot span more than 90 days.
POST GET exports/getFile
Get file generated from an export
POST GET exports/jobStatus
Check the status of an export job
POST GET helper/ping
Use to test API status
POST GET helper/systemInfo
Get server information
POST GET helper/throw
Manually throw an error. Use to test your application's error handling.