Перейти к содержимому

Methods

The following tables is an overview of all the API methods available:

ResourceResource descriptionURLGETPOSTPUTDELETE
TimeTime collection.https://api.esv2.com/v2/Api/Time Get current server time    
SubscribersSubscribers collection.https://api.esv2.com/v2/Api/Subscribers
Get subscriber detailsAdd single subscriber or multiple subscribersDelete subscriber
MessagesMessages collection.https://api.esv2.com/v2/Api/Messages
Get messages list or single message detailsDelete message
MessageStatisticsMessage statistics.https://api.esv2.com/v2/Api/MessageStatisticsGet stats for single message
LinkStatisticsMessage links statistics.https://api.esv2.com/v2/Api/LinkStatisticsGet stats for links in message
VendorStatisticsVendor statistics.https://api.esv2.com/v2/Api/VendorStatisticsGet stats for grouped by vendor
SummaryStatisticsSummary statistics.https://api.esv2.com/v2/Api/SummaryStatisticsGet data   
ImportReportsReports about imports.https://api.esv2.com/v2/Api/ImportReportsGet data   
SubscriberStatisticsSubscriber lists statistics.https://api.esv2.com/v2/Api/SubscriberStatisticsGet data   
SplitTestStatisticsSplit test statistics.https://api.esv2.com/v2/Api/SplitTestStatisticsGet data   
TriggersTriggers collection.https://api.esv2.com/v2/Api/TriggersSend trigger messages
TransactionalsTransactional messages collection.https://api.esv2.com/v2/Api/TransactionalsSend transactional message
TransactionalsCreateCreates transactional message.https://api.esv2.com/v2/Api/TransactionalsCreate Create transactional message  
TransactionalsUpdateUpdates transactional message.https://api.esv2.com/v2/Api/TransactionalsUpdate Update transactional message 
SystemTransactionalsSystem transactional messages collection.https://api.esv2.com/v2/Api/SystemTransactionals Send system transactional messages  
ActiveTransactionalsActive transactional messages collection.https://api.esv2.com/v2/Api/ActiveTransactionalsGet active transactionals   
SnippetsSnippets collection.https://api.esv2.com/v2/Api/SnippetsGet snippets   
SuppressionListsSuppression lists collection.https://api.esv2.com/v2/Api/SuppressionListsAdd entry to a suppression listDelete entry from suppression list
CreateSuppressionListCreates suppression listhttps://api.esv2.com/v2/Api/CreateSuppressionList Create suppression list  
ActivitiesSubscriber activities collection.https://api.esv2.com/v2/Api/ActivitiesGet subscriber activity log
ListsSubscriber lists collection.https://api.esv2.com/v2/Api/ListsGet subscriber listsCreating a new subscriber listUpdate subscribers list
SegmentsSubscriber segments collection.https://api.esv2.com/v2/Api/SegmentsGet subscriber segments   
GetSegmentSizeGet size of a segment. https://api.esv2.com/v2/Api/GetSegmentSizeGet segment size   
ImportToListTasksImports to subscriber list collection.https://api.esv2.com/v2/Api/ImportToListTasksGet import task status and infoScheduling a new import
ImportToListRejectedSubscribers rejected during imports collection https://api.esv2.com/v2/Api/ImportToListRejectedGet list of rejected subscribers   
ImportToDataTableTasksImports to Data Tables collectionhttps://api.esv2.com/v2/Api/ImportToDataTableTasksGet import task status and infoScheduling a new import  
NewslettersNewsletters collection.https://api.esv2.com/v2/Api/NewslettersCreate new newsletterPause or resume newsletter
FieldsCustom fields collection.https://api.esv2.com/v2/Api/FieldsGet list of custom fields    
TemplatesTemplates collection.https://api.esv2.com/v2/Api/TemplatesGet list of templates   
HeadersHeaders collection.https://api.esv2.com/v2/Api/HeadersCreate headerEdit headerDelete header
FootersFooters collection.https://api.esv2.com/v2/Api/FootersCreate footerEdit footerDelete footer
RemovedSubscribersRemoved subscribers collection.https://api.esv2.com/v2/Api/RemovedSubscribersGet list of removed subscribers
SnoozedSubscribersSnoozed subscribers collection.https://api.esv2.com/v2/Api/SnoozedSubscribersGet list of snoozed subscribersSnooze subscriber Unsnooze subscriber
UnconfirmedSubscribersUnconfirmed subscribers collectionhttps://api.esv2.com/v2/Api/UnconfirmedSubscribersGet list of unconfirmed subscribers   
BouncesBounced emailshttps://api.esv2.com/v2/Api/BouncesGet bounces list   
GoalsBusiness goals collection.https://api.esv2.com/v2/Api/GoalsFulfill a goal           
ExportsExports collection.https://api.esv2.com/v2/Api/ExportsGet export informationStart a new export  
DataTablesGetTablesData 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  
DataTablesGetDataCountCount of records in a data table.https://api.esv2.com/v2/Api/DataTablesGetDataCount Count rows  
DataTablesClearTableClear a data table.https://api.esv2.com/v2/Api/DataTablesClearTableClear table   
DataTablesAddRowAdd row of data to a data table.https://api.esv2.com/v2/Api/DataTablesAddRow Add row  
DataTableAddMultipleRowsAdd multiple rows of data to a data table.https://api.esv2.com/v2/Api/DataTablesAddMultipleRows Add multiple rows  
DataTablesUpdateRowUpdate row of data in a data table.https://api.esv2.com/v2/Api/DataTablesUpdateRow Update row  
DataTablesUpdateMultipleRowsUpdate multiple rows of data to a data table.https://api.esv2.com/v2/Api/DataTablesUpdateMultipleRows Update multiple rows  
DataTablesDeleteRowDelete row of data in a data table.https://api.esv2.com/v2/Api/DataTablesDeleteRow Delete row  
WorkflowCustomEventsWorkflow custom events.https://api.esv2.com/v2/Api/WorkflowCustomEventsTrigger a custom event   
SignalSpamStatisticsSignalSpam statistics.https://api.esv2.com/v2/Api/SignalSpamStatisticsGet SignalSpam statistics   
SmsMmsMessagesSMS/MMS messages collection.https://api.esv2.com/v2/Api/SmsMmsMessagesGet messages list  Delete message
SmsMmsNewslettersSMS/MMS newsletters collection.https://api.esv2.com/v2/Api/SmsMmsNewsletters Create and send newsletterPause or resume newsletter 
SmsMmsLinkStatisticsLink clicks statistics for a single SMS/MMS message.https://api.esv2.com/v2/Api/SmsMmsLinkStatisticsGet data   
SmsMmsMessageStatisticsGeneric statistics (sends, clicks etc) for single SMS/MMS message.https://api.esv2.com/v2/Api/SmsMmsMessageStatisticsGet data   
SmsMmsSummaryStatisticsSMS/MMS full aggregated statistics with advanced grouping, filtering etc.https://api.esv2.com/v2/Api/SmsMmsSummaryStatisticsGet data   
SmsMmsSubscriberStatisticsSMS/MMS subscriber lists statistics.https://api.esv2.com/v2/Api/SmsMmsSubscriberStatisticsGet data   
PanelLogsList of panel logs.https://api.esv2.com/v2/Api/PanelLogsGet panel logs   
UsersLoginsGet user login details.https://api.esv2.com/v2/Api/UsersLoginsGet user logins details   
CheckMessageContentAllows to check message content domain links on blacklisthttps://api.esv2.com/v2/Api/CheckMessageContentGet message content check statusCreate 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.