Methods
The following tables is an overview of all the API methods available:
Resource | Resource description | URL | GET | POST | PUT | DELETE |
---|---|---|---|---|---|---|
Time | Time collection. | https://api.esv2.com/v2/Api/Time | Get current server time | |||
Subscribers | Subscribers collection. | https://api.esv2.com/v2/Api/Subscribers | Get subscriber details | Add single subscriber or multiple subscribers | Delete subscriber | |
Messages | Messages collection. | https://api.esv2.com/v2/Api/Messages | Get messages list or single message details | Delete message | ||
MessageStatistics | Message statistics. | https://api.esv2.com/v2/Api/MessageStatistics | Get stats for single message | |||
LinkStatistics | Message links statistics. | https://api.esv2.com/v2/Api/LinkStatistics | Get stats for links in message | |||
VendorStatistics | Vendor statistics. | https://api.esv2.com/v2/Api/VendorStatistics | Get stats for grouped by vendor | |||
SummaryStatistics | Summary statistics. | https://api.esv2.com/v2/Api/SummaryStatistics | Get data | |||
ImportReports | Reports about imports. | https://api.esv2.com/v2/Api/ImportReports | Get data | |||
SubscriberStatistics | Subscriber lists statistics. | https://api.esv2.com/v2/Api/SubscriberStatistics | Get data | |||
SplitTestStatistics | Split test statistics. | https://api.esv2.com/v2/Api/SplitTestStatistics | Get data | |||
Triggers | Triggers collection. | https://api.esv2.com/v2/Api/Triggers | Send trigger messages | |||
Transactionals | Transactional messages collection. | https://api.esv2.com/v2/Api/Transactionals | Send transactional message | |||
TransactionalsCreate | Creates transactional message. | https://api.esv2.com/v2/Api/TransactionalsCreate | Create transactional message | |||
TransactionalsUpdate | Updates transactional message. | https://api.esv2.com/v2/Api/TransactionalsUpdate | Update transactional message | |||
SystemTransactionals | System transactional messages collection. | https://api.esv2.com/v2/Api/SystemTransactionals | Send system transactional messages | |||
ActiveTransactionals | Active transactional messages collection. | https://api.esv2.com/v2/Api/ActiveTransactionals | Get active transactionals | |||
Snippets | Snippets collection. | https://api.esv2.com/v2/Api/Snippets | Get snippets | |||
SuppressionLists | Suppression lists collection. | https://api.esv2.com/v2/Api/SuppressionLists | Add entry to a suppression list | Delete entry from suppression list | ||
CreateSuppressionList | Creates suppression list | https://api.esv2.com/v2/Api/CreateSuppressionList | Create suppression list | |||
Activities | Subscriber activities collection. | https://api.esv2.com/v2/Api/Activities | Get subscriber activity log | |||
Lists | Subscriber lists collection. | https://api.esv2.com/v2/Api/Lists | Get subscriber lists | Creating a new subscriber list | Update subscribers list | |
Segments | Subscriber segments collection. | https://api.esv2.com/v2/Api/Segments | Get subscriber segments | |||
GetSegmentSize | Get size of a segment. | https://api.esv2.com/v2/Api/GetSegmentSize | Get segment size | |||
ImportToListTasks | Imports to subscriber list collection. | https://api.esv2.com/v2/Api/ImportToListTasks | Get import task status and info | Scheduling a new import | ||
ImportToListRejected | Subscribers rejected during imports collection | https://api.esv2.com/v2/Api/ImportToListRejected | Get list of rejected subscribers | |||
ImportToDataTableTasks | Imports to Data Tables collection | https://api.esv2.com/v2/Api/ImportToDataTableTasks | Get import task status and info | Scheduling a new import | ||
Newsletters | Newsletters collection. | https://api.esv2.com/v2/Api/Newsletters | Create new newsletter | Pause or resume newsletter | ||
Fields | Custom fields collection. | https://api.esv2.com/v2/Api/Fields | Get list of custom fields | |||
Templates | Templates collection. | https://api.esv2.com/v2/Api/Templates | Get list of templates | |||
Headers | Headers collection. | https://api.esv2.com/v2/Api/Headers | Create header | Edit header | Delete header | |
Footers | Footers collection. | https://api.esv2.com/v2/Api/Footers | Create footer | Edit footer | Delete footer | |
RemovedSubscribers | Removed subscribers collection. | https://api.esv2.com/v2/Api/RemovedSubscribers | Get list of removed subscribers | |||
SnoozedSubscribers | Snoozed subscribers collection. | https://api.esv2.com/v2/Api/SnoozedSubscribers | Get list of snoozed subscribers | Snooze subscriber | Unsnooze subscriber | |
UnconfirmedSubscribers | Unconfirmed subscribers collection | https://api.esv2.com/v2/Api/UnconfirmedSubscribers | Get list of unconfirmed subscribers | |||
Bounces | Bounced emails | https://api.esv2.com/v2/Api/Bounces | Get bounces list | |||
Goals | Business goals collection. | https://api.esv2.com/v2/Api/Goals | Fulfill a goal | |||
Exports | Exports collection. | https://api.esv2.com/v2/Api/Exports | Get export information | Start a new export | ||
DataTablesGetTables | Data tables collection. | https://api.esv2.com/v2/Api/DataTablesGetTables | Get list of tables | |||
DataTablesGetData | Data in a data table. | https://api.esv2.com/v2/Api/DataTablesGetData | Get data | |||
DataTablesGetDataCount | Count of records in a data table. | https://api.esv2.com/v2/Api/DataTablesGetDataCount | Count rows | |||
DataTablesClearTable | Clear a data table. | https://api.esv2.com/v2/Api/DataTablesClearTable | Clear table | |||
DataTablesAddRow | Add row of data to a data table. | https://api.esv2.com/v2/Api/DataTablesAddRow | Add row | |||
DataTableAddMultipleRows | Add multiple rows of data to a data table. | https://api.esv2.com/v2/Api/DataTablesAddMultipleRows | Add multiple rows | |||
DataTablesUpdateRow | Update row of data in a data table. | https://api.esv2.com/v2/Api/DataTablesUpdateRow | Update row | |||
DataTablesUpdateMultipleRows | Update multiple rows of data to a data table. | https://api.esv2.com/v2/Api/DataTablesUpdateMultipleRows | Update multiple rows | |||
DataTablesDeleteRow | Delete row of data in a data table. | https://api.esv2.com/v2/Api/DataTablesDeleteRow | Delete row | |||
WorkflowCustomEvents | Workflow custom events. | https://api.esv2.com/v2/Api/WorkflowCustomEvents | Trigger a custom event | |||
SignalSpamStatistics | SignalSpam statistics. | https://api.esv2.com/v2/Api/SignalSpamStatistics | Get SignalSpam statistics | |||
SmsMmsMessages | SMS/MMS messages collection. | https://api.esv2.com/v2/Api/SmsMmsMessages | Get messages list | Delete message | ||
SmsMmsNewsletters | SMS/MMS newsletters collection. | https://api.esv2.com/v2/Api/SmsMmsNewsletters | Create and send newsletter | Pause or resume newsletter | ||
SmsMmsLinkStatistics | Link clicks statistics for a single SMS/MMS message. | https://api.esv2.com/v2/Api/SmsMmsLinkStatistics | Get data | |||
SmsMmsMessageStatistics | Generic statistics (sends, clicks etc) for single SMS/MMS message. | https://api.esv2.com/v2/Api/SmsMmsMessageStatistics | Get data | |||
SmsMmsSummaryStatistics | SMS/MMS full aggregated statistics with advanced grouping, filtering etc. | https://api.esv2.com/v2/Api/SmsMmsSummaryStatistics | Get data | |||
SmsMmsSubscriberStatistics | SMS/MMS subscriber lists statistics. | https://api.esv2.com/v2/Api/SmsMmsSubscriberStatistics | Get data | |||
PanelLogs | List of panel logs. | https://api.esv2.com/v2/Api/PanelLogs | Get panel logs | |||
UsersLogins | Get user login details. | https://api.esv2.com/v2/Api/UsersLogins | Get user logins details | |||
CheckMessageContent | Allows to check message content domain links on blacklist | https://api.esv2.com/v2/Api/CheckMessageContent | Get message content check status | Create message content check task |
* Unsubscribes, Removals and User Unknowns collections were substituted by RemovedSubscribers collection. New collection is more flexible and allows retrieving list of subscribers that were removed from lists for any reason.
Deprecated methods will be still available for some time in the API, but you are encouraged to migrate to new methods as soon as possible.
If you integrate with the API for the first time, please DO NOT use deprecated methods.