{"id":3548,"date":"2023-08-25T13:11:56","date_gmt":"2023-08-25T12:11:56","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3548"},"modified":"2024-04-25T11:47:56","modified_gmt":"2024-04-25T10:47:56","slug":"methods","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/","title":{"rendered":"Methods"},"content":{"rendered":"\n

The following tables is an overview of all the API methods available:<\/p>\n\n\n\n

Resource<\/th>Resource description<\/th>URL<\/th>GET<\/th>POST<\/th>PUT<\/th>DELETE<\/th><\/tr><\/thead>
Time<\/td>Time collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Time <\/td>Get current server time<\/a>\u00a0<\/td> <\/td> <\/td> <\/td><\/tr>
Subscribers<\/td>Subscribers collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Subscribers
<\/td>		Get subscriber details<\/a><\/td>Add single subscriber or multiple subscribers<\/a><\/td><\/td>Delete subscriber<\/a><\/td><\/tr>
Messages<\/td>Messages collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Messages
<\/td>		Get messages list or single message details<\/a><\/td><\/td><\/td>Delete message<\/a><\/td><\/tr>
MessageStatistics<\/td>Message statistics.<\/td>https:\/\/api.esv2.com\/v2\/Api\/MessageStatistics<\/td>Get stats for single message<\/a><\/td><\/td><\/td><\/td><\/tr>
LinkStatistics<\/td>Message links statistics.<\/td>https:\/\/api.esv2.com\/v2\/Api\/LinkStatistics<\/td>Get stats for links in message<\/a><\/td><\/td><\/td><\/td><\/tr>
VendorStatistics<\/td>Vendor statistics.<\/td>https:\/\/api.esv2.com\/v2\/Api\/VendorStatistics<\/td>Get stats for grouped by vendor<\/a><\/td><\/td><\/td><\/td><\/tr>
SummaryStatistics<\/td>Summary statistics.<\/td>https:\/\/api.esv2.com\/v2\/Api\/SummaryStatistics<\/td>Get data<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
ImportReports<\/td>Reports about imports.<\/td>https:\/\/api.esv2.com\/v2\/Api\/ImportReports<\/td>Get data<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
SubscriberStatistics<\/td>Subscriber lists statistics.<\/td>https:\/\/api.esv2.com\/v2\/Api\/SubscriberStatistics<\/td>Get data<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
SplitTestStatistics<\/td>Split test statistics.<\/td>https:\/\/api.esv2.com\/v2\/Api\/SplitTestStatistics<\/td>Get data<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
Triggers<\/td>Triggers collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Triggers<\/td><\/td>Send trigger messages<\/a><\/td><\/td><\/td><\/tr>
Transactionals<\/td>Transactional messages collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Transactionals<\/td><\/td>Send transactional message<\/a><\/td><\/td><\/td><\/tr>
TransactionalsCreate<\/td>Creates transactional message.<\/td>https:\/\/api.esv2.com\/v2\/Api\/TransactionalsCreate<\/td> <\/td>Create transactional message<\/a><\/td> <\/td> <\/td><\/tr>
TransactionalsUpdate<\/td>Updates transactional message.<\/td>https:\/\/api.esv2.com\/v2\/Api\/TransactionalsUpdate<\/td> <\/td><\/td>Update transactional message<\/a><\/td> <\/td><\/tr>
SystemTransactionals<\/td>System transactional messages collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/SystemTransactionals<\/td> <\/td>Send system transactional messages<\/a><\/td> <\/td> <\/td><\/tr>
ActiveTransactionals<\/td>Active transactional messages collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/ActiveTransactionals<\/td>Get active transactionals<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
Snippets<\/td>Snippets collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Snippets<\/td>Get snippets<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
SuppressionLists<\/td>Suppression lists collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/SuppressionLists<\/td><\/td>Add entry to a suppression list<\/a><\/td><\/td>Delete entry from suppression list<\/a><\/td><\/tr>
CreateSuppressionList<\/td>Creates suppression list<\/td>https:\/\/api.esv2.com\/v2\/Api\/CreateSuppressionList<\/td> <\/td>Create suppression list<\/a><\/td> <\/td> <\/td><\/tr>
Activities<\/td>Subscriber activities collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Activities<\/td>Get subscriber activity log<\/a><\/td><\/td><\/td><\/td><\/tr>
Lists<\/td>Subscriber lists collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Lists<\/td>Get subscriber lists<\/a><\/td>Creating a new subscriber list<\/a><\/td>Update subscribers list<\/a><\/td><\/td><\/tr>
Segments<\/td>Subscriber segments collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Segments<\/td>Get subscriber segments<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
GetSegmentSize<\/td>Get size of a segment.<\/td> https:\/\/api.esv2.com\/v2\/Api\/GetSegmentSize<\/td>Get segment size<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
ImportToListTasks<\/td>Imports to subscriber list collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/ImportToListTasks<\/td>Get import task status and info<\/a><\/td>Scheduling a new import<\/a><\/td><\/td><\/td><\/tr>
ImportToListRejected<\/td>Subscribers rejected during imports collection <\/td>https:\/\/api.esv2.com\/v2\/Api\/ImportToListRejected<\/td>Get list of rejected subscribers<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
ImportToDataTableTasks<\/td>Imports to Data Tables collection<\/td>https:\/\/api.esv2.com\/v2\/Api\/ImportToDataTableTasks<\/td>Get import task status and info<\/a><\/td>Scheduling a new import<\/a><\/td> <\/td> <\/td><\/tr>
Newsletters<\/td>Newsletters collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Newsletters<\/td><\/td>Create new newsletter<\/a><\/td>Pause or resume newsletter<\/a><\/td><\/td><\/tr>
Fields<\/td>Custom fields collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Fields<\/td>Get list of custom fields<\/a> <\/td> <\/td> <\/td> <\/td><\/tr>
Templates<\/td>Templates collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Templates<\/td>Get list of templates<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
Headers<\/td>Headers collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Headers<\/td><\/td>Create header<\/a><\/td>Edi<\/a>t<\/a> header<\/a><\/td>Delete header<\/a><\/td><\/tr>
Footers<\/td>Footers collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Footers<\/td><\/td>Create footer<\/a><\/td>Edit footer<\/a><\/td>Delete footer<\/a><\/td><\/tr>
RemovedSubscribers<\/td>Removed subscribers collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/RemovedSubscribers<\/td>Get list of removed subscribers<\/a><\/td><\/td><\/td><\/td><\/tr>
SnoozedSubscribers<\/td>Snoozed subscribers collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/SnoozedSubscribers<\/td>Get list of snoozed subscribers<\/a><\/td>Snooze subscriber<\/a><\/td> <\/td>Unsnooze subscriber<\/a><\/td><\/tr>
UnconfirmedSubscribers<\/td>Unconfirmed subscribers collection<\/td>https:\/\/api.esv2.com\/v2\/Api\/UnconfirmedSubscribers<\/td>Get list of unconfirmed subscribers<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
Bounces<\/td>Bounced emails<\/td>https:\/\/api.esv2.com\/v2\/Api\/Bounces<\/td>Get bounces list<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
Goals<\/td>Business goals collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Goals<\/td><\/td>Fulfill a goal<\/a> <\/td> <\/td>         <\/td><\/tr>
Exports<\/td>Exports collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/Exports<\/td>Get export information<\/a><\/td>Start a new export<\/a><\/td> <\/td> <\/td><\/tr>
DataTablesGetTables<\/td>Data tables collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/DataTablesGetTables    <\/td>Get list of tables<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
DataTablesGetData         <\/td>Data in a data table.<\/td>https:\/\/api.esv2.com\/v2\/Api\/DataTablesGetData<\/td> <\/td>Get data<\/a><\/td> <\/td> <\/td><\/tr>
DataTablesGetDataCount<\/td>Count of records in a data table.<\/td>https:\/\/api.esv2.com\/v2\/Api\/DataTablesGetDataCount<\/td> <\/td>Count rows<\/a><\/td> <\/td> <\/td><\/tr>
DataTablesClearTable<\/td>Clear a data table.<\/td>https:\/\/api.esv2.com\/v2\/Api\/DataTablesClearTable<\/td><\/td>Clear table<\/a> <\/td> <\/td> <\/td><\/tr>
DataTablesAddRow<\/td>Add row of data to a data table.<\/td>https:\/\/api.esv2.com\/v2\/Api\/DataTablesAddRow<\/td> <\/td>Add row<\/a><\/td> <\/td> <\/td><\/tr>
DataTableAddMultipleRows<\/td>Add multiple rows of data to a data table.<\/td>https:\/\/api.esv2.com\/v2\/Api\/DataTablesAddMultipleRows<\/td> <\/td>Add multiple rows<\/a><\/td> <\/td> <\/td><\/tr>
DataTablesUpdateRow<\/td>Update row of data in a data table.<\/td>https:\/\/api.esv2.com\/v2\/Api\/DataTablesUpdateRow<\/td> <\/td>Update row<\/a><\/td> <\/td> <\/td><\/tr>
DataTablesUpdateMultipleRows<\/td>Update multiple rows of data to a data table.<\/td>https:\/\/api.esv2.com\/v2\/Api\/DataTablesUpdateMultipleRows<\/td> <\/td>Update multiple rows<\/a><\/td> <\/td> <\/td><\/tr>
DataTablesDeleteRow<\/td>Delete row of data in a data table.<\/td>https:\/\/api.esv2.com\/v2\/Api\/DataTablesDeleteRow<\/td> <\/td>Delete row<\/a><\/td> <\/td> <\/td><\/tr>
WorkflowCustomEvents<\/td>Workflow custom events.<\/td>https:\/\/api.esv2.com\/v2\/Api\/WorkflowCustomEvents<\/td><\/td>Trigger a custom event<\/a> <\/td> <\/td> <\/td><\/tr>
SignalSpamStatistics<\/td>SignalSpam statistics.<\/td>https:\/\/api.esv2.com\/v2\/Api\/SignalSpamStatistics<\/td>Get SignalSpam statistics<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
SmsMmsMessages<\/td>SMS\/MMS messages collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/SmsMmsMessages<\/td>Get messages list<\/a><\/td> <\/td> <\/td>Delete message<\/a><\/td><\/tr>
SmsMmsNewsletters<\/td>SMS\/MMS newsletters collection.<\/td>https:\/\/api.esv2.com\/v2\/Api\/SmsMmsNewsletters<\/td> <\/td>Create and send newsletter<\/a><\/td>Pause or resume newsletter<\/a><\/td> <\/td><\/tr>
SmsMmsLinkStatistics<\/td>Link clicks statistics for a single SMS\/MMS message.<\/td>https:\/\/api.esv2.com\/v2\/Api\/SmsMmsLinkStatistics<\/td>Get data<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
SmsMmsMessageStatistics<\/td>Generic statistics (sends, clicks etc) for single SMS\/MMS message.<\/td>https:\/\/api.esv2.com\/v2\/Api\/SmsMmsMessageStatistics<\/td>Get data<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
SmsMmsSummaryStatistics<\/td>SMS\/MMS full aggregated statistics with advanced grouping, filtering etc.<\/td>https:\/\/api.esv2.com\/v2\/Api\/SmsMmsSummaryStatistics<\/td>Get data<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
SmsMmsSubscriberStatistics<\/td>SMS\/MMS subscriber lists statistics.<\/td>https:\/\/api.esv2.com\/v2\/Api\/SmsMmsSubscriberStatistics<\/td>Get data<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
PanelLogs<\/td>List of panel logs.<\/td>https:\/\/api.esv2.com\/v2\/Api\/PanelLogs<\/td>Get panel logs<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
UsersLogins<\/td>Get user login details.<\/td>https:\/\/api.esv2.com\/v2\/Api\/UsersLogins<\/td>Get user logins details<\/a><\/td> <\/td> <\/td> <\/td><\/tr>
CheckMessageContent<\/td>Allows to check message content domain links on blacklist<\/td>https:\/\/api.esv2.com\/v2\/Api\/CheckMessageContent<\/td>Get message content check status<\/a><\/td>Create message content check task<\/a><\/td> <\/td> <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

* 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.<\/p>\n\n\n\n

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. <\/p>\n\n\n\n

If you integrate with the API for the first time, please DO NOT use deprecated methods.<\/p>\n","protected":false},"author":5,"featured_media":0,"parent":3551,"menu_order":238,"template":"","format":"standard","emp-category":[],"class_list":["post-3548","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3548","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/5"}],"version-history":[{"count":3,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3548\/revisions"}],"predecessor-version":[{"id":10459,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3548\/revisions\/10459"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3551"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3548"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3548"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}