Jump to Content

v1

API Reference

v1API Reference

Main

Litmus API Docs

Instant

Instant API
Create an emailpost
List supported email clientsget
List supported email client configurationsget
Request a previewget
Directly request a preview imageget
Delete an email and its previewsdel
Pre-request previews before downloadpost
Identifying End Users
Performance

Email Analytics

Email Analytics API
Creating a campaignpost
Get campaign meta datapost
Update a campaignput
Activate a campaignput
Summary reports
Open counts reports (guid)post
Open count reports (month)post
Open count reports (range)post
Advanced open counts reportpost
Engagement reports
Engagement reportget
Detailed engagement reportget
Group engagement reportget
Mail client engagement reportget
Detailed mail client engagement reportget
Platform reports
Mail client usage reportget
Group usage reportget
Browser usage reportget
Rendering category reportget
Geolocation Reportget
Activity reports
Activity summary reportget
Activity reportget
Getting raw data
Request the data via emailput
FTP / SFTP

Real-time Callbacks

Litmus Real-time Callbacks
Configure Endpointpost
Subscribe Campaignput
Unsubscribe Campaignput
Example of Notification

Legacy Previews

Legacy Previews API
Create testpost
Retrieve testget
Testing applicationsget
Resultget
Spam seed addressesget
Link testsget
Using mobile results
Index

OAuth

OAuth Integration Guide
Request user identity dataget
List a user's default email clientsget
Request a user-specific client configuration URLget

Instant API

Getting Started With Your API

List supported email client configurations

get

https://instant-api.litmus.com/v1/clients/configurations

Returns a JSON hash detailing available options for each client.

Language