You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
MailUp API - How to migrate from SOAP API to REST API
This document can be used as a reference for those who are in the process of migrating their application from MailUp SOAP API to MailUp REST API.
If you need more details you can create an issue on this Github project.
As you probably know, MailUp SOAP API methods belong to one of these domains: WSMailUpImport, MailUpSend, MailUpReport and MailUpManage. The following paragraphs map the methods of each domain to the MailUp REST API methods with the corresponding behaviour. There are few cases in which there is not an exact 1:1 matching, a detailed page is available for those exceptions.
The REST API returns only the lists the logged in use has access. Start with GET /ConsoleService.svc/Console/List, then optionally iterate over the returned lists to get groups: GET /ConsoleService.svc/Console/List/{ID_LIST}/Groupsdetails
NewImportProcess, StartProcess and StartImportProcesses
Any combination of these SOAP calls is replaced by a single call like POST /ConsoleService.svc/Console/List/{id_List}/Recipients(plain import into a MailUp "list") or POST /ConsoleService.svc/Console/Group/{ID_GROUP}/Recipients (when you want to specify a "group" that belongs to a MailUp "list") details
GetProcessDetails
GET /ConsoleService.svc/Console/Import/{IMPORT_ID} (if you know the import ID) or GET /ConsoleService.svc/Console/Imports (to get all the import tasks) details
CreateGroup
POST ConsoleService.svc/Console/List/{ID_LIST}/Groupdetails
GetIdUser or GetIdWsUser
REST API can read only the ID of the user who made the request. Use GET /ConsoleService.svc/Console/Authentication/Info to retrieve the user ID details
POST /ConsoleService.svc/Console/Sms/List/{id_List}/Message/{id_Message}/Send (send to all list's recipients) or POST /ConsoleService.svc/Console/Sms/Group/{id_Group}/Message/{id_Message}/Send (send to a group) details
GetCredits or GetCreditsLists
POST /ConsoleService.svc/Console/Authentication/Detailsdetails
GetSMS
POST /ConsoleService.svc/Console/Sms/List/{id_List}/Messagesdetails
GetSMSDeliveryStatus
POST /ConsoleService.svc/Console/Sms/Sendings/Immediatedetails
POST /ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Send
SendNewsletterFast
Newsletters & DEM: first create the email message using POST /ConsoleService.svc/Console/List/{id_List}/Email then send it out with POST /ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Send. Transactional (one-to-one) emails: Use Transactional Email API or SMTP+
GetNewsletterDeliveryStatus
GET /ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/SendHistory (past sendouts) GET /ConsoleService.svc/Console/Email/Sendings/Immediate (in progress) GET /ConsoleService.svc/Console/Email/Sendings/Deferred (still planned)
GetNewsletterQueues
GET /ConsoleService.svc/Console/Email/Sendings/Immediate (ongoing) GET /ConsoleService.svc/Console/Email/Sendings/Deferred (planned) GET /ConsoleService.svc/Console/Email/Sendings/Undefined (unplanned)
StartDelivery
POST /ConsoleService.svc/Console/Email/Sendings/{id_Sending}/Immediate (schedule an immediate dispatch) POST /ConsoleService.svc/Console/Email/Sendings/{id_Sending}/Deferred (schedule a deferred dispatch)
RemoveNewsletterQueue
DELETE /ConsoleService.svc/Console/Email/Sendings/{id_Sending} Note: in case of ongoing sending you must must stop it first using POST /ConsoleService.svc/Console/Email/Sendings/{id_Sending}/Stop
Use GET /MailStatisticsService.svc/Message/{ID_MESSAGE}/List/Recipients (delivered) GET /MailStatisticsService.svc/Message/{ID_MESSAGE}/List/Views (opens) GET /MailStatisticsService.svc/Message/{ID_MESSAGE}/List/Clicks (clicks) details